/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the workspaces-2015-04-08.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.WorkSpaces.Model;
namespace Amazon.WorkSpaces
{
///
/// Interface for accessing WorkSpaces
///
/// Amazon WorkSpaces Service
///
/// Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
/// or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates
/// the need to procure and deploy hardware or install complex software. You can quickly
/// add or remove users as your needs change. Users can access their virtual desktops
/// from multiple devices or web browsers.
///
///
///
/// This API Reference provides detailed information about the actions, data types, parameters,
/// and errors of the WorkSpaces service. For more information about the supported Amazon
/// Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service,
/// see WorkSpaces endpoints
/// and quotas in the Amazon Web Services General Reference.
///
///
///
/// You can also manage your WorkSpaces resources using the WorkSpaces console, Command
/// Line Interface (CLI), and SDKs. For more information about administering WorkSpaces,
/// see the Amazon
/// WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces
/// client application or web browser to access provisioned WorkSpaces, see the Amazon
/// WorkSpaces User Guide. For more information about using the CLI to manage your
/// WorkSpaces resources, see the WorkSpaces
/// section of the CLI Reference.
///
///
public partial interface IAmazonWorkSpaces : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
IWorkSpacesPaginatorFactory Paginators { get; }
#region AssociateConnectionAlias
///
/// Associates the specified connection alias with the specified directory to enable cross-Region
/// redirection. For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
///
///
/// Before performing this operation, call
/// DescribeConnectionAliases to make sure that the current state of the connection
/// alias is CREATED
.
///
///
///
/// Container for the necessary parameters to execute the AssociateConnectionAlias service method.
///
/// The response from the AssociateConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for AssociateConnectionAlias Operation
AssociateConnectionAliasResponse AssociateConnectionAlias(AssociateConnectionAliasRequest request);
///
/// Associates the specified connection alias with the specified directory to enable cross-Region
/// redirection. For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
///
///
/// Before performing this operation, call
/// DescribeConnectionAliases to make sure that the current state of the connection
/// alias is CREATED
.
///
///
///
/// Container for the necessary parameters to execute the AssociateConnectionAlias service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AssociateConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for AssociateConnectionAlias Operation
Task AssociateConnectionAliasAsync(AssociateConnectionAliasRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region AssociateIpGroups
///
/// Associates the specified IP access control group with the specified directory.
///
/// Container for the necessary parameters to execute the AssociateIpGroups service method.
///
/// The response from the AssociateIpGroups service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for AssociateIpGroups Operation
AssociateIpGroupsResponse AssociateIpGroups(AssociateIpGroupsRequest request);
///
/// Associates the specified IP access control group with the specified directory.
///
/// Container for the necessary parameters to execute the AssociateIpGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AssociateIpGroups service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for AssociateIpGroups Operation
Task AssociateIpGroupsAsync(AssociateIpGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region AuthorizeIpRules
///
/// Adds one or more rules to the specified IP access control group.
///
///
///
/// This action gives users permission to access their WorkSpaces from the CIDR address
/// ranges specified in the rules.
///
///
/// Container for the necessary parameters to execute the AuthorizeIpRules service method.
///
/// The response from the AuthorizeIpRules service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for AuthorizeIpRules Operation
AuthorizeIpRulesResponse AuthorizeIpRules(AuthorizeIpRulesRequest request);
///
/// Adds one or more rules to the specified IP access control group.
///
///
///
/// This action gives users permission to access their WorkSpaces from the CIDR address
/// ranges specified in the rules.
///
///
/// Container for the necessary parameters to execute the AuthorizeIpRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AuthorizeIpRules service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for AuthorizeIpRules Operation
Task AuthorizeIpRulesAsync(AuthorizeIpRulesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CopyWorkspaceImage
///
/// Copies the specified image from the specified Region to the current Region. For more
/// information about copying images, see
/// Copy a Custom WorkSpaces Image.
///
///
///
/// In the China (Ningxia) Region, you can copy images only within the same Region.
///
///
///
/// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact
/// Amazon Web Services Support.
///
///
///
/// Before copying a shared image, be sure to verify that it has been shared from the
/// correct Amazon Web Services account. To determine if an image has been shared and
/// to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages
/// and DescribeWorkspaceImagePermissions
/// API operations.
///
///
///
/// Container for the necessary parameters to execute the CopyWorkspaceImage service method.
///
/// The response from the CopyWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for CopyWorkspaceImage Operation
CopyWorkspaceImageResponse CopyWorkspaceImage(CopyWorkspaceImageRequest request);
///
/// Copies the specified image from the specified Region to the current Region. For more
/// information about copying images, see
/// Copy a Custom WorkSpaces Image.
///
///
///
/// In the China (Ningxia) Region, you can copy images only within the same Region.
///
///
///
/// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact
/// Amazon Web Services Support.
///
///
///
/// Before copying a shared image, be sure to verify that it has been shared from the
/// correct Amazon Web Services account. To determine if an image has been shared and
/// to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages
/// and DescribeWorkspaceImagePermissions
/// API operations.
///
///
///
/// Container for the necessary parameters to execute the CopyWorkspaceImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for CopyWorkspaceImage Operation
Task CopyWorkspaceImageAsync(CopyWorkspaceImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateConnectClientAddIn
///
/// Creates a client-add-in for Amazon Connect within a directory. You can create only
/// one Amazon Connect client add-in within a directory.
///
///
///
/// This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
///
///
/// Container for the necessary parameters to execute the CreateConnectClientAddIn service method.
///
/// The response from the CreateConnectClientAddIn service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The specified resource already exists.
///
///
/// The resource could not be created.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateConnectClientAddIn Operation
CreateConnectClientAddInResponse CreateConnectClientAddIn(CreateConnectClientAddInRequest request);
///
/// Creates a client-add-in for Amazon Connect within a directory. You can create only
/// one Amazon Connect client add-in within a directory.
///
///
///
/// This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
///
///
/// Container for the necessary parameters to execute the CreateConnectClientAddIn service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateConnectClientAddIn service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The specified resource already exists.
///
///
/// The resource could not be created.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateConnectClientAddIn Operation
Task CreateConnectClientAddInAsync(CreateConnectClientAddInRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateConnectionAlias
///
/// Creates the specified connection alias for use with cross-Region redirection. For
/// more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the CreateConnectionAlias service method.
///
/// The response from the CreateConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
/// REST API Reference for CreateConnectionAlias Operation
CreateConnectionAliasResponse CreateConnectionAlias(CreateConnectionAliasRequest request);
///
/// Creates the specified connection alias for use with cross-Region redirection. For
/// more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the CreateConnectionAlias service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
/// REST API Reference for CreateConnectionAlias Operation
Task CreateConnectionAliasAsync(CreateConnectionAliasRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateIpGroup
///
/// Creates an IP access control group.
///
///
///
/// 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 AuthorizeIpRules.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateIpGroup service method.
///
/// The response from the CreateIpGroup service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The specified resource already exists.
///
///
/// The resource could not be created.
///
///
/// Your resource limits have been exceeded.
///
/// REST API Reference for CreateIpGroup Operation
CreateIpGroupResponse CreateIpGroup(CreateIpGroupRequest request);
///
/// Creates an IP access control group.
///
///
///
/// 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 AuthorizeIpRules.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateIpGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateIpGroup service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The specified resource already exists.
///
///
/// The resource could not be created.
///
///
/// Your resource limits have been exceeded.
///
/// REST API Reference for CreateIpGroup Operation
Task CreateIpGroupAsync(CreateIpGroupRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateStandbyWorkspaces
///
/// Creates a standby WorkSpace in a secondary Region.
///
/// Container for the necessary parameters to execute the CreateStandbyWorkspaces service method.
///
/// The response from the CreateStandbyWorkspaces service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateStandbyWorkspaces Operation
CreateStandbyWorkspacesResponse CreateStandbyWorkspaces(CreateStandbyWorkspacesRequest request);
///
/// Creates a standby WorkSpace in a secondary Region.
///
/// Container for the necessary parameters to execute the CreateStandbyWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateStandbyWorkspaces service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateStandbyWorkspaces Operation
Task CreateStandbyWorkspacesAsync(CreateStandbyWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateTags
///
/// Creates the specified tags for the specified WorkSpaces resource.
///
/// Container for the necessary parameters to execute the CreateTags service method.
///
/// The response from the CreateTags service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateTags Operation
CreateTagsResponse CreateTags(CreateTagsRequest request);
///
/// Creates the specified tags for the specified WorkSpaces resource.
///
/// Container for the necessary parameters to execute the CreateTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateTags service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateTags Operation
Task CreateTagsAsync(CreateTagsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateUpdatedWorkspaceImage
///
/// Creates a new updated WorkSpace image based on the specified source image. The new
/// updated WorkSpace image has the latest drivers and other updates required by the Amazon
/// WorkSpaces components.
///
///
///
/// To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces
/// requirements, use
/// DescribeWorkspaceImages.
///
/// -
///
/// Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can
/// be programmatically updated at this time.
///
///
-
///
/// Microsoft Windows updates and other application updates are not included in the update
/// process.
///
///
-
///
/// The source WorkSpace image is not deleted. You can delete the source image after you've
/// verified your new updated image and created a new bundle.
///
///
///
/// Container for the necessary parameters to execute the CreateUpdatedWorkspaceImage service method.
///
/// The response from the CreateUpdatedWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateUpdatedWorkspaceImage Operation
CreateUpdatedWorkspaceImageResponse CreateUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest request);
///
/// Creates a new updated WorkSpace image based on the specified source image. The new
/// updated WorkSpace image has the latest drivers and other updates required by the Amazon
/// WorkSpaces components.
///
///
///
/// To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces
/// requirements, use
/// DescribeWorkspaceImages.
///
/// -
///
/// Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can
/// be programmatically updated at this time.
///
///
-
///
/// Microsoft Windows updates and other application updates are not included in the update
/// process.
///
///
-
///
/// The source WorkSpace image is not deleted. You can delete the source image after you've
/// verified your new updated image and created a new bundle.
///
///
///
/// Container for the necessary parameters to execute the CreateUpdatedWorkspaceImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateUpdatedWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateUpdatedWorkspaceImage Operation
Task CreateUpdatedWorkspaceImageAsync(CreateUpdatedWorkspaceImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateWorkspaceBundle
///
/// Creates the specified WorkSpace bundle. For more information about creating WorkSpace
/// bundles, see
/// Create a Custom WorkSpaces Image and Bundle.
///
/// Container for the necessary parameters to execute the CreateWorkspaceBundle service method.
///
/// The response from the CreateWorkspaceBundle service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for CreateWorkspaceBundle Operation
CreateWorkspaceBundleResponse CreateWorkspaceBundle(CreateWorkspaceBundleRequest request);
///
/// Creates the specified WorkSpace bundle. For more information about creating WorkSpace
/// bundles, see
/// Create a Custom WorkSpaces Image and Bundle.
///
/// Container for the necessary parameters to execute the CreateWorkspaceBundle service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateWorkspaceBundle service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for CreateWorkspaceBundle Operation
Task CreateWorkspaceBundleAsync(CreateWorkspaceBundleRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateWorkspaceImage
///
/// Creates a new WorkSpace image from an existing WorkSpace.
///
/// Container for the necessary parameters to execute the CreateWorkspaceImage service method.
///
/// The response from the CreateWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateWorkspaceImage Operation
CreateWorkspaceImageResponse CreateWorkspaceImage(CreateWorkspaceImageRequest request);
///
/// Creates a new WorkSpace image from an existing WorkSpace.
///
/// Container for the necessary parameters to execute the CreateWorkspaceImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for CreateWorkspaceImage Operation
Task CreateWorkspaceImageAsync(CreateWorkspaceImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateWorkspaces
///
/// Creates one or more WorkSpaces.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces are created.
///
///
///
/// The MANUAL
running mode value is only supported by Amazon WorkSpaces
/// Core. Contact your account team to be allow-listed to use this value. For more information,
/// see Amazon WorkSpaces Core.
///
///
///
/// Container for the necessary parameters to execute the CreateWorkspaces service method.
///
/// The response from the CreateWorkspaces service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// Your resource limits have been exceeded.
///
/// REST API Reference for CreateWorkspaces Operation
CreateWorkspacesResponse CreateWorkspaces(CreateWorkspacesRequest request);
///
/// Creates one or more WorkSpaces.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces are created.
///
///
///
/// The MANUAL
running mode value is only supported by Amazon WorkSpaces
/// Core. Contact your account team to be allow-listed to use this value. For more information,
/// see Amazon WorkSpaces Core.
///
///
///
/// Container for the necessary parameters to execute the CreateWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateWorkspaces service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// Your resource limits have been exceeded.
///
/// REST API Reference for CreateWorkspaces Operation
Task CreateWorkspacesAsync(CreateWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteClientBranding
///
/// Deletes customized client branding. Client branding allows you to customize your WorkSpace's
/// client login portal. You can tailor your login portal company logo, the support email
/// address, support link, link to reset password, and a custom message for users trying
/// to sign in.
///
///
///
/// After you delete your customized client branding, your login portal reverts to the
/// default client branding.
///
///
/// Container for the necessary parameters to execute the DeleteClientBranding service method.
///
/// The response from the DeleteClientBranding service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteClientBranding Operation
DeleteClientBrandingResponse DeleteClientBranding(DeleteClientBrandingRequest request);
///
/// Deletes customized client branding. Client branding allows you to customize your WorkSpace's
/// client login portal. You can tailor your login portal company logo, the support email
/// address, support link, link to reset password, and a custom message for users trying
/// to sign in.
///
///
///
/// After you delete your customized client branding, your login portal reverts to the
/// default client branding.
///
///
/// Container for the necessary parameters to execute the DeleteClientBranding service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteClientBranding service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteClientBranding Operation
Task DeleteClientBrandingAsync(DeleteClientBrandingRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteConnectClientAddIn
///
/// Deletes a client-add-in for Amazon Connect that is configured within a directory.
///
/// Container for the necessary parameters to execute the DeleteConnectClientAddIn service method.
///
/// The response from the DeleteConnectClientAddIn service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteConnectClientAddIn Operation
DeleteConnectClientAddInResponse DeleteConnectClientAddIn(DeleteConnectClientAddInRequest request);
///
/// Deletes a client-add-in for Amazon Connect that is configured within a directory.
///
/// Container for the necessary parameters to execute the DeleteConnectClientAddIn service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteConnectClientAddIn service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteConnectClientAddIn Operation
Task DeleteConnectClientAddInAsync(DeleteConnectClientAddInRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteConnectionAlias
///
/// Deletes the specified connection alias. For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
///
///
/// If you will no longer be using a fully qualified domain name (FQDN) as the registration
/// code for your WorkSpaces users, you must take certain precautions to prevent potential
/// security issues. For more information, see
/// Security Considerations if You Stop Using Cross-Region Redirection.
///
///
///
/// To delete a connection alias that has been shared, the shared account must first disassociate
/// the connection alias from any directories it has been associated with. Then you must
/// unshare the connection alias from the account it has been shared with. You can delete
/// a connection alias only after it is no longer shared with any accounts or associated
/// with any directories.
///
///
///
/// Container for the necessary parameters to execute the DeleteConnectionAlias service method.
///
/// The response from the DeleteConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteConnectionAlias Operation
DeleteConnectionAliasResponse DeleteConnectionAlias(DeleteConnectionAliasRequest request);
///
/// Deletes the specified connection alias. For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
///
///
/// If you will no longer be using a fully qualified domain name (FQDN) as the registration
/// code for your WorkSpaces users, you must take certain precautions to prevent potential
/// security issues. For more information, see
/// Security Considerations if You Stop Using Cross-Region Redirection.
///
///
///
/// To delete a connection alias that has been shared, the shared account must first disassociate
/// the connection alias from any directories it has been associated with. Then you must
/// unshare the connection alias from the account it has been shared with. You can delete
/// a connection alias only after it is no longer shared with any accounts or associated
/// with any directories.
///
///
///
/// Container for the necessary parameters to execute the DeleteConnectionAlias service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteConnectionAlias Operation
Task DeleteConnectionAliasAsync(DeleteConnectionAliasRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteIpGroup
///
/// Deletes the specified IP access control group.
///
///
///
/// You cannot delete an IP access control group that is associated with a directory.
///
///
/// Container for the necessary parameters to execute the DeleteIpGroup service method.
///
/// The response from the DeleteIpGroup service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteIpGroup Operation
DeleteIpGroupResponse DeleteIpGroup(DeleteIpGroupRequest request);
///
/// Deletes the specified IP access control group.
///
///
///
/// You cannot delete an IP access control group that is associated with a directory.
///
///
/// Container for the necessary parameters to execute the DeleteIpGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteIpGroup service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteIpGroup Operation
Task DeleteIpGroupAsync(DeleteIpGroupRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteTags
///
/// Deletes the specified tags from the specified WorkSpaces resource.
///
/// Container for the necessary parameters to execute the DeleteTags service method.
///
/// The response from the DeleteTags service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteTags Operation
DeleteTagsResponse DeleteTags(DeleteTagsRequest request);
///
/// Deletes the specified tags from the specified WorkSpaces resource.
///
/// Container for the necessary parameters to execute the DeleteTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteTags service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteTags Operation
Task DeleteTagsAsync(DeleteTagsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteWorkspaceBundle
///
/// Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace
/// bundles, see
/// Delete a Custom WorkSpaces Bundle or Image.
///
/// Container for the necessary parameters to execute the DeleteWorkspaceBundle service method.
///
/// The response from the DeleteWorkspaceBundle service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteWorkspaceBundle Operation
DeleteWorkspaceBundleResponse DeleteWorkspaceBundle(DeleteWorkspaceBundleRequest request);
///
/// Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace
/// bundles, see
/// Delete a Custom WorkSpaces Bundle or Image.
///
/// Container for the necessary parameters to execute the DeleteWorkspaceBundle service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteWorkspaceBundle service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource is associated with a directory.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeleteWorkspaceBundle Operation
Task DeleteWorkspaceBundleAsync(DeleteWorkspaceBundleRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteWorkspaceImage
///
/// Deletes the specified image from your account. To delete an image, you must first
/// delete any bundles that are associated with the image and unshare the image if it
/// is shared with other accounts.
///
/// Container for the necessary parameters to execute the DeleteWorkspaceImage service method.
///
/// The response from the DeleteWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource is associated with a directory.
///
/// REST API Reference for DeleteWorkspaceImage Operation
DeleteWorkspaceImageResponse DeleteWorkspaceImage(DeleteWorkspaceImageRequest request);
///
/// Deletes the specified image from your account. To delete an image, you must first
/// delete any bundles that are associated with the image and unshare the image if it
/// is shared with other accounts.
///
/// Container for the necessary parameters to execute the DeleteWorkspaceImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource is associated with a directory.
///
/// REST API Reference for DeleteWorkspaceImage Operation
Task DeleteWorkspaceImageAsync(DeleteWorkspaceImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeregisterWorkspaceDirectory
///
/// Deregisters the specified directory. This operation is asynchronous and returns before
/// the WorkSpace directory is deregistered. If any WorkSpaces are registered to this
/// directory, you must remove them before you can deregister the directory.
///
///
///
/// Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces.
/// If there are no WorkSpaces being used with your Simple AD or AD Connector directory
/// for 30 consecutive days, this directory will be automatically deregistered for use
/// with Amazon WorkSpaces, and you will be charged for this directory as per the Directory
/// Service pricing terms.
///
///
///
/// To delete empty directories, see
/// Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector
/// directory, you can always create a new one when you want to start using WorkSpaces
/// again.
///
///
///
/// Container for the necessary parameters to execute the DeregisterWorkspaceDirectory service method.
///
/// The response from the DeregisterWorkspaceDirectory service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeregisterWorkspaceDirectory Operation
DeregisterWorkspaceDirectoryResponse DeregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest request);
///
/// Deregisters the specified directory. This operation is asynchronous and returns before
/// the WorkSpace directory is deregistered. If any WorkSpaces are registered to this
/// directory, you must remove them before you can deregister the directory.
///
///
///
/// Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces.
/// If there are no WorkSpaces being used with your Simple AD or AD Connector directory
/// for 30 consecutive days, this directory will be automatically deregistered for use
/// with Amazon WorkSpaces, and you will be charged for this directory as per the Directory
/// Service pricing terms.
///
///
///
/// To delete empty directories, see
/// Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector
/// directory, you can always create a new one when you want to start using WorkSpaces
/// again.
///
///
///
/// Container for the necessary parameters to execute the DeregisterWorkspaceDirectory service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeregisterWorkspaceDirectory service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for DeregisterWorkspaceDirectory Operation
Task DeregisterWorkspaceDirectoryAsync(DeregisterWorkspaceDirectoryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeAccount
///
/// Retrieves a list that describes the configuration of Bring Your Own License (BYOL)
/// for the specified account.
///
/// Container for the necessary parameters to execute the DescribeAccount service method.
///
/// The response from the DescribeAccount service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
/// REST API Reference for DescribeAccount Operation
DescribeAccountResponse DescribeAccount(DescribeAccountRequest request);
///
/// Retrieves a list that describes the configuration of Bring Your Own License (BYOL)
/// for the specified account.
///
/// Container for the necessary parameters to execute the DescribeAccount service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAccount service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
/// REST API Reference for DescribeAccount Operation
Task DescribeAccountAsync(DescribeAccountRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeAccountModifications
///
/// Retrieves a list that describes modifications to the configuration of Bring Your Own
/// License (BYOL) for the specified account.
///
/// Container for the necessary parameters to execute the DescribeAccountModifications service method.
///
/// The response from the DescribeAccountModifications service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
/// REST API Reference for DescribeAccountModifications Operation
DescribeAccountModificationsResponse DescribeAccountModifications(DescribeAccountModificationsRequest request);
///
/// Retrieves a list that describes modifications to the configuration of Bring Your Own
/// License (BYOL) for the specified account.
///
/// Container for the necessary parameters to execute the DescribeAccountModifications service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAccountModifications service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
/// REST API Reference for DescribeAccountModifications Operation
Task DescribeAccountModificationsAsync(DescribeAccountModificationsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeClientBranding
///
/// Describes the specified client branding. Client branding allows you to customize the
/// log in page of various device types for your users. You can add your company logo,
/// the support email address, support link, link to reset password, and a custom message
/// for users trying to sign in.
///
///
///
/// Only device types that have branding information configured will be shown in the response.
///
///
///
/// Container for the necessary parameters to execute the DescribeClientBranding service method.
///
/// The response from the DescribeClientBranding service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeClientBranding Operation
DescribeClientBrandingResponse DescribeClientBranding(DescribeClientBrandingRequest request);
///
/// Describes the specified client branding. Client branding allows you to customize the
/// log in page of various device types for your users. You can add your company logo,
/// the support email address, support link, link to reset password, and a custom message
/// for users trying to sign in.
///
///
///
/// Only device types that have branding information configured will be shown in the response.
///
///
///
/// Container for the necessary parameters to execute the DescribeClientBranding service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeClientBranding service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeClientBranding Operation
Task DescribeClientBrandingAsync(DescribeClientBrandingRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeClientProperties
///
/// Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
///
/// Container for the necessary parameters to execute the DescribeClientProperties service method.
///
/// The response from the DescribeClientProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeClientProperties Operation
DescribeClientPropertiesResponse DescribeClientProperties(DescribeClientPropertiesRequest request);
///
/// Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
///
/// Container for the necessary parameters to execute the DescribeClientProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeClientProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeClientProperties Operation
Task DescribeClientPropertiesAsync(DescribeClientPropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeConnectClientAddIns
///
/// Retrieves a list of Amazon Connect client add-ins that have been created.
///
/// Container for the necessary parameters to execute the DescribeConnectClientAddIns service method.
///
/// The response from the DescribeConnectClientAddIns service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeConnectClientAddIns Operation
DescribeConnectClientAddInsResponse DescribeConnectClientAddIns(DescribeConnectClientAddInsRequest request);
///
/// Retrieves a list of Amazon Connect client add-ins that have been created.
///
/// Container for the necessary parameters to execute the DescribeConnectClientAddIns service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeConnectClientAddIns service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeConnectClientAddIns Operation
Task DescribeConnectClientAddInsAsync(DescribeConnectClientAddInsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeConnectionAliases
///
/// Retrieves a list that describes the connection aliases used for cross-Region redirection.
/// For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeConnectionAliases service method.
///
/// The response from the DescribeConnectionAliases service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
/// REST API Reference for DescribeConnectionAliases Operation
DescribeConnectionAliasesResponse DescribeConnectionAliases(DescribeConnectionAliasesRequest request);
///
/// Retrieves a list that describes the connection aliases used for cross-Region redirection.
/// For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeConnectionAliases service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeConnectionAliases service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
/// REST API Reference for DescribeConnectionAliases Operation
Task DescribeConnectionAliasesAsync(DescribeConnectionAliasesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeConnectionAliasPermissions
///
/// Describes the permissions that the owner of a connection alias has granted to another
/// Amazon Web Services account for the specified connection alias. For more information,
/// see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeConnectionAliasPermissions service method.
///
/// The response from the DescribeConnectionAliasPermissions service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeConnectionAliasPermissions Operation
DescribeConnectionAliasPermissionsResponse DescribeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest request);
///
/// Describes the permissions that the owner of a connection alias has granted to another
/// Amazon Web Services account for the specified connection alias. For more information,
/// see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeConnectionAliasPermissions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeConnectionAliasPermissions service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeConnectionAliasPermissions Operation
Task DescribeConnectionAliasPermissionsAsync(DescribeConnectionAliasPermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeIpGroups
///
/// Describes one or more of your IP access control groups.
///
/// Container for the necessary parameters to execute the DescribeIpGroups service method.
///
/// The response from the DescribeIpGroups service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeIpGroups Operation
DescribeIpGroupsResponse DescribeIpGroups(DescribeIpGroupsRequest request);
///
/// Describes one or more of your IP access control groups.
///
/// Container for the necessary parameters to execute the DescribeIpGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeIpGroups service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeIpGroups Operation
Task DescribeIpGroupsAsync(DescribeIpGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeTags
///
/// Describes the specified tags for the specified WorkSpaces resource.
///
/// Container for the necessary parameters to execute the DescribeTags service method.
///
/// The response from the DescribeTags service method, as returned by WorkSpaces.
///
/// The resource could not be found.
///
/// REST API Reference for DescribeTags Operation
DescribeTagsResponse DescribeTags(DescribeTagsRequest request);
///
/// Describes the specified tags for the specified WorkSpaces resource.
///
/// Container for the necessary parameters to execute the DescribeTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeTags service method, as returned by WorkSpaces.
///
/// The resource could not be found.
///
/// REST API Reference for DescribeTags Operation
Task DescribeTagsAsync(DescribeTagsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceBundles
///
/// Retrieves a list that describes the available WorkSpace bundles.
///
///
///
/// You can filter the results using either bundle ID or owner, but not both.
///
///
///
/// The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceBundles Operation
DescribeWorkspaceBundlesResponse DescribeWorkspaceBundles();
///
/// Retrieves a list that describes the available WorkSpace bundles.
///
///
///
/// You can filter the results using either bundle ID or owner, but not both.
///
///
/// Container for the necessary parameters to execute the DescribeWorkspaceBundles service method.
///
/// The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceBundles Operation
DescribeWorkspaceBundlesResponse DescribeWorkspaceBundles(DescribeWorkspaceBundlesRequest request);
///
/// Retrieves a list that describes the available WorkSpace bundles.
///
///
///
/// You can filter the results using either bundle ID or owner, but not both.
///
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceBundles Operation
Task DescribeWorkspaceBundlesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// Retrieves a list that describes the available WorkSpace bundles.
///
///
///
/// You can filter the results using either bundle ID or owner, but not both.
///
///
/// Container for the necessary parameters to execute the DescribeWorkspaceBundles service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceBundles Operation
Task DescribeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceDirectories
///
/// Describes the available directories that are registered with Amazon WorkSpaces.
///
///
/// The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceDirectories Operation
DescribeWorkspaceDirectoriesResponse DescribeWorkspaceDirectories();
///
/// Describes the available directories that are registered with Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceDirectories service method.
///
/// The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceDirectories Operation
DescribeWorkspaceDirectoriesResponse DescribeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request);
///
/// Describes the available directories that are registered with Amazon WorkSpaces.
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceDirectories Operation
Task DescribeWorkspaceDirectoriesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// Describes the available directories that are registered with Amazon WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceDirectories service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspaceDirectories Operation
Task DescribeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceImagePermissions
///
/// Describes the permissions that the owner of an image has granted to other Amazon Web
/// Services accounts for an image.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceImagePermissions service method.
///
/// The response from the DescribeWorkspaceImagePermissions service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeWorkspaceImagePermissions Operation
DescribeWorkspaceImagePermissionsResponse DescribeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest request);
///
/// Describes the permissions that the owner of an image has granted to other Amazon Web
/// Services accounts for an image.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceImagePermissions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceImagePermissions service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeWorkspaceImagePermissions Operation
Task DescribeWorkspaceImagePermissionsAsync(DescribeWorkspaceImagePermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceImages
///
/// Retrieves a list that describes one or more specified images, if the image identifiers
/// are provided. Otherwise, all images in the account are described.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceImages service method.
///
/// The response from the DescribeWorkspaceImages service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
/// REST API Reference for DescribeWorkspaceImages Operation
DescribeWorkspaceImagesResponse DescribeWorkspaceImages(DescribeWorkspaceImagesRequest request);
///
/// Retrieves a list that describes one or more specified images, if the image identifiers
/// are provided. Otherwise, all images in the account are described.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceImages service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceImages service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
/// REST API Reference for DescribeWorkspaceImages Operation
Task DescribeWorkspaceImagesAsync(DescribeWorkspaceImagesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaces
///
/// Describes the specified WorkSpaces.
///
///
///
/// You can filter the results by using the bundle identifier, directory identifier, or
/// owner, but you can specify only one filter at a time.
///
///
///
/// The response from the DescribeWorkspaces service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The specified resource is not available.
///
/// REST API Reference for DescribeWorkspaces Operation
DescribeWorkspacesResponse DescribeWorkspaces();
///
/// Describes the specified WorkSpaces.
///
///
///
/// You can filter the results by using the bundle identifier, directory identifier, or
/// owner, but you can specify only one filter at a time.
///
///
/// Container for the necessary parameters to execute the DescribeWorkspaces service method.
///
/// The response from the DescribeWorkspaces service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The specified resource is not available.
///
/// REST API Reference for DescribeWorkspaces Operation
DescribeWorkspacesResponse DescribeWorkspaces(DescribeWorkspacesRequest request);
///
/// Describes the specified WorkSpaces.
///
///
///
/// You can filter the results by using the bundle identifier, directory identifier, or
/// owner, but you can specify only one filter at a time.
///
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaces service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The specified resource is not available.
///
/// REST API Reference for DescribeWorkspaces Operation
Task DescribeWorkspacesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// Describes the specified WorkSpaces.
///
///
///
/// You can filter the results by using the bundle identifier, directory identifier, or
/// owner, but you can specify only one filter at a time.
///
///
/// Container for the necessary parameters to execute the DescribeWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaces service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The specified resource is not available.
///
/// REST API Reference for DescribeWorkspaces Operation
Task DescribeWorkspacesAsync(DescribeWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspacesConnectionStatus
///
/// Describes the connection status of the specified WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeWorkspacesConnectionStatus service method.
///
/// The response from the DescribeWorkspacesConnectionStatus service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspacesConnectionStatus Operation
DescribeWorkspacesConnectionStatusResponse DescribeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request);
///
/// Describes the connection status of the specified WorkSpaces.
///
/// Container for the necessary parameters to execute the DescribeWorkspacesConnectionStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspacesConnectionStatus service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
/// REST API Reference for DescribeWorkspacesConnectionStatus Operation
Task DescribeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWorkspaceSnapshots
///
/// Describes the snapshots for the specified WorkSpace.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceSnapshots service method.
///
/// The response from the DescribeWorkspaceSnapshots service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeWorkspaceSnapshots Operation
DescribeWorkspaceSnapshotsResponse DescribeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest request);
///
/// Describes the snapshots for the specified WorkSpace.
///
/// Container for the necessary parameters to execute the DescribeWorkspaceSnapshots service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWorkspaceSnapshots service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for DescribeWorkspaceSnapshots Operation
Task DescribeWorkspaceSnapshotsAsync(DescribeWorkspaceSnapshotsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DisassociateConnectionAlias
///
/// Disassociates a connection alias from a directory. Disassociating a connection alias
/// disables cross-Region redirection between two directories in different Regions. For
/// more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
///
///
/// Before performing this operation, call
/// DescribeConnectionAliases to make sure that the current state of the connection
/// alias is CREATED
.
///
///
///
/// Container for the necessary parameters to execute the DisassociateConnectionAlias service method.
///
/// The response from the DisassociateConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for DisassociateConnectionAlias Operation
DisassociateConnectionAliasResponse DisassociateConnectionAlias(DisassociateConnectionAliasRequest request);
///
/// Disassociates a connection alias from a directory. Disassociating a connection alias
/// disables cross-Region redirection between two directories in different Regions. For
/// more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
///
///
/// Before performing this operation, call
/// DescribeConnectionAliases to make sure that the current state of the connection
/// alias is CREATED
.
///
///
///
/// Container for the necessary parameters to execute the DisassociateConnectionAlias service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisassociateConnectionAlias service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for DisassociateConnectionAlias Operation
Task DisassociateConnectionAliasAsync(DisassociateConnectionAliasRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DisassociateIpGroups
///
/// Disassociates the specified IP access control group from the specified directory.
///
/// Container for the necessary parameters to execute the DisassociateIpGroups service method.
///
/// The response from the DisassociateIpGroups service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource could not be found.
///
/// REST API Reference for DisassociateIpGroups Operation
DisassociateIpGroupsResponse DisassociateIpGroups(DisassociateIpGroupsRequest request);
///
/// Disassociates the specified IP access control group from the specified directory.
///
/// Container for the necessary parameters to execute the DisassociateIpGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisassociateIpGroups service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource could not be found.
///
/// REST API Reference for DisassociateIpGroups Operation
Task DisassociateIpGroupsAsync(DisassociateIpGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ImportClientBranding
///
/// Imports client branding. Client branding allows you to customize your WorkSpace's
/// client login portal. You can tailor your login portal company logo, the support email
/// address, support link, link to reset password, and a custom message for users trying
/// to sign in.
///
///
///
/// After you import client branding, the default branding experience for the specified
/// platform type is replaced with the imported experience
///
/// -
///
/// You must specify at least one platform type when importing client branding.
///
///
-
///
/// You can import up to 6 MB of data with each request. If your request exceeds this
/// limit, you can import client branding for different platform types using separate
/// requests.
///
///
-
///
/// In each platform type, the
SupportEmail
and SupportLink
/// parameters are mutually exclusive. You can specify only one parameter for each platform
/// type, but not both.
///
/// -
///
/// Imported data can take up to a minute to appear in the WorkSpaces client.
///
///
///
/// Container for the necessary parameters to execute the ImportClientBranding service method.
///
/// The response from the ImportClientBranding service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for ImportClientBranding Operation
ImportClientBrandingResponse ImportClientBranding(ImportClientBrandingRequest request);
///
/// Imports client branding. Client branding allows you to customize your WorkSpace's
/// client login portal. You can tailor your login portal company logo, the support email
/// address, support link, link to reset password, and a custom message for users trying
/// to sign in.
///
///
///
/// After you import client branding, the default branding experience for the specified
/// platform type is replaced with the imported experience
///
/// -
///
/// You must specify at least one platform type when importing client branding.
///
///
-
///
/// You can import up to 6 MB of data with each request. If your request exceeds this
/// limit, you can import client branding for different platform types using separate
/// requests.
///
///
-
///
/// In each platform type, the
SupportEmail
and SupportLink
/// parameters are mutually exclusive. You can specify only one parameter for each platform
/// type, but not both.
///
/// -
///
/// Imported data can take up to a minute to appear in the WorkSpaces client.
///
///
///
/// Container for the necessary parameters to execute the ImportClientBranding service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ImportClientBranding service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for ImportClientBranding Operation
Task ImportClientBrandingAsync(ImportClientBrandingRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ImportWorkspaceImage
///
/// Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon
/// WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your
/// Amazon Web Services account, and you must own the image. For more information about
/// creating BYOL images, see
/// Bring Your Own Windows Desktop Licenses.
///
/// Container for the necessary parameters to execute the ImportWorkspaceImage service method.
///
/// The response from the ImportWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for ImportWorkspaceImage Operation
ImportWorkspaceImageResponse ImportWorkspaceImage(ImportWorkspaceImageRequest request);
///
/// Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon
/// WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your
/// Amazon Web Services account, and you must own the image. For more information about
/// creating BYOL images, see
/// Bring Your Own Windows Desktop Licenses.
///
/// Container for the necessary parameters to execute the ImportWorkspaceImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ImportWorkspaceImage service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The specified resource already exists.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for ImportWorkspaceImage Operation
Task ImportWorkspaceImageAsync(ImportWorkspaceImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListAvailableManagementCidrRanges
///
/// 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).
///
///
///
///
/// This operation can be run only by Amazon Web Services accounts that are enabled for
/// BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException
/// error.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListAvailableManagementCidrRanges service method.
///
/// The response from the ListAvailableManagementCidrRanges service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
/// REST API Reference for ListAvailableManagementCidrRanges Operation
ListAvailableManagementCidrRangesResponse ListAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request);
///
/// 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).
///
///
///
///
/// This operation can be run only by Amazon Web Services accounts that are enabled for
/// BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException
/// error.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListAvailableManagementCidrRanges service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListAvailableManagementCidrRanges service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
/// REST API Reference for ListAvailableManagementCidrRanges Operation
Task ListAvailableManagementCidrRangesAsync(ListAvailableManagementCidrRangesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region MigrateWorkspace
///
/// Migrates a WorkSpace from one operating system or bundle type to another, while retaining
/// the data on the user volume.
///
///
///
/// The migration process recreates the WorkSpace by using a new root volume from the
/// target bundle image and the user volume from the last available snapshot of the original
/// WorkSpace. During migration, the original D:\Users\%USERNAME%
user profile
/// folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A
/// new D:\Users\%USERNAME%\
folder is generated by the new OS. Certain files
/// in the old user profile are moved to the new user profile.
///
///
///
/// For available migration scenarios, details about what happens during migration, and
/// best practices, see Migrate
/// a WorkSpace.
///
///
/// Container for the necessary parameters to execute the MigrateWorkspace service method.
///
/// The response from the MigrateWorkspace service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The properties of this WorkSpace are currently being modified. Try again in a moment.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for MigrateWorkspace Operation
MigrateWorkspaceResponse MigrateWorkspace(MigrateWorkspaceRequest request);
///
/// Migrates a WorkSpace from one operating system or bundle type to another, while retaining
/// the data on the user volume.
///
///
///
/// The migration process recreates the WorkSpace by using a new root volume from the
/// target bundle image and the user volume from the last available snapshot of the original
/// WorkSpace. During migration, the original D:\Users\%USERNAME%
user profile
/// folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A
/// new D:\Users\%USERNAME%\
folder is generated by the new OS. Certain files
/// in the old user profile are moved to the new user profile.
///
///
///
/// For available migration scenarios, details about what happens during migration, and
/// best practices, see Migrate
/// a WorkSpace.
///
///
/// Container for the necessary parameters to execute the MigrateWorkspace service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the MigrateWorkspace service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The properties of this WorkSpace are currently being modified. Try again in a moment.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for MigrateWorkspace Operation
Task MigrateWorkspaceAsync(MigrateWorkspaceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyAccount
///
/// Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
///
/// Container for the necessary parameters to execute the ModifyAccount service method.
///
/// The response from the ModifyAccount service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for ModifyAccount Operation
ModifyAccountResponse ModifyAccount(ModifyAccountRequest request);
///
/// Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
///
/// Container for the necessary parameters to execute the ModifyAccount service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyAccount service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for ModifyAccount Operation
Task ModifyAccountAsync(ModifyAccountRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyCertificateBasedAuthProperties
///
/// Modifies the properties of the certificate-based authentication you want to use with
/// your WorkSpaces.
///
/// Container for the necessary parameters to execute the ModifyCertificateBasedAuthProperties service method.
///
/// The response from the ModifyCertificateBasedAuthProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyCertificateBasedAuthProperties Operation
ModifyCertificateBasedAuthPropertiesResponse ModifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest request);
///
/// Modifies the properties of the certificate-based authentication you want to use with
/// your WorkSpaces.
///
/// Container for the necessary parameters to execute the ModifyCertificateBasedAuthProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyCertificateBasedAuthProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyCertificateBasedAuthProperties Operation
Task ModifyCertificateBasedAuthPropertiesAsync(ModifyCertificateBasedAuthPropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyClientProperties
///
/// Modifies the properties of the specified Amazon WorkSpaces clients.
///
/// Container for the necessary parameters to execute the ModifyClientProperties service method.
///
/// The response from the ModifyClientProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyClientProperties Operation
ModifyClientPropertiesResponse ModifyClientProperties(ModifyClientPropertiesRequest request);
///
/// Modifies the properties of the specified Amazon WorkSpaces clients.
///
/// Container for the necessary parameters to execute the ModifyClientProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyClientProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyClientProperties Operation
Task ModifyClientPropertiesAsync(ModifyClientPropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifySamlProperties
///
/// Modifies multiple properties related to SAML 2.0 authentication, including the enablement
/// status, user access URL, and relay state parameter name that are used for configuring
/// federation with an SAML 2.0 identity provider.
///
/// Container for the necessary parameters to execute the ModifySamlProperties service method.
///
/// The response from the ModifySamlProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifySamlProperties Operation
ModifySamlPropertiesResponse ModifySamlProperties(ModifySamlPropertiesRequest request);
///
/// Modifies multiple properties related to SAML 2.0 authentication, including the enablement
/// status, user access URL, and relay state parameter name that are used for configuring
/// federation with an SAML 2.0 identity provider.
///
/// Container for the necessary parameters to execute the ModifySamlProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifySamlProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifySamlProperties Operation
Task ModifySamlPropertiesAsync(ModifySamlPropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifySelfservicePermissions
///
/// Modifies the self-service WorkSpace management capabilities for your users. For more
/// information, see Enable
/// Self-Service WorkSpace Management Capabilities for Your Users.
///
/// Container for the necessary parameters to execute the ModifySelfservicePermissions service method.
///
/// The response from the ModifySelfservicePermissions service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifySelfservicePermissions Operation
ModifySelfservicePermissionsResponse ModifySelfservicePermissions(ModifySelfservicePermissionsRequest request);
///
/// Modifies the self-service WorkSpace management capabilities for your users. For more
/// information, see Enable
/// Self-Service WorkSpace Management Capabilities for Your Users.
///
/// Container for the necessary parameters to execute the ModifySelfservicePermissions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifySelfservicePermissions service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifySelfservicePermissions Operation
Task ModifySelfservicePermissionsAsync(ModifySelfservicePermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyWorkspaceAccessProperties
///
/// Specifies which devices and operating systems users can use to access their WorkSpaces.
/// For more information, see
/// Control Device Access.
///
/// Container for the necessary parameters to execute the ModifyWorkspaceAccessProperties service method.
///
/// The response from the ModifyWorkspaceAccessProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyWorkspaceAccessProperties Operation
ModifyWorkspaceAccessPropertiesResponse ModifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest request);
///
/// Specifies which devices and operating systems users can use to access their WorkSpaces.
/// For more information, see
/// Control Device Access.
///
/// Container for the necessary parameters to execute the ModifyWorkspaceAccessProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyWorkspaceAccessProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyWorkspaceAccessProperties Operation
Task ModifyWorkspaceAccessPropertiesAsync(ModifyWorkspaceAccessPropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyWorkspaceCreationProperties
///
/// Modify the default properties used to create WorkSpaces.
///
/// Container for the necessary parameters to execute the ModifyWorkspaceCreationProperties service method.
///
/// The response from the ModifyWorkspaceCreationProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyWorkspaceCreationProperties Operation
ModifyWorkspaceCreationPropertiesResponse ModifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest request);
///
/// Modify the default properties used to create WorkSpaces.
///
/// Container for the necessary parameters to execute the ModifyWorkspaceCreationProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyWorkspaceCreationProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyWorkspaceCreationProperties Operation
Task ModifyWorkspaceCreationPropertiesAsync(ModifyWorkspaceCreationPropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyWorkspaceProperties
///
/// Modifies the specified WorkSpace properties. For important information about how to
/// modify the size of the root and user volumes, see
/// Modify a WorkSpace.
///
///
///
/// The MANUAL
running mode value is only supported by Amazon WorkSpaces
/// Core. Contact your account team to be allow-listed to use this value. For more information,
/// see Amazon WorkSpaces Core.
///
///
///
/// Container for the necessary parameters to execute the ModifyWorkspaceProperties service method.
///
/// The response from the ModifyWorkspaceProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The properties of this WorkSpace are currently being modified. Try again in a moment.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
///
/// The configuration of this WorkSpace is not supported for this operation. For more
/// information, see Required
/// Configuration and Service Components for WorkSpaces .
///
/// REST API Reference for ModifyWorkspaceProperties Operation
ModifyWorkspacePropertiesResponse ModifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request);
///
/// Modifies the specified WorkSpace properties. For important information about how to
/// modify the size of the root and user volumes, see
/// Modify a WorkSpace.
///
///
///
/// The MANUAL
running mode value is only supported by Amazon WorkSpaces
/// Core. Contact your account team to be allow-listed to use this value. For more information,
/// see Amazon WorkSpaces Core.
///
///
///
/// Container for the necessary parameters to execute the ModifyWorkspaceProperties service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyWorkspaceProperties service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The properties of this WorkSpace are currently being modified. Try again in a moment.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
///
/// The configuration of this WorkSpace is not supported for this operation. For more
/// information, see Required
/// Configuration and Service Components for WorkSpaces .
///
/// REST API Reference for ModifyWorkspaceProperties Operation
Task ModifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyWorkspaceState
///
/// Sets the state of the specified WorkSpace.
///
///
///
/// To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE
.
/// 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 ADMIN_MAINTENANCE
state.
///
///
/// Container for the necessary parameters to execute the ModifyWorkspaceState service method.
///
/// The response from the ModifyWorkspaceState service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyWorkspaceState Operation
ModifyWorkspaceStateResponse ModifyWorkspaceState(ModifyWorkspaceStateRequest request);
///
/// Sets the state of the specified WorkSpace.
///
///
///
/// To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE
.
/// 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 ADMIN_MAINTENANCE
state.
///
///
/// Container for the necessary parameters to execute the ModifyWorkspaceState service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyWorkspaceState service method, as returned by WorkSpaces.
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for ModifyWorkspaceState Operation
Task ModifyWorkspaceStateAsync(ModifyWorkspaceStateRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RebootWorkspaces
///
/// Reboots the specified WorkSpaces.
///
///
///
/// You cannot reboot a WorkSpace unless its state is AVAILABLE
or UNHEALTHY
.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces have rebooted.
///
///
/// Container for the necessary parameters to execute the RebootWorkspaces service method.
///
/// The response from the RebootWorkspaces service method, as returned by WorkSpaces.
///
/// This operation is not supported.
///
/// REST API Reference for RebootWorkspaces Operation
RebootWorkspacesResponse RebootWorkspaces(RebootWorkspacesRequest request);
///
/// Reboots the specified WorkSpaces.
///
///
///
/// You cannot reboot a WorkSpace unless its state is AVAILABLE
or UNHEALTHY
.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces have rebooted.
///
///
/// Container for the necessary parameters to execute the RebootWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RebootWorkspaces service method, as returned by WorkSpaces.
///
/// This operation is not supported.
///
/// REST API Reference for RebootWorkspaces Operation
Task RebootWorkspacesAsync(RebootWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RebuildWorkspaces
///
/// Rebuilds the specified WorkSpace.
///
///
///
/// You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
,
/// UNHEALTHY
, STOPPED
, or REBOOTING
.
///
///
///
/// Rebuilding a WorkSpace is a potentially destructive action that can result in the
/// loss of data. For more information, see Rebuild
/// a WorkSpace.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces have been completely
/// rebuilt.
///
///
/// Container for the necessary parameters to execute the RebuildWorkspaces service method.
///
/// The response from the RebuildWorkspaces service method, as returned by WorkSpaces.
///
/// This operation is not supported.
///
/// REST API Reference for RebuildWorkspaces Operation
RebuildWorkspacesResponse RebuildWorkspaces(RebuildWorkspacesRequest request);
///
/// Rebuilds the specified WorkSpace.
///
///
///
/// You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
,
/// UNHEALTHY
, STOPPED
, or REBOOTING
.
///
///
///
/// Rebuilding a WorkSpace is a potentially destructive action that can result in the
/// loss of data. For more information, see Rebuild
/// a WorkSpace.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces have been completely
/// rebuilt.
///
///
/// Container for the necessary parameters to execute the RebuildWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RebuildWorkspaces service method, as returned by WorkSpaces.
///
/// This operation is not supported.
///
/// REST API Reference for RebuildWorkspaces Operation
Task RebuildWorkspacesAsync(RebuildWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RegisterWorkspaceDirectory
///
/// Registers the specified directory. This operation is asynchronous and returns before
/// the WorkSpace directory is registered. If this is the first time you are registering
/// a directory, you will need to create the workspaces_DefaultRole role before you can
/// register a directory. For more information, see
/// Creating the workspaces_DefaultRole Role.
///
/// Container for the necessary parameters to execute the RegisterWorkspaceDirectory service method.
///
/// The response from the RegisterWorkspaceDirectory service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
///
/// The configuration of this network is not supported for this operation, or your network
/// configuration conflicts with the Amazon WorkSpaces management network IP range. For
/// more information, see
/// Configure a VPC for Amazon WorkSpaces.
///
///
/// The workspaces_DefaultRole role could not be found. If this is the first time you
/// are registering a directory, you will need to create the workspaces_DefaultRole role
/// before you can register a directory. For more information, see Creating
/// the workspaces_DefaultRole Role.
///
/// REST API Reference for RegisterWorkspaceDirectory Operation
RegisterWorkspaceDirectoryResponse RegisterWorkspaceDirectory(RegisterWorkspaceDirectoryRequest request);
///
/// Registers the specified directory. This operation is asynchronous and returns before
/// the WorkSpace directory is registered. If this is the first time you are registering
/// a directory, you will need to create the workspaces_DefaultRole role before you can
/// register a directory. For more information, see
/// Creating the workspaces_DefaultRole Role.
///
/// Container for the necessary parameters to execute the RegisterWorkspaceDirectory service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RegisterWorkspaceDirectory service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
///
/// The configuration of this network is not supported for this operation, or your network
/// configuration conflicts with the Amazon WorkSpaces management network IP range. For
/// more information, see
/// Configure a VPC for Amazon WorkSpaces.
///
///
/// The workspaces_DefaultRole role could not be found. If this is the first time you
/// are registering a directory, you will need to create the workspaces_DefaultRole role
/// before you can register a directory. For more information, see Creating
/// the workspaces_DefaultRole Role.
///
/// REST API Reference for RegisterWorkspaceDirectory Operation
Task RegisterWorkspaceDirectoryAsync(RegisterWorkspaceDirectoryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RestoreWorkspace
///
/// Restores the specified WorkSpace to its last known healthy state.
///
///
///
/// You cannot restore a WorkSpace unless its state is AVAILABLE
, ERROR
,
/// UNHEALTHY
, or STOPPED
.
///
///
///
/// Restoring a WorkSpace is a potentially destructive action that can result in the loss
/// of data. For more information, see Restore
/// a WorkSpace.
///
///
///
/// This operation is asynchronous and returns before the WorkSpace is completely restored.
///
///
/// Container for the necessary parameters to execute the RestoreWorkspace service method.
///
/// The response from the RestoreWorkspace service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for RestoreWorkspace Operation
RestoreWorkspaceResponse RestoreWorkspace(RestoreWorkspaceRequest request);
///
/// Restores the specified WorkSpace to its last known healthy state.
///
///
///
/// You cannot restore a WorkSpace unless its state is AVAILABLE
, ERROR
,
/// UNHEALTHY
, or STOPPED
.
///
///
///
/// Restoring a WorkSpace is a potentially destructive action that can result in the loss
/// of data. For more information, see Restore
/// a WorkSpace.
///
///
///
/// This operation is asynchronous and returns before the WorkSpace is completely restored.
///
///
/// Container for the necessary parameters to execute the RestoreWorkspace service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RestoreWorkspace service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
/// REST API Reference for RestoreWorkspace Operation
Task RestoreWorkspaceAsync(RestoreWorkspaceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RevokeIpRules
///
/// Removes one or more rules from the specified IP access control group.
///
/// Container for the necessary parameters to execute the RevokeIpRules service method.
///
/// The response from the RevokeIpRules service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource could not be found.
///
/// REST API Reference for RevokeIpRules Operation
RevokeIpRulesResponse RevokeIpRules(RevokeIpRulesRequest request);
///
/// Removes one or more rules from the specified IP access control group.
///
/// Container for the necessary parameters to execute the RevokeIpRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RevokeIpRules service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// The resource could not be found.
///
/// REST API Reference for RevokeIpRules Operation
Task RevokeIpRulesAsync(RevokeIpRulesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartWorkspaces
///
/// Starts the specified WorkSpaces.
///
///
///
/// You cannot start a WorkSpace unless it has a running mode of AutoStop
/// and a state of STOPPED
.
///
///
/// Container for the necessary parameters to execute the StartWorkspaces service method.
///
/// The response from the StartWorkspaces service method, as returned by WorkSpaces.
/// REST API Reference for StartWorkspaces Operation
StartWorkspacesResponse StartWorkspaces(StartWorkspacesRequest request);
///
/// Starts the specified WorkSpaces.
///
///
///
/// You cannot start a WorkSpace unless it has a running mode of AutoStop
/// and a state of STOPPED
.
///
///
/// Container for the necessary parameters to execute the StartWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartWorkspaces service method, as returned by WorkSpaces.
/// REST API Reference for StartWorkspaces Operation
Task StartWorkspacesAsync(StartWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopWorkspaces
///
/// Stops the specified WorkSpaces.
///
///
///
/// You cannot stop a WorkSpace unless it has a running mode of AutoStop
/// and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
,
/// or ERROR
.
///
///
/// Container for the necessary parameters to execute the StopWorkspaces service method.
///
/// The response from the StopWorkspaces service method, as returned by WorkSpaces.
/// REST API Reference for StopWorkspaces Operation
StopWorkspacesResponse StopWorkspaces(StopWorkspacesRequest request);
///
/// Stops the specified WorkSpaces.
///
///
///
/// You cannot stop a WorkSpace unless it has a running mode of AutoStop
/// and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
,
/// or ERROR
.
///
///
/// Container for the necessary parameters to execute the StopWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopWorkspaces service method, as returned by WorkSpaces.
/// REST API Reference for StopWorkspaces Operation
Task StopWorkspacesAsync(StopWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TerminateWorkspaces
///
/// Terminates the specified WorkSpaces.
///
///
///
/// Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
/// is destroyed. If you need to archive any user data, contact Amazon Web Services Support
/// before terminating the WorkSpace.
///
///
///
/// You can terminate a WorkSpace that is in any state except SUSPENDED
.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces have been completely
/// terminated. After a WorkSpace is terminated, the TERMINATED
state is
/// returned only briefly before the WorkSpace directory metadata is cleaned up, so this
/// state is rarely returned. To confirm that a WorkSpace is terminated, check for the
/// WorkSpace ID by using
/// DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has
/// been successfully terminated.
///
///
///
/// Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces.
/// If there are no WorkSpaces being used with your Simple AD or AD Connector directory
/// for 30 consecutive days, this directory will be automatically deregistered for use
/// with Amazon WorkSpaces, and you will be charged for this directory as per the Directory
/// Service pricing terms.
///
///
///
/// To delete empty directories, see
/// Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector
/// directory, you can always create a new one when you want to start using WorkSpaces
/// again.
///
///
///
/// Container for the necessary parameters to execute the TerminateWorkspaces service method.
///
/// The response from the TerminateWorkspaces service method, as returned by WorkSpaces.
/// REST API Reference for TerminateWorkspaces Operation
TerminateWorkspacesResponse TerminateWorkspaces(TerminateWorkspacesRequest request);
///
/// Terminates the specified WorkSpaces.
///
///
///
/// Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
/// is destroyed. If you need to archive any user data, contact Amazon Web Services Support
/// before terminating the WorkSpace.
///
///
///
/// You can terminate a WorkSpace that is in any state except SUSPENDED
.
///
///
///
/// This operation is asynchronous and returns before the WorkSpaces have been completely
/// terminated. After a WorkSpace is terminated, the TERMINATED
state is
/// returned only briefly before the WorkSpace directory metadata is cleaned up, so this
/// state is rarely returned. To confirm that a WorkSpace is terminated, check for the
/// WorkSpace ID by using
/// DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has
/// been successfully terminated.
///
///
///
/// Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces.
/// If there are no WorkSpaces being used with your Simple AD or AD Connector directory
/// for 30 consecutive days, this directory will be automatically deregistered for use
/// with Amazon WorkSpaces, and you will be charged for this directory as per the Directory
/// Service pricing terms.
///
///
///
/// To delete empty directories, see
/// Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector
/// directory, you can always create a new one when you want to start using WorkSpaces
/// again.
///
///
///
/// Container for the necessary parameters to execute the TerminateWorkspaces service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TerminateWorkspaces service method, as returned by WorkSpaces.
/// REST API Reference for TerminateWorkspaces Operation
Task TerminateWorkspacesAsync(TerminateWorkspacesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateConnectClientAddIn
///
/// Updates a Amazon Connect client add-in. Use this action to update the name and endpoint
/// URL of a Amazon Connect client add-in.
///
/// Container for the necessary parameters to execute the UpdateConnectClientAddIn service method.
///
/// The response from the UpdateConnectClientAddIn service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for UpdateConnectClientAddIn Operation
UpdateConnectClientAddInResponse UpdateConnectClientAddIn(UpdateConnectClientAddInRequest request);
///
/// Updates a Amazon Connect client add-in. Use this action to update the name and endpoint
/// URL of a Amazon Connect client add-in.
///
/// Container for the necessary parameters to execute the UpdateConnectClientAddIn service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateConnectClientAddIn service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The resource could not be found.
///
/// REST API Reference for UpdateConnectClientAddIn Operation
Task UpdateConnectClientAddInAsync(UpdateConnectClientAddInRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateConnectionAliasPermission
///
/// Shares or unshares a connection alias with one account by specifying whether that
/// account has permission to associate the connection alias with a directory. If the
/// association permission is granted, the connection alias is shared with that account.
/// If the association permission is revoked, the connection alias is unshared with the
/// account. For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// -
///
/// Before performing this operation, call
/// DescribeConnectionAliases to make sure that the current state of the connection
/// alias is
CREATED
.
///
/// -
///
/// To delete a connection alias that has been shared, the shared account must first disassociate
/// the connection alias from any directories it has been associated with. Then you must
/// unshare the connection alias from the account it has been shared with. You can delete
/// a connection alias only after it is no longer shared with any accounts or associated
/// with any directories.
///
///
///
/// Container for the necessary parameters to execute the UpdateConnectionAliasPermission service method.
///
/// The response from the UpdateConnectionAliasPermission service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource is associated with a directory.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for UpdateConnectionAliasPermission Operation
UpdateConnectionAliasPermissionResponse UpdateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest request);
///
/// Shares or unshares a connection alias with one account by specifying whether that
/// account has permission to associate the connection alias with a directory. If the
/// association permission is granted, the connection alias is shared with that account.
/// If the association permission is revoked, the connection alias is unshared with the
/// account. For more information, see
/// Cross-Region Redirection for Amazon WorkSpaces.
///
/// -
///
/// Before performing this operation, call
/// DescribeConnectionAliases to make sure that the current state of the connection
/// alias is
CREATED
.
///
/// -
///
/// To delete a connection alias that has been shared, the shared account must first disassociate
/// the connection alias from any directories it has been associated with. Then you must
/// unshare the connection alias from the account it has been shared with. You can delete
/// a connection alias only after it is no longer shared with any accounts or associated
/// with any directories.
///
///
///
/// Container for the necessary parameters to execute the UpdateConnectionAliasPermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateConnectionAliasPermission service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// This operation is not supported.
///
///
/// The resource is associated with a directory.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for UpdateConnectionAliasPermission Operation
Task UpdateConnectionAliasPermissionAsync(UpdateConnectionAliasPermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateRulesOfIpGroup
///
/// Replaces the current rules of the specified IP access control group with the specified
/// rules.
///
/// Container for the necessary parameters to execute the UpdateRulesOfIpGroup service method.
///
/// The response from the UpdateRulesOfIpGroup service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for UpdateRulesOfIpGroup Operation
UpdateRulesOfIpGroupResponse UpdateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request);
///
/// Replaces the current rules of the specified IP access control group with the specified
/// rules.
///
/// Container for the necessary parameters to execute the UpdateRulesOfIpGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateRulesOfIpGroup service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// The state of the resource is not valid for this operation.
///
///
/// Your resource limits have been exceeded.
///
///
/// The resource could not be found.
///
/// REST API Reference for UpdateRulesOfIpGroup Operation
Task UpdateRulesOfIpGroupAsync(UpdateRulesOfIpGroupRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateWorkspaceBundle
///
/// Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace
/// bundles, see
/// Update a Custom WorkSpaces Bundle.
///
///
///
/// Existing WorkSpaces aren't automatically updated when you update the bundle that they're
/// based on. To update existing WorkSpaces that are based on a bundle that you've updated,
/// you must either rebuild the WorkSpaces or delete and recreate them.
///
///
///
/// Container for the necessary parameters to execute the UpdateWorkspaceBundle service method.
///
/// The response from the UpdateWorkspaceBundle service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for UpdateWorkspaceBundle Operation
UpdateWorkspaceBundleResponse UpdateWorkspaceBundle(UpdateWorkspaceBundleRequest request);
///
/// Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace
/// bundles, see
/// Update a Custom WorkSpaces Bundle.
///
///
///
/// Existing WorkSpaces aren't automatically updated when you update the bundle that they're
/// based on. To update existing WorkSpaces that are based on a bundle that you've updated,
/// you must either rebuild the WorkSpaces or delete and recreate them.
///
///
///
/// Container for the necessary parameters to execute the UpdateWorkspaceBundle service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateWorkspaceBundle service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for UpdateWorkspaceBundle Operation
Task UpdateWorkspaceBundleAsync(UpdateWorkspaceBundleRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateWorkspaceImagePermission
///
/// Shares or unshares an image with one account in the same Amazon Web Services Region
/// by specifying whether that account has permission to copy the image. If the copy image
/// permission is granted, the image is shared with that account. If the copy image permission
/// is revoked, the image is unshared with the account.
///
///
///
/// After an image has been shared, the recipient account can copy the image to other
/// Regions as needed.
///
///
///
/// In the China (Ningxia) Region, you can copy images only within the same Region.
///
///
///
/// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact
/// Amazon Web Services Support.
///
///
///
/// For more information about sharing images, see
/// Share or Unshare a Custom WorkSpaces Image.
///
/// -
///
/// To delete an image that has been shared, you must unshare the image before you delete
/// it.
///
///
-
///
/// Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't
/// supported at this time in Amazon Web Services GovCloud (US). To share BYOL images
/// across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services
/// Support.
///
///
///
/// Container for the necessary parameters to execute the UpdateWorkspaceImagePermission service method.
///
/// The response from the UpdateWorkspaceImagePermission service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for UpdateWorkspaceImagePermission Operation
UpdateWorkspaceImagePermissionResponse UpdateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest request);
///
/// Shares or unshares an image with one account in the same Amazon Web Services Region
/// by specifying whether that account has permission to copy the image. If the copy image
/// permission is granted, the image is shared with that account. If the copy image permission
/// is revoked, the image is unshared with the account.
///
///
///
/// After an image has been shared, the recipient account can copy the image to other
/// Regions as needed.
///
///
///
/// In the China (Ningxia) Region, you can copy images only within the same Region.
///
///
///
/// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact
/// Amazon Web Services Support.
///
///
///
/// For more information about sharing images, see
/// Share or Unshare a Custom WorkSpaces Image.
///
/// -
///
/// To delete an image that has been shared, you must unshare the image before you delete
/// it.
///
///
-
///
/// Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't
/// supported at this time in Amazon Web Services GovCloud (US). To share BYOL images
/// across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services
/// Support.
///
///
///
/// Container for the necessary parameters to execute the UpdateWorkspaceImagePermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateWorkspaceImagePermission service method, as returned by WorkSpaces.
///
/// The user is not authorized to access a resource.
///
///
/// One or more parameter values are not valid.
///
///
/// This operation is not supported.
///
///
/// The resource could not be found.
///
///
/// The specified resource is not available.
///
/// REST API Reference for UpdateWorkspaceImagePermission Operation
Task UpdateWorkspaceImagePermissionAsync(UpdateWorkspaceImagePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}