AWS.Tools.WorkSpacesThinClient.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.WorkSpacesThinClient</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.AddWSTCResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.AddWSTCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.AddWSTCResourceTagCmdlet.Tag"> <summary> <para> <para>A map of the key-value pairs of the tag or tags to assign to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.AddWSTCResourceTagCmdlet.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.WorkSpacesThinClient.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.AddWSTCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.AddWSTCResourceTagCmdlet.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.WSTC.GetWSTCDeviceCmdlet"> <summary> Returns information for a thin client device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCDeviceCmdlet.Id"> <summary> <para> <para>The ID of the device for which to return information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCDeviceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Device'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.GetDeviceResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.GetDeviceResponse 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.WSTC.GetWSTCDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCDeviceListCmdlet"> <summary> Returns a list of thin client devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCDeviceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to obtain further pages of results.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCDeviceListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCDeviceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Devices'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.ListDevicesResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.ListDevicesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentCmdlet"> <summary> Returns information for an environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentCmdlet.Id"> <summary> <para> <para>The ID of the environment for which to return information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.GetEnvironmentResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.GetEnvironmentResponse 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.WSTC.GetWSTCEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentListCmdlet"> <summary> Returns a list of environments. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to obtain further pages of results.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.ListEnvironmentsResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.ListEnvironmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCResourceTagCmdlet"> <summary> Returns a list of tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCResourceTagCmdlet.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.WorkSpacesThinClient.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.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.WSTC.GetWSTCResourceTagCmdlet.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.WSTC.GetWSTCSoftwareSetCmdlet"> <summary> Returns information for a software set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCSoftwareSetCmdlet.Id"> <summary> <para> <para>The ID of the software set for which to return information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCSoftwareSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SoftwareSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.GetSoftwareSetResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.GetSoftwareSetResponse 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.WSTC.GetWSTCSoftwareSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCSoftwareSetListCmdlet"> <summary> Returns a list of software sets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCSoftwareSetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to obtain further pages of results.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCSoftwareSetListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.GetWSTCSoftwareSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SoftwareSets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.ListSoftwareSetsResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.ListSoftwareSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet"> <summary> Creates an environment for your thin client devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_ApplyTimeOf"> <summary> <para> <para>The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_DaysOfTheWeek"> <summary> <para> <para>The days of the week during which the maintenance window is open.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.DesiredSoftwareSetId"> <summary> <para> <para>The ID of the software set to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.DesktopArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.DesktopEndpoint"> <summary> <para> <para>The URL for the identity provider login (only for environments that use AppStream 2.0).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_EndTimeHour"> <summary> <para> <para>The hour for the maintenance window end (<c>00</c>-<c>23</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_EndTimeMinute"> <summary> <para> <para>The minutes for the maintenance window end (<c>00</c>-<c>59</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.Name"> <summary> <para> <para>The name for the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.SoftwareSetUpdateMode"> <summary> <para> <para>An option to define which software updates to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.SoftwareSetUpdateSchedule"> <summary> <para> <para>An option to define if software updates should be applied within a maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_StartTimeHour"> <summary> <para> <para>The hour for the maintenance window start (<c>00</c>-<c>23</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_StartTimeMinute"> <summary> <para> <para>The minutes past the hour for the maintenance window start (<c>00</c>-<c>59</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.Tag"> <summary> <para> <para>A map of the key-value pairs of the tag or tags to assign to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.MaintenanceWindow_Type"> <summary> <para> <para>An option to select the default or custom maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>IdempotentParameterMismatch</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.CreateEnvironmentResponse 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.WSTC.NewWSTCEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DesktopArn parameter. The -PassThru parameter is deprecated, use -Select '^DesktopArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.NewWSTCEnvironmentCmdlet.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.WSTC.RemoveWSTCDeviceCmdlet"> <summary> Deletes a thin client device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCDeviceCmdlet.Id"> <summary> <para> <para>The ID of the device to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCDeviceCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>IdempotentParameterMismatch</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCDeviceCmdlet.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.WorkSpacesThinClient.Model.DeleteDeviceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCDeviceCmdlet.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.WSTC.RemoveWSTCEnvironmentCmdlet"> <summary> Deletes an environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCEnvironmentCmdlet.Id"> <summary> <para> <para>The ID of the environment to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCEnvironmentCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>IdempotentParameterMismatch</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCEnvironmentCmdlet.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.WorkSpacesThinClient.Model.DeleteEnvironmentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCEnvironmentCmdlet.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.WSTC.RemoveWSTCResourceTagCmdlet"> <summary> Removes a tag or tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCResourceTagCmdlet.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.WorkSpacesThinClient.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.RemoveWSTCResourceTagCmdlet.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.WSTC.UnregisterWSTCDeviceCmdlet"> <summary> Deregisters a thin client device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UnregisterWSTCDeviceCmdlet.Id"> <summary> <para> <para>The ID of the device to deregister.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UnregisterWSTCDeviceCmdlet.TargetDeviceStatus"> <summary> <para> <para>The desired new status for the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UnregisterWSTCDeviceCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>IdempotentParameterMismatch</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UnregisterWSTCDeviceCmdlet.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.WorkSpacesThinClient.Model.DeregisterDeviceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UnregisterWSTCDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UnregisterWSTCDeviceCmdlet.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.WSTC.UpdateWSTCDeviceCmdlet"> <summary> Updates a thin client device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.DesiredSoftwareSetId"> <summary> <para> <para>The ID of the software set to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.Id"> <summary> <para> <para>The ID of the device to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Management Service key to use for the update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.Name"> <summary> <para> <para>The name of the device to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.SoftwareSetUpdateSchedule"> <summary> <para> <para>An option to define if software updates should be applied within a maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Device'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.UpdateDeviceResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.UpdateDeviceResponse 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.WSTC.UpdateWSTCDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCDeviceCmdlet.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.WSTC.UpdateWSTCEnvironmentCmdlet"> <summary> Updates an environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_ApplyTimeOf"> <summary> <para> <para>The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_DaysOfTheWeek"> <summary> <para> <para>The days of the week during which the maintenance window is open.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.DesiredSoftwareSetId"> <summary> <para> <para>The ID of the software set to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.DesktopArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.DesktopEndpoint"> <summary> <para> <para>The URL for the identity provider login (only for environments that use AppStream 2.0).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_EndTimeHour"> <summary> <para> <para>The hour for the maintenance window end (<c>00</c>-<c>23</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_EndTimeMinute"> <summary> <para> <para>The minutes for the maintenance window end (<c>00</c>-<c>59</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.Id"> <summary> <para> <para>The ID of the environment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the environment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.SoftwareSetUpdateMode"> <summary> <para> <para>An option to define which software updates to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.SoftwareSetUpdateSchedule"> <summary> <para> <para>An option to define if software updates should be applied within a maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_StartTimeHour"> <summary> <para> <para>The hour for the maintenance window start (<c>00</c>-<c>23</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_StartTimeMinute"> <summary> <para> <para>The minutes past the hour for the maintenance window start (<c>00</c>-<c>59</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.MaintenanceWindow_Type"> <summary> <para> <para>An option to select the default or custom maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesThinClient.Model.UpdateEnvironmentResponse). Specifying the name of a property of type Amazon.WorkSpacesThinClient.Model.UpdateEnvironmentResponse 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.WSTC.UpdateWSTCEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCEnvironmentCmdlet.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.WSTC.UpdateWSTCSoftwareSetCmdlet"> <summary> Updates a software set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCSoftwareSetCmdlet.Id"> <summary> <para> <para>The ID of the software set to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCSoftwareSetCmdlet.ValidationStatus"> <summary> <para> <para>An option to define if the software set has been validated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCSoftwareSetCmdlet.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.WorkSpacesThinClient.Model.UpdateSoftwareSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCSoftwareSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSTC.UpdateWSTCSoftwareSetCmdlet.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> |