AWS.Tools.WorkSpaces.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.WorkSpaces</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceCmdlet">
            <summary>
            Terminates the specified WorkSpaces. You can specify the Workspaces using either the
            <code>-WorkspaceId</code> or <code>-Request</code> parameters.
            <para>
            Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
            is not maintained and will be destroyed. If you need to archive any user data, contact
            Amazon Web Services <b>before</b> terminating the WorkSpace.
            </para>
            <para>
            You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.
            </para>
            <note>
            <para>
            This operation is asynchronous and returns before the WorkSpaces have been completely
            terminated.
            </para>
            </note>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceCmdlet.Request">
            <summary>
            An array of TerminateRequest objects specifying the WorkSpaces to be terminated.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceCmdlet.WorkspaceId">
            <summary>
            The IDs of one or more WorkSpaces to terminate.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceCmdlet.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.WKS.ResetWKSWorkspaceCmdlet">
            <summary>
            Rebuilds the specified WorkSpaces. You can specify the Workspaces using either the
            <code>-WorkspaceId</code> or <code>-Request</code> parameters.
            <para>
            Rebuilding a WorkSpace is a potentially destructive action that can result in the
            loss of data. Rebuilding a WorkSpace causes the following to occur:
            </para><ul><li><para>
            The system is restored to the image of the bundle that the WorkSpace is created from.
            Any applications that have been installed, or system settings that have been made
            since the WorkSpace was created will be lost.
            </para></li><li><para>
            The data drive (D drive) is re-created from the last automatic snapshot taken of the
            data drive. The current contents of the data drive are overwritten. Automatic snapshots
            of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours
            old.
            </para></li></ul><para>
            To be able to rebuild a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>
            or <code>ERROR</code>.
            </para><note><para>
            This operation is asynchronous and returns before the WorkSpaces have been completely
            rebuilt.
            </para></note>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ResetWKSWorkspaceCmdlet.Request">
            <summary>
            <para>
            <para>An array of structures that specify the WorkSpaces to rebuild.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ResetWKSWorkspaceCmdlet.WorkspaceId">
            <summary>
            The IDs of one or more WorkSpaces to rebuild.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ResetWKSWorkspaceCmdlet.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.WKS.RestartWKSWorkspaceCmdlet">
            <summary>
            Reboots the specified WorkSpaces. You can specify the Workspaces using either the
            <code>-WorkspaceId</code> or <code>-Request</code> parameters.
            <para>
            To be able to reboot a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>,
            <code>IMPAIRED</code>, or <code>INOPERABLE</code>.
            </para><note><para>
            This operation is asynchronous and returns before the WorkSpaces have rebooted.
            </para></note>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RestartWKSWorkspaceCmdlet.Request">
            <summary>
            <para>
            <para>An array of structures that specify the WorkSpaces to reboot.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RestartWKSWorkspaceCmdlet.WorkspaceId">
            <summary>
            The IDs of one or more WorkSpaces to reboot.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RestartWKSWorkspaceCmdlet.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.WKS.StartWKSWorkspaceCmdlet">
            <summary>
            Starts the specified WorkSpaces. You can specify the Workspaces using either the
            <code>-WorkspaceId</code> or <code>-Request</code> parameters.
            <para>
            The API only works with WorkSpaces that have RunningMode configured as AutoStop and the
            State set to “STOPPED.”
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.StartWKSWorkspaceCmdlet.Request">
            <summary>
            <para>
            <para>The requests.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.StartWKSWorkspaceCmdlet.WorkspaceId">
            <summary>
            The IDs of one or more WorkSpaces to start.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.StartWKSWorkspaceCmdlet.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.WKS.StopWKSWorkspaceCmdlet">
            <summary>
            Stops the specified WorkSpaces. You can specify the Workspaces using either the
            <code>-WorkspaceId</code> or <code>-Request</code> parameters.
            <para>
            To terminate WorkSpaces please update your script to use the <code>Remove-WKSWorkspace</code> cmdlet.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.StopWKSWorkspaceCmdlet.Request">
            <summary>
            <para>An array of StopRequest objects specifying the WorkSpaces to operate on.</para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.StopWKSWorkspaceCmdlet.WorkspaceId">
            <summary>
            The IDs of one or more WorkSpaces to be stopped.
            </summary>
            <returns></returns>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.StopWKSWorkspaceCmdlet.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.WKS.ApproveWKSIpRuleCmdlet">
            <summary>
            Adds one or more rules to the specified IP access control group.
             
              
            <para>
            This action gives users permission to access their WorkSpaces from the CIDR address
            ranges specified in the rules.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ApproveWKSIpRuleCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifier of the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ApproveWKSIpRuleCmdlet.UserRule">
            <summary>
            <para>
            <para>The rules to add to the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ApproveWKSIpRuleCmdlet.PassThru">
            <summary>
            Returns the value passed to the GroupId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ApproveWKSIpRuleCmdlet.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.WKS.CopyWKSWorkspaceImageCmdlet">
            <summary>
            Copies the specified image from the specified Region to the current Region.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.CopyWKSWorkspaceImageCmdlet.Description">
            <summary>
            <para>
            <para>A description of the image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.CopyWKSWorkspaceImageCmdlet.Name">
            <summary>
            <para>
            <para>The name of the image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.CopyWKSWorkspaceImageCmdlet.SourceImageId">
            <summary>
            <para>
            <para>The identifier of the source image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.CopyWKSWorkspaceImageCmdlet.SourceRegion">
            <summary>
            <para>
            <para>The identifier of the source Region.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.CopyWKSWorkspaceImageCmdlet.Tag">
            <summary>
            <para>
            <para>The tags for the image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.CopyWKSWorkspaceImageCmdlet.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.WKS.EditWKSAccountCmdlet">
            <summary>
            Modifies the configuration of bring your own license (BYOL) for the specified account.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSAccountCmdlet.DedicatedTenancyManagementCidrRange">
            <summary>
            <para>
            <para>The IP address range, specified as an IPv4 CIDR block, for the management network
            interface. Specify an IP address range that is compatible with your network and in
            CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size
            must be /16 (for example, 203.0.113.25/16). It must also be specified as available
            by the <code>ListAvailableManagementCidrRanges</code> operation.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSAccountCmdlet.DedicatedTenancySupport">
            <summary>
            <para>
            <para>The status of BYOL.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSAccountCmdlet.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.WKS.EditWKSClientPropertyCmdlet">
            <summary>
            Modifies the properties of the specified Amazon WorkSpaces clients.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSClientPropertyCmdlet.ClientProperties_ReconnectEnabled">
            <summary>
            <para>
            <para>Specifies whether users can cache their credentials on the Amazon WorkSpaces client.
            When enabled, users can choose to reconnect to their WorkSpaces without re-entering
            their credentials. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSClientPropertyCmdlet.ResourceId">
            <summary>
            <para>
            <para>The resource identifiers, in the form of directory IDs.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSClientPropertyCmdlet.PassThru">
            <summary>
            Returns the value passed to the ClientProperties_ReconnectEnabled parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSClientPropertyCmdlet.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.WKS.EditWKSWorkspacePropertyCmdlet">
            <summary>
            Modifies the specified WorkSpace properties.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.WorkspaceProperties_ComputeTypeName">
            <summary>
            <para>
            <para>The compute type. For more information, see <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon
            WorkSpaces Bundles</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.WorkspaceProperties_RootVolumeSizeGib">
            <summary>
            <para>
            <para>The size of the root volume.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.WorkspaceProperties_RunningMode">
            <summary>
            <para>
            <para>The running mode. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html">Manage
            the WorkSpace Running Mode</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.WorkspaceProperties_RunningModeAutoStopTimeoutInMinute">
            <summary>
            <para>
            <para>The time after a user logs off when WorkSpaces are automatically stopped. Configured
            in 60 minute intervals.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.WorkspaceProperties_UserVolumeSizeGib">
            <summary>
            <para>
            <para>The size of the user storage.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.WorkspaceId">
            <summary>
            <para>
            <para>The identifier of the WorkSpace.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.PassThru">
            <summary>
            Returns the value passed to the WorkspaceId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspacePropertyCmdlet.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.WKS.EditWKSWorkspaceStateCmdlet">
            <summary>
            Sets the state of the specified WorkSpace.
             
              
            <para>
            To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code>.
            WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild,
            or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into
            a WorkSpace in the <code>ADMIN_MAINTENANCE</code> state.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspaceStateCmdlet.WorkspaceId">
            <summary>
            <para>
            <para>The identifier of the WorkSpace.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspaceStateCmdlet.WorkspaceState">
            <summary>
            <para>
            <para>The WorkSpace state.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspaceStateCmdlet.PassThru">
            <summary>
            Returns the value passed to the WorkspaceId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.EditWKSWorkspaceStateCmdlet.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.WKS.GetWKSAccountCmdlet">
            <summary>
            Retrieves a list that describes the configuration of bring your own license (BYOL)
            for the specified account.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSAccountModificationCmdlet">
            <summary>
            Retrieves a list that describes modifications to the configuration of bring your own
            license (BYOL) for the specified account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSAccountModificationCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSAvailableManagementCidrRangeListCmdlet">
            <summary>
            Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can
            use for the network management interface when you enable bring your own license (BYOL).
             
             
              
            <para>
            The management network interface is connected to a secure Amazon WorkSpaces management
            network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces
            clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
            </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSAvailableManagementCidrRangeListCmdlet.ManagementCidrRangeConstraint">
            <summary>
            <para>
            <para>The IP address range to search. Specify an IP address range that is compatible with
            your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSAvailableManagementCidrRangeListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSAvailableManagementCidrRangeListCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSClientPropertyCmdlet">
            <summary>
            Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSClientPropertyCmdlet.ResourceId">
            <summary>
            <para>
            <para>The resource identifier, in the form of directory IDs.</para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSIpGroupCmdlet">
            <summary>
            Describes one or more of your IP access control groups.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSIpGroupCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifiers of one or more IP access control groups.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSIpGroupCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSIpGroupCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSTagCmdlet">
            <summary>
            Describes the specified tags for the specified WorkSpaces resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSTagCmdlet.WorkspaceId">
            <summary>
            <para>
            <para>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
            registered directories, images, custom bundles, and IP access control groups.</para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet">
            <summary>
            Describes the specified WorkSpaces.
             
              
            <para>
            You can filter the results by using the bundle identifier, directory identifier, or
            owner, but you can specify only one filter at a time.
            </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet.BundleId">
            <summary>
            <para>
            <para>The identifier of the bundle. All WorkSpaces that are created from this bundle are
            retrieved. You cannot combine this parameter with any other filter.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet.DirectoryId">
            <summary>
            <para>
            <para>The identifier of the directory. In addition, you can optionally specify a specific
            directory user (see <code>UserName</code>). You cannot combine this parameter with
            any other filter.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet.UserName">
            <summary>
            <para>
            <para>The name of the directory user. You must specify this parameter with <code>DirectoryId</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet.WorkspaceId">
            <summary>
            <para>
            <para>The identifiers of the WorkSpaces. You cannot combine this parameter with any other
            filter.</para><para>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns
            is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with
            this identifier, no information is returned.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet.Limit">
            <summary>
            <para>
            <para>The maximum number of items to return.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundleCmdlet">
            <summary>
            Retrieves a list that describes the available WorkSpace bundles.
             
              
            <para>
            You can filter the results using either bundle ID or owner, but not both.
            </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundleCmdlet.BundleId">
            <summary>
            <para>
            <para>The identifiers of the bundles. You cannot combine this parameter with any other filter.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundleCmdlet.NextToken">
            <summary>
            <para>
            <para>The token for the next set of results. (You received this token from a previous call.)</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundleCmdlet.Owner">
            <summary>
            <para>
            <para>The owner of the bundles. You cannot combine this parameter with any other filter.</para><para>Specify <code>AMAZON</code> to describe the bundles provided by AWS or null to describe
            the bundles that belong to your account.</para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceDirectoryCmdlet">
            <summary>
            Describes the available AWS Directory Service directories that are registered with
            Amazon WorkSpaces.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceDirectoryCmdlet.DirectoryId">
            <summary>
            <para>
            <para>The identifiers of the directories. If the value is null, all directories are retrieved.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceDirectoryCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceImageCmdlet">
            <summary>
            Retrieves a list that describes one or more specified images, if the image identifiers
            are provided. Otherwise, all images in the account are described.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceImageCmdlet.ImageId">
            <summary>
            <para>
            <para>The identifier of the image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceImageCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceImageCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesConnectionStatusCmdlet">
            <summary>
            Describes the connection status of the specified WorkSpaces.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesConnectionStatusCmdlet.WorkspaceId">
            <summary>
            <para>
            <para>The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesConnectionStatusCmdlet.NextToken">
            <summary>
            <para>
            <para>If you received a <code>NextToken</code> from a previous call that was paginated,
            provide this token to receive the next set of results.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet">
            <summary>
            Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image
            into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in
            your AWS account, and you must own the image.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet.Ec2ImageId">
            <summary>
            <para>
            <para>The identifier of the EC2 image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet.ImageDescription">
            <summary>
            <para>
            <para>The description of the WorkSpace image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet.ImageName">
            <summary>
            <para>
            <para>The name of the WorkSpace image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet.IngestionProcess">
            <summary>
            <para>
            <para>The ingestion process to be used when importing the image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet.Tag">
            <summary>
            <para>
            <para>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.ImportWKSWorkspaceImageCmdlet.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.WKS.NewWKSIpGroupCmdlet">
            <summary>
            Creates an IP access control group.
             
              
            <para>
            An IP access control group provides you with the ability to control the IP addresses
            from which users are allowed to access their WorkSpaces. To specify the CIDR address
            ranges, add rules to your IP access control group and then associate the group with
            your directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.
            </para><para>
            There is a default IP access control group associated with your directory. If you
            don't associate an IP access control group with your directory, the default group
            is used. The default group includes a default rule that allows users to access their
            WorkSpaces from anywhere. You cannot modify the default IP access control group for
            your directory.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSIpGroupCmdlet.GroupDesc">
            <summary>
            <para>
            <para>The description of the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSIpGroupCmdlet.GroupName">
            <summary>
            <para>
            <para>The name of the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSIpGroupCmdlet.Tag">
            <summary>
            <para>
            <para>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSIpGroupCmdlet.UserRule">
            <summary>
            <para>
            <para>The rules to add to the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSIpGroupCmdlet.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.WKS.NewWKSTagCmdlet">
            <summary>
            Creates the specified tags for the specified WorkSpaces resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSTagCmdlet.WorkspaceId">
            <summary>
            <para>
            <para>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
            registered directories, images, custom bundles, and IP access control groups.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSTagCmdlet.Tag">
            <summary>
            <para>
            <para>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSTagCmdlet.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.WKS.NewWKSWorkspaceCmdlet">
            <summary>
            Creates one or more WorkSpaces.
             
              
            <para>
            This operation is asynchronous and returns before the WorkSpaces are created.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSWorkspaceCmdlet.Workspace">
            <summary>
            <para>
            <para>The WorkSpaces to create. You can specify up to 25 WorkSpaces.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSWorkspaceCmdlet.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.WKS.RegisterWKSIpGroupCmdlet">
            <summary>
            Associates the specified IP access control group with the specified directory.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RegisterWKSIpGroupCmdlet.DirectoryId">
            <summary>
            <para>
            <para>The identifier of the directory.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RegisterWKSIpGroupCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifiers of one or more IP access control groups.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RegisterWKSIpGroupCmdlet.PassThru">
            <summary>
            Returns the value passed to the GroupId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RegisterWKSIpGroupCmdlet.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.WKS.RemoveWKSIpGroupCmdlet">
            <summary>
            Deletes the specified IP access control group.
             
              
            <para>
            You cannot delete an IP access control group that is associated with a directory.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSIpGroupCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifier of the IP access control group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSIpGroupCmdlet.PassThru">
            <summary>
            Returns the value passed to the GroupId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSIpGroupCmdlet.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.WKS.RemoveWKSTagCmdlet">
            <summary>
            Deletes the specified tags from the specified WorkSpaces resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSTagCmdlet.ResourceId">
            <summary>
            <para>
            <para>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
            registered directories, images, custom bundles, and IP access control groups.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSTagCmdlet.TagKey">
            <summary>
            <para>
            <para>The tag keys.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSTagCmdlet.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.WKS.RemoveWKSWorkspaceImageCmdlet">
            <summary>
            Deletes the specified image from your account. To delete an image, you must first
            delete any bundles that are associated with the image and un-share the image if it
            is shared with other accounts.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceImageCmdlet.ImageId">
            <summary>
            <para>
            <para>The identifier of the image.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceImageCmdlet.PassThru">
            <summary>
            Returns the value passed to the ImageId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RemoveWKSWorkspaceImageCmdlet.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.WKS.RevokeWKSIpRuleCmdlet">
            <summary>
            Removes one or more rules from the specified IP access control group.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RevokeWKSIpRuleCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifier of the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RevokeWKSIpRuleCmdlet.UserRule">
            <summary>
            <para>
            <para>The rules to remove from the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RevokeWKSIpRuleCmdlet.PassThru">
            <summary>
            Returns the value passed to the GroupId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.RevokeWKSIpRuleCmdlet.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.WKS.UnregisterWKSIpGroupCmdlet">
            <summary>
            Disassociates the specified IP access control group from the specified directory.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UnregisterWKSIpGroupCmdlet.DirectoryId">
            <summary>
            <para>
            <para>The identifier of the directory.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UnregisterWKSIpGroupCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifiers of one or more IP access control groups.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UnregisterWKSIpGroupCmdlet.PassThru">
            <summary>
            Returns the value passed to the GroupId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UnregisterWKSIpGroupCmdlet.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.WKS.UpdateWKSRulesOfIpGroupCmdlet">
            <summary>
            Replaces the current rules of the specified IP access control group with the specified
            rules.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UpdateWKSRulesOfIpGroupCmdlet.GroupId">
            <summary>
            <para>
            <para>The identifier of the group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UpdateWKSRulesOfIpGroupCmdlet.UserRule">
            <summary>
            <para>
            <para>One or more rules.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UpdateWKSRulesOfIpGroupCmdlet.PassThru">
            <summary>
            Returns the value passed to the GroupId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.WKS.UpdateWKSRulesOfIpGroupCmdlet.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>