AWS.Tools.GameLiftStreams.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.GameLiftStreams</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSResourceTagCmdlet"> <summary> Assigns one or more tags to a Amazon GameLift Streams resource. Use tags to organize Amazon Web Services resources for a range of purposes. You can assign tags to the following Amazon GameLift Streams resource types: <ul><li><para> Application </para></li><li><para> StreamGroup </para></li></ul><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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to apply tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSResourceTagCmdlet.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.GameLiftStreams.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSResourceTagCmdlet.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.GMLS.AddGMLSStreamGroupLocationCmdlet"> <summary> Add locations that can host stream sessions. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality. <para> This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSStreamGroupLocationCmdlet.Identifier"> <summary> <para> <para> A stream group to add the specified locations to. </para><para>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSStreamGroupLocationCmdlet.LocationConfiguration"> <summary> <para> <para> A set of one or more locations and the streaming capacity for each location. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.AddGMLSStreamGroupLocationCmdlet.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.GameLiftStreams.Model.AddStreamGroupLocationsResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.AddStreamGroupLocationsResponse 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.GMLS.AddGMLSStreamGroupLocationCmdlet.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.GMLS.ConnectGMLSApplicationCmdlet"> <summary> When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in <c>ACTIVE</c> status. You can reverse this action by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html">DisassociateApplications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ConnectGMLSApplicationCmdlet.ApplicationIdentifier"> <summary> <para> <para>A set of applications to associate with the stream group.</para><para>This value is a set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARN)</a> or IDs that uniquely identify application resources. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ConnectGMLSApplicationCmdlet.Identifier"> <summary> <para> <para>A stream group to associate to the applications.</para><para>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ConnectGMLSApplicationCmdlet.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.GameLiftStreams.Model.AssociateApplicationsResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.AssociateApplicationsResponse 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.GMLS.ConnectGMLSApplicationCmdlet.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.GMLS.DisconnectGMLSApplicationCmdlet"> <summary> When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group. <para> You can only disassociate an application if it's not a default application of the stream group. Check <c>DefaultApplicationIdentifier</c> by calling <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.DisconnectGMLSApplicationCmdlet.ApplicationIdentifier"> <summary> <para> <para>A set of applications that you want to disassociate from the stream group.</para><para>This value is a set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARN)</a> or IDs that uniquely identify application resources. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.DisconnectGMLSApplicationCmdlet.Identifier"> <summary> <para> <para>A stream group to disassociate these applications from.</para><para>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.DisconnectGMLSApplicationCmdlet.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.GameLiftStreams.Model.DisassociateApplicationsResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.DisassociateApplicationsResponse 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.GMLS.DisconnectGMLSApplicationCmdlet.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.GMLS.ExportGMLSStreamSessionFileCmdlet"> <summary> Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output. <para> You can only call this action on a stream session that is in progress, specifically in one of the following statuses <c>ACTIVE</c>, <c>CONNECTED</c>, <c>PENDING_CLIENT_RECONNECTION</c>, and <c>RECONNECTING</c>. You must provide an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your security credentials to authenticate and authorize access to your Amazon S3 bucket. </para><para> Amazon GameLift Streams collects the following generated and modified files. Find them in the corresponding folders in the <c>.zip</c> archive. </para><ul><li><para><c>application/</c>: The folder where your application or game is stored. </para></li></ul><ul><li><para><c>profile/</c>: The user profile folder. </para></li><li><para><c>temp/</c>: The system temp folder. </para></li></ul><para> To verify the status of the exported files, use GetStreamSession. </para><para> To delete the files, delete the object in the S3 bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ExportGMLSStreamSessionFileCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ExportGMLSStreamSessionFileCmdlet.OutputUri"> <summary> <para> <para> The S3 bucket URI where Amazon GameLift Streams uploads the set of compressed exported files for this stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a <c>.zip</c> file extension.</para><para> Example 1: If you provide an S3 URI called <c>s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip</c>, then Amazon GameLift Streams will save the files at that location. </para><para> Example 2: If you provide an S3 URI called <c>s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/</c>, then Amazon GameLift Streams will save the files at <c>s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip</c> or another similar name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ExportGMLSStreamSessionFileCmdlet.StreamSessionIdentifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</c>. Example ID: <c>ABC123def4567</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ExportGMLSStreamSessionFileCmdlet.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.GameLiftStreams.Model.ExportStreamSessionFilesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.ExportGMLSStreamSessionFileCmdlet.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.GMLS.GetGMLSApplicationCmdlet"> <summary> Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSApplicationCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSApplicationCmdlet.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.GameLiftStreams.Model.GetApplicationResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.GetApplicationResponse 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.GMLS.GetGMLSApplicationListCmdlet"> <summary> Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.<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.GMLS.GetGMLSApplicationListCmdlet.MaxResult"> <summary> <para> <para>The number of results to return. Use this parameter with <c>NextToken</c> to return results in sequential pages. Default value is <c>25</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSApplicationListCmdlet.NextToken"> <summary> <para> <para>The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLiftStreams.Model.ListApplicationsResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.ListApplicationsResponse 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.GMLS.GetGMLSApplicationListCmdlet.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.GMLS.GetGMLSResourceTagCmdlet"> <summary> Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource. <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that you want to retrieve tags for. To get an Amazon GameLift Streams resource ARN, call a List or Get operation for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSResourceTagCmdlet.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.GameLiftStreams.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.GameLiftStreams.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="T:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamGroupCmdlet"> <summary> Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamGroupCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamGroupCmdlet.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.GameLiftStreams.Model.GetStreamGroupResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.GetStreamGroupResponse 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.GMLS.GetGMLSStreamGroupListCmdlet"> <summary> Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.<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.GMLS.GetGMLSStreamGroupListCmdlet.MaxResult"> <summary> <para> <para>The number of results to return. Use this parameter with <c>NextToken</c> to return results in sequential pages. Default value is <c>25</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamGroupListCmdlet.NextToken"> <summary> <para> <para>A token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLiftStreams.Model.ListStreamGroupsResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.ListStreamGroupsResponse 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.GMLS.GetGMLSStreamGroupListCmdlet.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.GMLS.GetGMLSStreamSessionCmdlet"> <summary> Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionCmdlet.Identifier"> <summary> <para> <para>The stream group that runs this stream session.</para><para>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionCmdlet.StreamSessionIdentifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</c>. Example ID: <c>ABC123def4567</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionCmdlet.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.GameLiftStreams.Model.GetStreamSessionResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.GetStreamSessionResponse 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.GMLS.GetGMLSStreamSessionListCmdlet"> <summary> Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting. <para> To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed. </para><para> This operation returns the requested stream sessions in no particular order. </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.GMLS.GetGMLSStreamSessionListCmdlet.ExportFilesStatus"> <summary> <para> <para>Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.</para><para> Exported files can be in one of the following states: </para><ul><li><para><b>SUCCEEDED</b>: The exported files are successfully stored in S3 bucket. </para></li><li><para><b>FAILED</b>: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3. </para></li><li><para><b>PENDING</b>: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListCmdlet.Identifier"> <summary> <para> <para>The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListCmdlet.Status"> <summary> <para> <para>Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListCmdlet.MaxResult"> <summary> <para> <para>The number of results to return. Use this parameter with <c>NextToken</c> to return results in sequential pages. Default value is <c>25</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListCmdlet.NextToken"> <summary> <para> <para>The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLiftStreams.Model.ListStreamSessionsResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.ListStreamSessionsResponse 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.GMLS.GetGMLSStreamSessionListCmdlet.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.GMLS.GetGMLSStreamSessionListByAccountCmdlet"> <summary> Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to. <para> In the returned list of stream sessions, the <c>ExportFilesMetadata</c> property only shows the <c>Status</c> value. To get the <c>OutpurUri</c> and <c>StatusReason</c> values, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>. </para><para> We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</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.GMLS.GetGMLSStreamSessionListByAccountCmdlet.ExportFilesStatus"> <summary> <para> <para>Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListByAccountCmdlet.Status"> <summary> <para> <para>Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListByAccountCmdlet.MaxResult"> <summary> <para> <para>The number of results to return. Use this parameter with <c>NextToken</c> to return results in sequential pages. Default value is <c>25</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListByAccountCmdlet.NextToken"> <summary> <para> <para>The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.GetGMLSStreamSessionListByAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLiftStreams.Model.ListStreamSessionsByAccountResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.ListStreamSessionsByAccountResponse 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.GMLS.GetGMLSStreamSessionListByAccountCmdlet.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.GMLS.NewGMLSApplicationCmdlet"> <summary> Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it. <para> Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <b>Getting Started</b> in the Amazon GameLift Streams Developer Guide. </para><important><para> Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application. </para></important><para> If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to <c>INITIALIZED</c>. When an application reaches <c>READY</c> status, you can use the application to set up stream groups and start streams. To track application status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetApplication.html">GetApplication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.ApplicationLogOutputUri"> <summary> <para> <para>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <c>ApplicationLogPaths</c>.</para><note><para>The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template">Application log bucket permission policy</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.ApplicationLogPath"> <summary> <para> <para>Locations of log files that your content generates during a stream session. Enter path values that are relative to the <c>ApplicationSourceUri</c> location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in <c>ApplicationLogOutputUri</c> at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> and get the <c>LogFileLocationUri</c>.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.ApplicationSourceUri"> <summary> <para> <para>The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location.</para><para>This value is immutable. To designate a different content location, create a new application.</para><note><para>The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.Description"> <summary> <para> <para>A human-readable label for the application. You can update this value later.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.ExecutablePath"> <summary> <para> <para>The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in <c>ApplicationSourceUri</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. 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>. You can use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TagResource.html">TagResource</a> to add tags, <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html">UntagResource</a> to remove tags, and <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to view tags on existing resources.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.RuntimeEnvironment_Type"> <summary> <para> <para>The operating system and other drivers. For Proton, this also includes the Proton compatibility layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.RuntimeEnvironment_Version"> <summary> <para> <para>Versioned container environment for the application operating system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.ClientToken"> <summary> <para> <para> A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSApplicationCmdlet.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.GameLiftStreams.Model.CreateApplicationResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.CreateApplicationResponse 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.GMLS.NewGMLSApplicationCmdlet.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.GMLS.NewGMLSStreamGroupCmdlet"> <summary> Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations. <para> Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand: </para><ul><li><para><b>Always-on</b>: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. </para></li><li><para><b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). </para></li></ul><para> To adjust the capacity of any <c>ACTIVE</c> stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a>. </para><para> If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to <c>ACTIVATING</c>. When the stream group reaches <c>ACTIVE</c> status, you can start stream sessions by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html">StartStreamSession</a>. To check the stream group's status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.DefaultApplicationIdentifier"> <summary> <para> <para>The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in <c>READY</c> status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming.</para><para>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.Description"> <summary> <para> <para>A descriptive label for the stream group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.LocationConfiguration"> <summary> <para> <para> A set of one or more locations and the streaming capacity for each location. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.StreamClass"> <summary> <para> <para>The target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of content that you're streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The following options are available: </para><para>A stream class can be one of the following:</para><ul><li><para><b><c>gen5n_win2022</c> (NVIDIA, ultra)</b> Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.</para><ul><li><para>Reference resolution: 1080p</para></li><li><para>Reference frame rate: 60 fps</para></li><li><para>Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM</para></li><li><para>Tenancy: Supports 1 concurrent stream session</para></li></ul></li><li><para><b><c>gen5n_high</c> (NVIDIA, high)</b> Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.</para><ul><li><para>Reference resolution: 1080p</para></li><li><para>Reference frame rate: 60 fps</para></li><li><para>Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM</para></li><li><para>Tenancy: Supports up to 2 concurrent stream sessions</para></li></ul></li><li><para><b><c>gen5n_ultra</c> (NVIDIA, ultra)</b> Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.</para><ul><li><para>Reference resolution: 1080p</para></li><li><para>Reference frame rate: 60 fps</para></li><li><para>Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM</para></li><li><para>Tenancy: Supports 1 concurrent stream session</para></li></ul></li><li><para><b><c>gen4n_win2022</c> (NVIDIA, ultra)</b> Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.</para><ul><li><para>Reference resolution: 1080p</para></li><li><para>Reference frame rate: 60 fps</para></li><li><para>Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM</para></li><li><para>Tenancy: Supports 1 concurrent stream session</para></li></ul></li><li><para><b><c>gen4n_high</c> (NVIDIA, high)</b> Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.</para><ul><li><para>Reference resolution: 1080p</para></li><li><para>Reference frame rate: 60 fps</para></li><li><para>Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM</para></li><li><para>Tenancy: Supports up to 2 concurrent stream sessions</para></li></ul></li><li><para><b><c>gen4n_ultra</c> (NVIDIA, ultra)</b> Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.</para><ul><li><para>Reference resolution: 1080p</para></li><li><para>Reference frame rate: 60 fps</para></li><li><para>Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM</para></li><li><para>Tenancy: Supports 1 concurrent stream session</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. 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>. You can use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TagResource.html">TagResource</a> to add tags, <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html">UntagResource</a> to remove tags, and <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to view tags on existing resources.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.ClientToken"> <summary> <para> <para> A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamGroupCmdlet.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.GameLiftStreams.Model.CreateStreamGroupResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.CreateStreamGroupResponse 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.GMLS.NewGMLSStreamGroupCmdlet.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.GMLS.NewGMLSStreamSessionConnectionCmdlet"> <summary> Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session. <para> A client can reconnect to a stream session that's in <c>PENDING_CLIENT_RECONNECTION</c> or <c>ACTIVE</c> status. In the stream session life cycle, when the client disconnects from the stream session, the stream session transitions from <c>CONNECTED</c> to <c>PENDING_CLIENT_RECONNECTION</c> status. When a client requests to reconnect by calling <c>CreateStreamSessionConnection</c>, the stream session transitions to <c>RECONNECTING</c> status. When the reconnection is successful, the stream session transitions to <c>ACTIVE</c> status. After a stream session is disconnected for longer than <c>ConnectionTimeoutSeconds</c>, the stream session transitions to the <c>TERMINATED</c> status. </para><para> To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream. </para><para><c>ConnectionTimeoutSeconds</c> defines the amount of time after the stream session disconnects that a reconnection is allowed. If a client is disconnected from the stream for longer than <c>ConnectionTimeoutSeconds</c>, the stream session ends. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamSessionConnectionCmdlet.Identifier"> <summary> <para> <para><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para><para> The stream group that you want to run this stream session with. The stream group must be in <c>ACTIVE</c> status and have idle stream capacity. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamSessionConnectionCmdlet.SignalRequest"> <summary> <para> <para>A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to <c>StartStreamSession</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamSessionConnectionCmdlet.StreamSessionIdentifier"> <summary> <para> <para><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</c>. Example ID: <c>ABC123def4567</c>. </para><para> The stream session must be in <c>PENDING_CLIENT_RECONNECTION</c> or <c>ACTIVE</c> status. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamSessionConnectionCmdlet.ClientToken"> <summary> <para> <para> A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.NewGMLSStreamSessionConnectionCmdlet.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.GameLiftStreams.Model.CreateStreamSessionConnectionResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.CreateStreamSessionConnectionResponse 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.GMLS.NewGMLSStreamSessionConnectionCmdlet.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.GMLS.RemoveGMLSApplicationCmdlet"> <summary> Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket. <para> You can only delete an application that meets the following conditions: </para><ul><li><para> The application is in <c>READY</c> or <c>ERROR</c> status. You cannot delete an application that's in <c>PROCESSING</c> or <c>INITIALIZED</c> status. </para></li><li><para> The application is not the default application of any stream groups. You must first delete the stream group by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DeleteStreamGroup.html">DeleteStreamGroup</a>. </para></li><li><para> The application is not linked to any stream groups. You must first unlink the stream group by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html">DisassociateApplications</a>. </para></li><li><para> An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TerminateStreamSession.html">TerminateStreamSession</a> to end the stream. </para></li></ul><para> If any active stream groups exist for this application, this request returns a <c>ValidationException</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSApplicationCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSApplicationCmdlet.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.GameLiftStreams.Model.DeleteApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSApplicationCmdlet.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.GMLS.RemoveGMLSResourceTagCmdlet"> <summary> Removes one or more tags from a Amazon GameLift Streams resource. To remove tags, specify the Amazon GameLift Streams resource and a list of one or more tags to remove. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from the specified Amazon GameLift Streams resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSResourceTagCmdlet.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.GameLiftStreams.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSResourceTagCmdlet.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.GMLS.RemoveGMLSStreamGroupCmdlet"> <summary> Permanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream group identifier. During the deletion process, the stream group's status is <c>DELETING</c>. This operation stops streams in progress and prevents new streams from starting. As a best practice, before deleting the stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListStreamSessions.html">ListStreamSessions</a> to check for streams in progress and take action to stop them. When you delete a stream group, any application associations referring to that stream group are automatically removed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupCmdlet.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.GameLiftStreams.Model.DeleteStreamGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupCmdlet.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.GMLS.RemoveGMLSStreamGroupLocationCmdlet"> <summary> Removes a set of remote locations from this stream group. Amazon GameLift Streams works to release allocated compute resources in these location. Thus, stream sessions can no longer start from these locations by using this stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal S3 bucket at this location. <para> You cannot remove the region where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupLocationCmdlet.Identifier"> <summary> <para> <para> A stream group to remove the specified locations from. </para><para> This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupLocationCmdlet.Location"> <summary> <para> <para> A set of locations to remove this stream group. </para><para> A set of location names. For example, <c>us-east-1</c>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupLocationCmdlet.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.GameLiftStreams.Model.RemoveStreamGroupLocationsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.RemoveGMLSStreamGroupLocationCmdlet.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.GMLS.StartGMLSStreamSessionCmdlet"> <summary> This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. <para> To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html">AssociateApplications</a>. </para><para> For stream groups that have multiple locations, provide a set of locations ordered by priority using a <c>Locations</c> parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating in a remote location before the remote location can host a stream. </para><para> If the request is successful, Amazon GameLift Streams begins to prepare the stream. Amazon GameLift Streams assigns an Amazon Resource Name (ARN) value to the stream session resource and sets the status to <c>ACTIVATING</c>. During the stream preparation process, Amazon GameLift Streams queues the request and searches for available stream capacity to run the stream. This results in one of the following: </para><ul><li><para> Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to <c>ACTIVE</c> and includes stream connection information. Provide the connection information to the requesting client to join the stream session. </para></li><li><para> Amazon GameLift Streams doesn't identify an available resource within a certain time, set by <c>ClientToken</c>. In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes to <c>ERROR</c> with status reason <c>placementTimeout</c>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.AdditionalEnvironmentVariable"> <summary> <para> <para>A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.</para><note><para>If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.</para></note><para><c>AdditionalEnvironmentVariables</c> and <c>AdditionalLaunchArgs</c> have similar purposes. <c>AdditionalEnvironmentVariables</c> passes data using environment variables; while <c>AdditionalLaunchArgs</c> passes data using command-line arguments.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.AdditionalLaunchArg"> <summary> <para> <para>A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.</para><para><c>AdditionalEnvironmentVariables</c> and <c>AdditionalLaunchArgs</c> have similar purposes. <c>AdditionalEnvironmentVariables</c> passes data using environment variables; while <c>AdditionalLaunchArgs</c> passes data using command-line arguments.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.ApplicationIdentifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.ConnectionTimeoutSecond"> <summary> <para> <para>Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the stream session. This time span starts when the stream session reaches <c>ACTIVE</c> status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of <c>TERMINATED</c>. Default value is 120.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.Description"> <summary> <para> <para>A human-readable label for the stream session. You can update this value later.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.Identifier"> <summary> <para> <para>The stream group to run this stream session with.</para><para>This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.Location"> <summary> <para> <para> A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location. </para><para> This value is A set of location names. For example, <c>us-east-1</c>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.Protocol"> <summary> <para> <para>The data transport protocol to use for the stream session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.SessionLengthSecond"> <summary> <para> <para>The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. Default value is 43200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.SignalRequest"> <summary> <para> <para>A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes.</para><para>Amazon GameLift Streams also supports setting the field to "NO_CLIENT_CONNECTION". This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html">CreateStreamSessionConnection</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.UserId"> <summary> <para> <para> An opaque, unique identifier for an end-user, defined by the developer. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.ClientToken"> <summary> <para> <para> A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StartGMLSStreamSessionCmdlet.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.GameLiftStreams.Model.StartStreamSessionResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.StartStreamSessionResponse 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.GMLS.StartGMLSStreamSessionCmdlet.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.GMLS.StopGMLSStreamSessionCmdlet"> <summary> Permanently terminates an active stream session. When called, the stream session status changes to <c>TERMINATING</c>. You can terminate a stream session in any status except <c>ACTIVATING</c>. If the stream session is in <c>ACTIVATING</c> status, an exception is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StopGMLSStreamSessionCmdlet.Identifier"> <summary> <para> <para><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para><para>The stream group that runs this stream session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StopGMLSStreamSessionCmdlet.StreamSessionIdentifier"> <summary> <para> <para><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</c>. Example ID: <c>ABC123def4567</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StopGMLSStreamSessionCmdlet.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.GameLiftStreams.Model.TerminateStreamSessionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.StopGMLSStreamSessionCmdlet.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.GMLS.UpdateGMLSApplicationCmdlet"> <summary> Updates the mutable configuration settings for a Amazon GameLift Streams application resource. You can change the <c>Description</c>, <c>ApplicationLogOutputUri</c>, and <c>ApplicationLogPaths</c>. <para> To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSApplicationCmdlet.ApplicationLogOutputUri"> <summary> <para> <para>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <c>ApplicationLogPaths</c>.</para><note><para>The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template">Application log bucket permission policy</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSApplicationCmdlet.ApplicationLogPath"> <summary> <para> <para>Locations of log files that your content generates during a stream session. Enter path values that are relative to the <c>ApplicationSourceUri</c> location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in <c>ApplicationLogOutputUri</c> at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> and get the <c>LogFileLocationUri</c>.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSApplicationCmdlet.Description"> <summary> <para> <para>A human-readable label for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSApplicationCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>. Example ID: <c>a-9ZY8X7Wv6</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSApplicationCmdlet.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.GameLiftStreams.Model.UpdateApplicationResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.UpdateApplicationResponse 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.GMLS.UpdateGMLSApplicationCmdlet.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.GMLS.UpdateGMLSStreamGroupCmdlet"> <summary> Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group. <para> Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand: </para><ul><li><para><b>Always-on</b>: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. </para></li><li><para><b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). </para></li></ul><para> To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSStreamGroupCmdlet.Description"> <summary> <para> <para>A descriptive label for the stream group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSStreamGroupCmdlet.Identifier"> <summary> <para> <para>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>. Example ID: <c>sg-1AB2C3De4</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSStreamGroupCmdlet.LocationConfiguration"> <summary> <para> <para> A set of one or more locations and the streaming capacity for each location. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GMLS.UpdateGMLSStreamGroupCmdlet.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.GameLiftStreams.Model.UpdateStreamGroupResponse). Specifying the name of a property of type Amazon.GameLiftStreams.Model.UpdateStreamGroupResponse 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.GMLS.UpdateGMLSStreamGroupCmdlet.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> |