AWS.Tools.AppStream.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AppStream</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.APS.AddAPSResourceTagCmdlet"> <summary> Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. <para> Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. </para><para> To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>. </para><para> For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.AddAPSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.AddAPSResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </para><para>If you do not specify a value, the value is set to an empty string.</para><para>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </para><para>_ . : / = + \ - @</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.AddAPSResourceTagCmdlet.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.AppStream.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.AddAPSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Tag parameter. The -PassThru parameter is deprecated, use -Select '^Tag' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.AddAPSResourceTagCmdlet.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.APS.CopyAPSImageCmdlet"> <summary> Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.CopyAPSImageCmdlet.DestinationImageDescription"> <summary> <para> <para>The description that the image will have when it is copied to the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.CopyAPSImageCmdlet.DestinationImageName"> <summary> <para> <para>The name that the image will have when it is copied to the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.CopyAPSImageCmdlet.DestinationRegion"> <summary> <para> <para>The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.CopyAPSImageCmdlet.SourceImageName"> <summary> <para> <para>The name of the image to copy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.CopyAPSImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DestinationImageName'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.CopyImageResponse). Specifying the name of a property of type Amazon.AppStream.Model.CopyImageResponse 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.APS.CopyAPSImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceImageName parameter. The -PassThru parameter is deprecated, use -Select '^SourceImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.CopyAPSImageCmdlet.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.APS.DisableAPSUserCmdlet"> <summary> Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.DisableAPSUserCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type for the user. You must specify USERPOOL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.DisableAPSUserCmdlet.UserName"> <summary> <para> <para>The email address of the user.</para><note><para>Users' email addresses are case-sensitive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.DisableAPSUserCmdlet.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.AppStream.Model.DisableUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.DisableAPSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.DisableAPSUserCmdlet.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.APS.EnableAPSUserCmdlet"> <summary> Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.EnableAPSUserCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type for the user. You must specify USERPOOL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.EnableAPSUserCmdlet.UserName"> <summary> <para> <para>The email address of the user.</para><note><para>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.EnableAPSUserCmdlet.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.AppStream.Model.EnableUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.EnableAPSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.EnableAPSUserCmdlet.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.APS.GetAPSAssociatedFleetListCmdlet"> <summary> Retrieves the name of the fleet that is associated with the specified stack.<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.APS.GetAPSAssociatedFleetListCmdlet.StackName"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSAssociatedFleetListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSAssociatedFleetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Names'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.ListAssociatedFleetsResponse). Specifying the name of a property of type Amazon.AppStream.Model.ListAssociatedFleetsResponse 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.APS.GetAPSAssociatedFleetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StackName parameter. The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSAssociatedFleetListCmdlet.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.APS.GetAPSAssociatedStackListCmdlet"> <summary> Retrieves the name of the stack with which the specified fleet is associated.<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.APS.GetAPSAssociatedStackListCmdlet.FleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSAssociatedStackListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSAssociatedStackListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Names'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.ListAssociatedStacksResponse). Specifying the name of a property of type Amazon.AppStream.Model.ListAssociatedStacksResponse 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.APS.GetAPSAssociatedStackListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FleetName parameter. The -PassThru parameter is deprecated, use -Select '^FleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSAssociatedStackListCmdlet.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.APS.GetAPSDirectoryConfigListCmdlet"> <summary> Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. <para> Although the response syntax in this topic includes the account password, this password is not returned in the actual response. </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.APS.GetAPSDirectoryConfigListCmdlet.DirectoryName"> <summary> <para> <para>The directory names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSDirectoryConfigListCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of 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.APS.GetAPSDirectoryConfigListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSDirectoryConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DirectoryConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeDirectoryConfigsResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeDirectoryConfigsResponse 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.APS.GetAPSDirectoryConfigListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryName parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSDirectoryConfigListCmdlet.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.APS.GetAPSFleetListCmdlet"> <summary> Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.<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.APS.GetAPSFleetListCmdlet.Name"> <summary> <para> <para>The names of the fleets to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSFleetListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSFleetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Fleets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeFleetsResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeFleetsResponse 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.APS.GetAPSFleetListCmdlet.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.APS.GetAPSFleetListCmdlet.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.APS.GetAPSImageBuilderListCmdlet"> <summary> Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.<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.APS.GetAPSImageBuilderListCmdlet.Name"> <summary> <para> <para>The names of the image builders to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImageBuilderListCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImageBuilderListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSImageBuilderListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuilders'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeImageBuildersResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeImageBuildersResponse 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.APS.GetAPSImageBuilderListCmdlet.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.APS.GetAPSImageListCmdlet"> <summary> Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.<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.APS.GetAPSImageListCmdlet.Arn"> <summary> <para> <para>The ARNs of the public, private, and shared images to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImageListCmdlet.Name"> <summary> <para> <para>The names of the public or private images to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImageListCmdlet.Type"> <summary> <para> <para>The type of image (public, private, or shared) to describe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImageListCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImageListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSImageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Images'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeImagesResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeImagesResponse 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.APS.GetAPSImageListCmdlet.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.APS.GetAPSImageListCmdlet.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.APS.GetAPSImagePermissionCmdlet"> <summary> Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.<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.APS.GetAPSImagePermissionCmdlet.Name"> <summary> <para> <para>The name of the private image for which to describe permissions. The image must be one that you own. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImagePermissionCmdlet.SharedAwsAccountId"> <summary> <para> <para>The 12-digit identifier of one or more AWS accounts with which the image is shared.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSImagePermissionCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of 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.APS.GetAPSImagePermissionCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSImagePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SharedImagePermissionsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeImagePermissionsResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeImagePermissionsResponse 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.APS.GetAPSImagePermissionCmdlet.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.APS.GetAPSImagePermissionCmdlet.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.APS.GetAPSSessionListCmdlet"> <summary> Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.<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.APS.GetAPSSessionListCmdlet.AuthenticationType"> <summary> <para> <para>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSSessionListCmdlet.FleetName"> <summary> <para> <para>The name of the fleet. This value is case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSSessionListCmdlet.StackName"> <summary> <para> <para>The name of the stack. This value is case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSSessionListCmdlet.UserId"> <summary> <para> <para>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSSessionListCmdlet.Limit"> <summary> <para> <para>The size of each page of results. The default value is 20 and the maximum value is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSSessionListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSSessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Sessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeSessionsResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeSessionsResponse 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.APS.GetAPSSessionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StackName parameter. The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSSessionListCmdlet.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.APS.GetAPSStackListCmdlet"> <summary> Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.<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.APS.GetAPSStackListCmdlet.Name"> <summary> <para> <para>The names of the stacks to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSStackListCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSStackListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stacks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeStacksResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeStacksResponse 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.APS.GetAPSStackListCmdlet.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.APS.GetAPSStackListCmdlet.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.APS.GetAPSTagsForResourceListCmdlet"> <summary> Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. <para> For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSTagsForResourceListCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSTagsForResourceListCmdlet.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.AppStream.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.AppStream.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.APS.GetAPSTagsForResourceListCmdlet.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.APS.GetAPSUsageReportSubscriptionCmdlet"> <summary> Retrieves a list that describes one or more usage report subscriptions.<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.APS.GetAPSUsageReportSubscriptionCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUsageReportSubscriptionCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSUsageReportSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UsageReportSubscriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeUsageReportSubscriptionsResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeUsageReportSubscriptionsResponse 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.APS.GetAPSUsageReportSubscriptionCmdlet.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.APS.GetAPSUserCmdlet"> <summary> Retrieves a list that describes one or more specified users in the user pool.<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.APS.GetAPSUserCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Users'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeUsersResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeUsersResponse 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.APS.GetAPSUserCmdlet.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.APS.GetAPSUserStackAssociationCmdlet"> <summary> Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: <ul><li><para> The stack name </para></li><li><para> The user name (email address of the user associated with the stack) and the authentication type for the user </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.APS.GetAPSUserStackAssociationCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type for the user who is associated with the stack. You must specify USERPOOL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserStackAssociationCmdlet.StackName"> <summary> <para> <para>The name of the stack that is associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserStackAssociationCmdlet.UserName"> <summary> <para> <para>The email address of the user who is associated with the stack.</para><note><para>Users' email addresses are case-sensitive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserStackAssociationCmdlet.MaxResult"> <summary> <para> <para>The maximum size of each page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserStackAssociationCmdlet.NextToken"> <summary> <para> <para>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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.APS.GetAPSUserStackAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserStackAssociations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DescribeUserStackAssociationsResponse). Specifying the name of a property of type Amazon.AppStream.Model.DescribeUserStackAssociationsResponse 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.APS.GetAPSUserStackAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StackName parameter. The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.GetAPSUserStackAssociationCmdlet.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.APS.NewAPSDirectoryConfigCmdlet"> <summary> Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSDirectoryConfigCmdlet.ServiceAccountCredentials_AccountName"> <summary> <para> <para>The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSDirectoryConfigCmdlet.ServiceAccountCredentials_AccountPassword"> <summary> <para> <para>The password for the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSDirectoryConfigCmdlet.DirectoryName"> <summary> <para> <para>The fully qualified name of the directory (for example, corp.example.com).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSDirectoryConfigCmdlet.OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished names of the organizational units for computer accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSDirectoryConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DirectoryConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.CreateDirectoryConfigResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateDirectoryConfigResponse 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.APS.NewAPSDirectoryConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryName parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSDirectoryConfigCmdlet.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.APS.NewAPSFleetCmdlet"> <summary> Creates a fleet. A fleet consists of streaming instances that run a specified image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.Description"> <summary> <para> <para>The description to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.ComputeCapacity_DesiredInstance"> <summary> <para> <para>The desired number of streaming instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.DomainJoinInfo_DirectoryName"> <summary> <para> <para>The fully qualified name of the directory (for example, corp.example.com).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.DisconnectTimeoutInSecond"> <summary> <para> <para>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </para><para>Specify a value between 60 and 360000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.DisplayName"> <summary> <para> <para>The fleet name to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.EnableDefaultInternetAccess"> <summary> <para> <para>Enables or disables default internet access for the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.FleetType"> <summary> <para> <para>The fleet type.</para><dl><dt>ALWAYS_ON</dt><dd><para>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</para></dd><dt>ON_DEMAND</dt><dd><para>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</para><para>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.IdleDisconnectTimeoutInSecond"> <summary> <para> <para>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</para><para>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</para><note><para>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.ImageArn"> <summary> <para> <para>The ARN of the public, private, or shared image to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.ImageName"> <summary> <para> <para>The name of the image used to create the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.InstanceType"> <summary> <para> <para>The instance type to use when launching fleet instances. The following instance types are available:</para><ul><li><para>stream.standard.medium</para></li><li><para>stream.standard.large</para></li><li><para>stream.compute.large</para></li><li><para>stream.compute.xlarge</para></li><li><para>stream.compute.2xlarge</para></li><li><para>stream.compute.4xlarge</para></li><li><para>stream.compute.8xlarge</para></li><li><para>stream.memory.large</para></li><li><para>stream.memory.xlarge</para></li><li><para>stream.memory.2xlarge</para></li><li><para>stream.memory.4xlarge</para></li><li><para>stream.memory.8xlarge</para></li><li><para>stream.memory.z1d.large</para></li><li><para>stream.memory.z1d.xlarge</para></li><li><para>stream.memory.z1d.2xlarge</para></li><li><para>stream.memory.z1d.3xlarge</para></li><li><para>stream.memory.z1d.6xlarge</para></li><li><para>stream.memory.z1d.12xlarge</para></li><li><para>stream.graphics-design.large</para></li><li><para>stream.graphics-design.xlarge</para></li><li><para>stream.graphics-design.2xlarge</para></li><li><para>stream.graphics-design.4xlarge</para></li><li><para>stream.graphics-desktop.2xlarge</para></li><li><para>stream.graphics.g4dn.xlarge</para></li><li><para>stream.graphics.g4dn.2xlarge</para></li><li><para>stream.graphics.g4dn.4xlarge</para></li><li><para>stream.graphics.g4dn.8xlarge</para></li><li><para>stream.graphics.g4dn.12xlarge</para></li><li><para>stream.graphics.g4dn.16xlarge</para></li><li><para>stream.graphics-pro.4xlarge</para></li><li><para>stream.graphics-pro.8xlarge</para></li><li><para>stream.graphics-pro.16xlarge</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.MaxUserDurationInSecond"> <summary> <para> <para>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</para><para>Specify a value between 600 and 360000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.Name"> <summary> <para> <para>A unique name for the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.DomainJoinInfo_OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished name of the organizational unit for computer accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The identifiers of the security groups for the fleet or image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.StreamView"> <summary> <para> <para>The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</para><para>The default value is <code>APP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.VpcConfig_SubnetId"> <summary> <para> <para>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.Tag"> <summary> <para> <para>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </para><para>If you do not specify a value, the value is set to an empty string.</para><para>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </para><para>_ . : / = + \ - @</para><para>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Fleet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.CreateFleetResponse). Specifying the name of a property of type Amazon.AppStream.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.APS.NewAPSFleetCmdlet.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.APS.NewAPSFleetCmdlet.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.APS.NewAPSImageBuilderCmdlet"> <summary> Creates an image builder. An image builder is a virtual machine that is used to create an image. <para> The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.AccessEndpoint"> <summary> <para> <para>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.AppstreamAgentVersion"> <summary> <para> <para>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.Description"> <summary> <para> <para>The description to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.DomainJoinInfo_DirectoryName"> <summary> <para> <para>The fully qualified name of the directory (for example, corp.example.com).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.DisplayName"> <summary> <para> <para>The image builder name to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.EnableDefaultInternetAccess"> <summary> <para> <para>Enables or disables default internet access for the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</para><para>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.ImageArn"> <summary> <para> <para>The ARN of the public, private, or shared image to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.ImageName"> <summary> <para> <para>The name of the image used to create the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.InstanceType"> <summary> <para> <para>The instance type to use when launching the image builder. The following instance types are available:</para><ul><li><para>stream.standard.medium</para></li><li><para>stream.standard.large</para></li><li><para>stream.compute.large</para></li><li><para>stream.compute.xlarge</para></li><li><para>stream.compute.2xlarge</para></li><li><para>stream.compute.4xlarge</para></li><li><para>stream.compute.8xlarge</para></li><li><para>stream.memory.large</para></li><li><para>stream.memory.xlarge</para></li><li><para>stream.memory.2xlarge</para></li><li><para>stream.memory.4xlarge</para></li><li><para>stream.memory.8xlarge</para></li><li><para>stream.memory.z1d.large</para></li><li><para>stream.memory.z1d.xlarge</para></li><li><para>stream.memory.z1d.2xlarge</para></li><li><para>stream.memory.z1d.3xlarge</para></li><li><para>stream.memory.z1d.6xlarge</para></li><li><para>stream.memory.z1d.12xlarge</para></li><li><para>stream.graphics-design.large</para></li><li><para>stream.graphics-design.xlarge</para></li><li><para>stream.graphics-design.2xlarge</para></li><li><para>stream.graphics-design.4xlarge</para></li><li><para>stream.graphics-desktop.2xlarge</para></li><li><para>stream.graphics.g4dn.xlarge</para></li><li><para>stream.graphics.g4dn.2xlarge</para></li><li><para>stream.graphics.g4dn.4xlarge</para></li><li><para>stream.graphics.g4dn.8xlarge</para></li><li><para>stream.graphics.g4dn.12xlarge</para></li><li><para>stream.graphics.g4dn.16xlarge</para></li><li><para>stream.graphics-pro.4xlarge</para></li><li><para>stream.graphics-pro.8xlarge</para></li><li><para>stream.graphics-pro.16xlarge</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.Name"> <summary> <para> <para>A unique name for the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.DomainJoinInfo_OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished name of the organizational unit for computer accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The identifiers of the security groups for the fleet or image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.VpcConfig_SubnetId"> <summary> <para> <para>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.Tag"> <summary> <para> <para>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </para><para>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </para><para>_ . : / = + \ - @</para><para>If you do not specify a value, the value is set to an empty string.</para><para>For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuilder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.CreateImageBuilderResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateImageBuilderResponse 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.APS.NewAPSImageBuilderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderCmdlet.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.APS.NewAPSImageBuilderStreamingURLCmdlet"> <summary> Creates a URL to start an image builder streaming session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderStreamingURLCmdlet.Name"> <summary> <para> <para>The name of the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderStreamingURLCmdlet.Validity"> <summary> <para> <para>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSImageBuilderStreamingURLCmdlet.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.AppStream.Model.CreateImageBuilderStreamingURLResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateImageBuilderStreamingURLResponse 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.APS.NewAPSImageBuilderStreamingURLCmdlet.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.APS.NewAPSImageBuilderStreamingURLCmdlet.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.APS.NewAPSStackCmdlet"> <summary> Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.AccessEndpoint"> <summary> <para> <para>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.Description"> <summary> <para> <para>The description to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.DisplayName"> <summary> <para> <para>The stack name to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.EmbedHostDomain"> <summary> <para> <para>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.ApplicationSettings_Enabled"> <summary> <para> <para>Enables or disables persistent application settings for users during their streaming sessions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.FeedbackURL"> <summary> <para> <para>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.Name"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.RedirectURL"> <summary> <para> <para>The URL that users are redirected to after their streaming session ends.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.ApplicationSettings_SettingsGroup"> <summary> <para> <para>The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.StorageConnector"> <summary> <para> <para>The storage connectors to enable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.Tag"> <summary> <para> <para>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </para><para>If you do not specify a value, the value is set to an empty string.</para><para>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </para><para>_ . : / = + \ - @</para><para>For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.UserSetting"> <summary> <para> <para>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStackCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stack'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.CreateStackResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateStackResponse 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.APS.NewAPSStackCmdlet.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.APS.NewAPSStackCmdlet.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.APS.NewAPSStreamingURLCmdlet"> <summary> Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.ApplicationId"> <summary> <para> <para>The name of the application to launch after the session starts. This is the name that you specified as <b>Name</b> in the Image Assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.FleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.SessionContext"> <summary> <para> <para>The session context. For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters">Session Context</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.StackName"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.UserId"> <summary> <para> <para>The identifier of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.Validity"> <summary> <para> <para>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.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.AppStream.Model.CreateStreamingURLResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateStreamingURLResponse 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.APS.NewAPSStreamingURLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StackName parameter. The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSStreamingURLCmdlet.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.APS.NewAPSUsageReportSubscriptionCmdlet"> <summary> Creates a usage report subscription. Usage reports are generated daily. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUsageReportSubscriptionCmdlet.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.AppStream.Model.CreateUsageReportSubscriptionResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateUsageReportSubscriptionResponse 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.APS.NewAPSUsageReportSubscriptionCmdlet.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.APS.NewAPSUserCmdlet"> <summary> Creates a new user in the user pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type for the user. You must specify USERPOOL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.FirstName"> <summary> <para> <para>The first name, or given name, of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.LastName"> <summary> <para> <para>The last name, or surname, of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.MessageAction"> <summary> <para> <para>The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. </para><note><para>The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.UserName"> <summary> <para> <para>The email address of the user.</para><note><para>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.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.AppStream.Model.CreateUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.NewAPSUserCmdlet.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.APS.RegisterAPSFleetCmdlet"> <summary> Associates the specified fleet with the specified stack. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSFleetCmdlet.FleetName"> <summary> <para> <para>The name of the fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSFleetCmdlet.StackName"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSFleetCmdlet.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.AppStream.Model.AssociateFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StackName parameter. The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSFleetCmdlet.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.APS.RegisterAPSUserStackBatchCmdlet"> <summary> Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSUserStackBatchCmdlet.UserStackAssociation"> <summary> <para> <para>The list of UserStackAssociation objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSUserStackBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.BatchAssociateUserStackResponse). Specifying the name of a property of type Amazon.AppStream.Model.BatchAssociateUserStackResponse 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.APS.RegisterAPSUserStackBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserStackAssociation parameter. The -PassThru parameter is deprecated, use -Select '^UserStackAssociation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RegisterAPSUserStackBatchCmdlet.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.APS.RemoveAPSDirectoryConfigCmdlet"> <summary> Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSDirectoryConfigCmdlet.DirectoryName"> <summary> <para> <para>The name of the directory configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSDirectoryConfigCmdlet.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.AppStream.Model.DeleteDirectoryConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSDirectoryConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryName parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSDirectoryConfigCmdlet.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.APS.RemoveAPSFleetCmdlet"> <summary> Deletes the specified fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSFleetCmdlet.Name"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSFleetCmdlet.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.AppStream.Model.DeleteFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSFleetCmdlet.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.APS.RemoveAPSFleetCmdlet.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.APS.RemoveAPSImageCmdlet"> <summary> Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImageCmdlet.Name"> <summary> <para> <para>The name of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Image'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DeleteImageResponse). Specifying the name of a property of type Amazon.AppStream.Model.DeleteImageResponse 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.APS.RemoveAPSImageCmdlet.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.APS.RemoveAPSImageCmdlet.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.APS.RemoveAPSImageBuilderCmdlet"> <summary> Deletes the specified image builder and releases the capacity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImageBuilderCmdlet.Name"> <summary> <para> <para>The name of the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImageBuilderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuilder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.DeleteImageBuilderResponse). Specifying the name of a property of type Amazon.AppStream.Model.DeleteImageBuilderResponse 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.APS.RemoveAPSImageBuilderCmdlet.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.APS.RemoveAPSImageBuilderCmdlet.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.APS.RemoveAPSImagePermissionCmdlet"> <summary> Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImagePermissionCmdlet.Name"> <summary> <para> <para>The name of the private image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImagePermissionCmdlet.SharedAccountId"> <summary> <para> <para>The 12-digit identifier of the AWS account for which to delete image permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImagePermissionCmdlet.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.AppStream.Model.DeleteImagePermissionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSImagePermissionCmdlet.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.APS.RemoveAPSImagePermissionCmdlet.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.APS.RemoveAPSResourceTagCmdlet"> <summary> Disassociates one or more specified tags from the specified AppStream 2.0 resource. <para> To list the current tags for your resources, use <a>ListTagsForResource</a>. </para><para> For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys for the tags to disassociate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSResourceTagCmdlet.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.AppStream.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSResourceTagCmdlet.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.APS.RemoveAPSStackCmdlet"> <summary> Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSStackCmdlet.Name"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSStackCmdlet.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.AppStream.Model.DeleteStackResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSStackCmdlet.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.APS.RemoveAPSStackCmdlet.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.APS.RemoveAPSUsageReportSubscriptionCmdlet"> <summary> Disables usage report generation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUsageReportSubscriptionCmdlet.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.AppStream.Model.DeleteUsageReportSubscriptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUsageReportSubscriptionCmdlet.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.APS.RemoveAPSUserCmdlet"> <summary> Deletes a user from the user pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUserCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type for the user. You must specify USERPOOL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUserCmdlet.UserName"> <summary> <para> <para>The email address of the user.</para><note><para>Users' email addresses are case-sensitive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUserCmdlet.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.AppStream.Model.DeleteUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RemoveAPSUserCmdlet.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.APS.RevokeAPSSessionCmdlet"> <summary> Immediately stops the specified streaming session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RevokeAPSSessionCmdlet.SessionId"> <summary> <para> <para>The identifier of the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RevokeAPSSessionCmdlet.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.AppStream.Model.ExpireSessionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RevokeAPSSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.RevokeAPSSessionCmdlet.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.APS.StartAPSFleetCmdlet"> <summary> Starts the specified fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StartAPSFleetCmdlet.Name"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StartAPSFleetCmdlet.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.AppStream.Model.StartFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StartAPSFleetCmdlet.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.APS.StartAPSFleetCmdlet.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.APS.StartAPSImageBuilderCmdlet"> <summary> Starts the specified image builder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StartAPSImageBuilderCmdlet.AppstreamAgentVersion"> <summary> <para> <para>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StartAPSImageBuilderCmdlet.Name"> <summary> <para> <para>The name of the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StartAPSImageBuilderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuilder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.StartImageBuilderResponse). Specifying the name of a property of type Amazon.AppStream.Model.StartImageBuilderResponse 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.APS.StartAPSImageBuilderCmdlet.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.APS.StartAPSImageBuilderCmdlet.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.APS.StopAPSFleetCmdlet"> <summary> Stops the specified fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StopAPSFleetCmdlet.Name"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StopAPSFleetCmdlet.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.AppStream.Model.StopFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StopAPSFleetCmdlet.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.APS.StopAPSFleetCmdlet.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.APS.StopAPSImageBuilderCmdlet"> <summary> Stops the specified image builder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StopAPSImageBuilderCmdlet.Name"> <summary> <para> <para>The name of the image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.StopAPSImageBuilderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuilder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.StopImageBuilderResponse). Specifying the name of a property of type Amazon.AppStream.Model.StopImageBuilderResponse 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.APS.StopAPSImageBuilderCmdlet.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.APS.StopAPSImageBuilderCmdlet.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.APS.UnregisterAPSFleetCmdlet"> <summary> Disassociates the specified fleet from the specified stack. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSFleetCmdlet.FleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSFleetCmdlet.StackName"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSFleetCmdlet.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.AppStream.Model.DisassociateFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StackName parameter. The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSFleetCmdlet.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.APS.UnregisterAPSUserStackBatchCmdlet"> <summary> Disassociates the specified users from the specified stacks. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSUserStackBatchCmdlet.UserStackAssociation"> <summary> <para> <para>The list of UserStackAssociation objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSUserStackBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.BatchDisassociateUserStackResponse). Specifying the name of a property of type Amazon.AppStream.Model.BatchDisassociateUserStackResponse 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.APS.UnregisterAPSUserStackBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserStackAssociation parameter. The -PassThru parameter is deprecated, use -Select '^UserStackAssociation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UnregisterAPSUserStackBatchCmdlet.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.APS.UpdateAPSDirectoryConfigCmdlet"> <summary> Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSDirectoryConfigCmdlet.ServiceAccountCredentials_AccountName"> <summary> <para> <para>The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSDirectoryConfigCmdlet.ServiceAccountCredentials_AccountPassword"> <summary> <para> <para>The password for the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSDirectoryConfigCmdlet.DirectoryName"> <summary> <para> <para>The name of the Directory Config object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSDirectoryConfigCmdlet.OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished names of the organizational units for computer accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSDirectoryConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DirectoryConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.UpdateDirectoryConfigResponse). Specifying the name of a property of type Amazon.AppStream.Model.UpdateDirectoryConfigResponse 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.APS.UpdateAPSDirectoryConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryName parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSDirectoryConfigCmdlet.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.APS.UpdateAPSFleetCmdlet"> <summary> Updates the specified fleet. <para> If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code>, <code>ComputeCapacity</code>, <code>ImageARN</code>, <code>ImageName</code>, <code>IdleDisconnectTimeoutInSeconds</code>, and <code>DisconnectTimeoutInSeconds</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.AttributesToDelete"> <summary> <para> <para>The fleet attributes to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.Description"> <summary> <para> <para>The description to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.ComputeCapacity_DesiredInstance"> <summary> <para> <para>The desired number of streaming instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.DomainJoinInfo_DirectoryName"> <summary> <para> <para>The fully qualified name of the directory (for example, corp.example.com).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.DisconnectTimeoutInSecond"> <summary> <para> <para>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </para><para>Specify a value between 60 and 360000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.DisplayName"> <summary> <para> <para>The fleet name to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.EnableDefaultInternetAccess"> <summary> <para> <para>Enables or disables default internet access for the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</para><para>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.IdleDisconnectTimeoutInSecond"> <summary> <para> <para>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected. </para><para>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</para><note><para>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.ImageArn"> <summary> <para> <para>The ARN of the public, private, or shared image to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.ImageName"> <summary> <para> <para>The name of the image used to create the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.InstanceType"> <summary> <para> <para>The instance type to use when launching fleet instances. The following instance types are available:</para><ul><li><para>stream.standard.medium</para></li><li><para>stream.standard.large</para></li><li><para>stream.compute.large</para></li><li><para>stream.compute.xlarge</para></li><li><para>stream.compute.2xlarge</para></li><li><para>stream.compute.4xlarge</para></li><li><para>stream.compute.8xlarge</para></li><li><para>stream.memory.large</para></li><li><para>stream.memory.xlarge</para></li><li><para>stream.memory.2xlarge</para></li><li><para>stream.memory.4xlarge</para></li><li><para>stream.memory.8xlarge</para></li><li><para>stream.memory.z1d.large</para></li><li><para>stream.memory.z1d.xlarge</para></li><li><para>stream.memory.z1d.2xlarge</para></li><li><para>stream.memory.z1d.3xlarge</para></li><li><para>stream.memory.z1d.6xlarge</para></li><li><para>stream.memory.z1d.12xlarge</para></li><li><para>stream.graphics-design.large</para></li><li><para>stream.graphics-design.xlarge</para></li><li><para>stream.graphics-design.2xlarge</para></li><li><para>stream.graphics-design.4xlarge</para></li><li><para>stream.graphics-desktop.2xlarge</para></li><li><para>stream.graphics.g4dn.xlarge</para></li><li><para>stream.graphics.g4dn.2xlarge</para></li><li><para>stream.graphics.g4dn.4xlarge</para></li><li><para>stream.graphics.g4dn.8xlarge</para></li><li><para>stream.graphics.g4dn.12xlarge</para></li><li><para>stream.graphics.g4dn.16xlarge</para></li><li><para>stream.graphics-pro.4xlarge</para></li><li><para>stream.graphics-pro.8xlarge</para></li><li><para>stream.graphics-pro.16xlarge</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.MaxUserDurationInSecond"> <summary> <para> <para>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</para><para>Specify a value between 600 and 360000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.Name"> <summary> <para> <para>A unique name for the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.DomainJoinInfo_OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished name of the organizational unit for computer accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The identifiers of the security groups for the fleet or image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.StreamView"> <summary> <para> <para>The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</para><para>The default value is <code>APP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.VpcConfig_SubnetId"> <summary> <para> <para>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.DeleteVpcConfig"> <summary> <para> <para>Deletes the VPC association for the specified fleet.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Fleet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.UpdateFleetResponse). Specifying the name of a property of type Amazon.AppStream.Model.UpdateFleetResponse 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.APS.UpdateAPSFleetCmdlet.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.APS.UpdateAPSFleetCmdlet.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.APS.UpdateAPSImagePermissionCmdlet"> <summary> Adds or updates permissions for the specified private image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSImagePermissionCmdlet.ImagePermissions_AllowFleet"> <summary> <para> <para>Indicates whether the image can be used for a fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSImagePermissionCmdlet.ImagePermissions_AllowImageBuilder"> <summary> <para> <para>Indicates whether the image can be used for an image builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSImagePermissionCmdlet.Name"> <summary> <para> <para>The name of the private image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSImagePermissionCmdlet.SharedAccountId"> <summary> <para> <para>The 12-digit identifier of the AWS account for which you want add or update image permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSImagePermissionCmdlet.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.AppStream.Model.UpdateImagePermissionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSImagePermissionCmdlet.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.APS.UpdateAPSImagePermissionCmdlet.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.APS.UpdateAPSStackCmdlet"> <summary> Updates the specified fields for the specified stack. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.AccessEndpoint"> <summary> <para> <para>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.AttributesToDelete"> <summary> <para> <para>The stack attributes to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.Description"> <summary> <para> <para>The description to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.DisplayName"> <summary> <para> <para>The stack name to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.EmbedHostDomain"> <summary> <para> <para>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.ApplicationSettings_Enabled"> <summary> <para> <para>Enables or disables persistent application settings for users during their streaming sessions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.FeedbackURL"> <summary> <para> <para>The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.Name"> <summary> <para> <para>The name of the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.RedirectURL"> <summary> <para> <para>The URL that users are redirected to after their streaming session ends.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.ApplicationSettings_SettingsGroup"> <summary> <para> <para>The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.StorageConnector"> <summary> <para> <para>The storage connectors to enable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.UserSetting"> <summary> <para> <para>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.DeleteStorageConnector"> <summary> <para> <para>Deletes the storage connectors currently enabled for the stack.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.APS.UpdateAPSStackCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stack'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.UpdateStackResponse). Specifying the name of a property of type Amazon.AppStream.Model.UpdateStackResponse 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.APS.UpdateAPSStackCmdlet.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.APS.UpdateAPSStackCmdlet.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> |