Struct rusoto_workspaces::WorkspacesClient

pub struct WorkspacesClient { /* fields omitted */ }

A client for the Amazon WorkSpaces API.

Implementations

impl WorkspacesClient

pub fn new(region: Region) -> WorkspacesClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> WorkspacesClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> WorkspacesClient

Trait Implementations

impl Clone for WorkspacesClient

pub fn clone(&self) -> WorkspacesClient

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Workspaces for WorkspacesClient

pub fn associate_ip_groups<'life0, 'async_trait>(
    &'life0 self,
    input: AssociateIpGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<AssociateIpGroupsResult, RusotoError<AssociateIpGroupsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Associates the specified IP access control group with the specified directory.

pub fn authorize_ip_rules<'life0, 'async_trait>(
    &'life0 self,
    input: AuthorizeIpRulesRequest
) -> Pin<Box<dyn Future<Output = Result<AuthorizeIpRulesResult, RusotoError<AuthorizeIpRulesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn copy_workspace_image<'life0, 'async_trait>(
    &'life0 self,
    input: CopyWorkspaceImageRequest
) -> Pin<Box<dyn Future<Output = Result<CopyWorkspaceImageResult, RusotoError<CopyWorkspaceImageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Copies the specified image from the specified Region to the current Region.

pub fn create_ip_group<'life0, 'async_trait>(
    &'life0 self,
    input: CreateIpGroupRequest
) -> Pin<Box<dyn Future<Output = Result<CreateIpGroupResult, RusotoError<CreateIpGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn create_tags<'life0, 'async_trait>(
    &'life0 self,
    input: CreateTagsRequest
) -> Pin<Box<dyn Future<Output = Result<CreateTagsResult, RusotoError<CreateTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates the specified tags for the specified WorkSpaces resource.

pub fn create_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: CreateWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<CreateWorkspacesResult, RusotoError<CreateWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

pub fn delete_ip_group<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteIpGroupRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteIpGroupResult, RusotoError<DeleteIpGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

pub fn delete_tags<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteTagsRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteTagsResult, RusotoError<DeleteTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the specified tags from the specified WorkSpaces resource.

pub fn delete_workspace_image<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteWorkspaceImageRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteWorkspaceImageResult, RusotoError<DeleteWorkspaceImageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.

pub fn deregister_workspace_directory<'life0, 'async_trait>(
    &'life0 self,
    input: DeregisterWorkspaceDirectoryRequest
) -> Pin<Box<dyn Future<Output = Result<DeregisterWorkspaceDirectoryResult, RusotoError<DeregisterWorkspaceDirectoryError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn describe_account<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<DescribeAccountResult, RusotoError<DescribeAccountError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

pub fn describe_account_modifications<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeAccountModificationsRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeAccountModificationsResult, RusotoError<DescribeAccountModificationsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

pub fn describe_client_properties<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeClientPropertiesRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeClientPropertiesResult, RusotoError<DescribeClientPropertiesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

pub fn describe_ip_groups<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeIpGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeIpGroupsResult, RusotoError<DescribeIpGroupsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes one or more of your IP access control groups.

pub fn describe_tags<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeTagsRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeTagsResult, RusotoError<DescribeTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the specified tags for the specified WorkSpaces resource.

pub fn describe_workspace_bundles<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeWorkspaceBundlesRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeWorkspaceBundlesResult, RusotoError<DescribeWorkspaceBundlesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

pub fn describe_workspace_directories<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeWorkspaceDirectoriesRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeWorkspaceDirectoriesResult, RusotoError<DescribeWorkspaceDirectoriesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the available directories that are registered with Amazon WorkSpaces.

pub fn describe_workspace_images<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeWorkspaceImagesRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeWorkspaceImagesResult, RusotoError<DescribeWorkspaceImagesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

pub fn describe_workspace_snapshots<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeWorkspaceSnapshotsRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeWorkspaceSnapshotsResult, RusotoError<DescribeWorkspaceSnapshotsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the snapshots for the specified WorkSpace.

pub fn describe_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeWorkspacesResult, RusotoError<DescribeWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn describe_workspaces_connection_status<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeWorkspacesConnectionStatusRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeWorkspacesConnectionStatusResult, RusotoError<DescribeWorkspacesConnectionStatusError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the connection status of the specified WorkSpaces.

pub fn disassociate_ip_groups<'life0, 'async_trait>(
    &'life0 self,
    input: DisassociateIpGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<DisassociateIpGroupsResult, RusotoError<DisassociateIpGroupsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Disassociates the specified IP access control group from the specified directory.

pub fn import_workspace_image<'life0, 'async_trait>(
    &'life0 self,
    input: ImportWorkspaceImageRequest
) -> Pin<Box<dyn Future<Output = Result<ImportWorkspaceImageResult, RusotoError<ImportWorkspaceImageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.

pub fn list_available_management_cidr_ranges<'life0, 'async_trait>(
    &'life0 self,
    input: ListAvailableManagementCidrRangesRequest
) -> Pin<Box<dyn Future<Output = Result<ListAvailableManagementCidrRangesResult, RusotoError<ListAvailableManagementCidrRangesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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).

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.

pub fn migrate_workspace<'life0, 'async_trait>(
    &'life0 self,
    input: MigrateWorkspaceRequest
) -> Pin<Box<dyn Future<Output = Result<MigrateWorkspaceResult, RusotoError<MigrateWorkspaceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn modify_account<'life0, 'async_trait>(
    &'life0 self,
    input: ModifyAccountRequest
) -> Pin<Box<dyn Future<Output = Result<ModifyAccountResult, RusotoError<ModifyAccountError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

pub fn modify_client_properties<'life0, 'async_trait>(
    &'life0 self,
    input: ModifyClientPropertiesRequest
) -> Pin<Box<dyn Future<Output = Result<ModifyClientPropertiesResult, RusotoError<ModifyClientPropertiesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Modifies the properties of the specified Amazon WorkSpaces clients.

pub fn modify_selfservice_permissions<'life0, 'async_trait>(
    &'life0 self,
    input: ModifySelfservicePermissionsRequest
) -> Pin<Box<dyn Future<Output = Result<ModifySelfservicePermissionsResult, RusotoError<ModifySelfservicePermissionsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

pub fn modify_workspace_access_properties<'life0, 'async_trait>(
    &'life0 self,
    input: ModifyWorkspaceAccessPropertiesRequest
) -> Pin<Box<dyn Future<Output = Result<ModifyWorkspaceAccessPropertiesResult, RusotoError<ModifyWorkspaceAccessPropertiesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

pub fn modify_workspace_creation_properties<'life0, 'async_trait>(
    &'life0 self,
    input: ModifyWorkspaceCreationPropertiesRequest
) -> Pin<Box<dyn Future<Output = Result<ModifyWorkspaceCreationPropertiesResult, RusotoError<ModifyWorkspaceCreationPropertiesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Modify the default properties used to create WorkSpaces.

pub fn modify_workspace_properties<'life0, 'async_trait>(
    &'life0 self,
    input: ModifyWorkspacePropertiesRequest
) -> Pin<Box<dyn Future<Output = Result<ModifyWorkspacePropertiesResult, RusotoError<ModifyWorkspacePropertiesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Modifies the specified WorkSpace properties.

pub fn modify_workspace_state<'life0, 'async_trait>(
    &'life0 self,
    input: ModifyWorkspaceStateRequest
) -> Pin<Box<dyn Future<Output = Result<ModifyWorkspaceStateResult, RusotoError<ModifyWorkspaceStateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn reboot_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: RebootWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<RebootWorkspacesResult, RusotoError<RebootWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn rebuild_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: RebuildWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<RebuildWorkspacesResult, RusotoError<RebuildWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

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.

pub fn register_workspace_directory<'life0, 'async_trait>(
    &'life0 self,
    input: RegisterWorkspaceDirectoryRequest
) -> Pin<Box<dyn Future<Output = Result<RegisterWorkspaceDirectoryResult, RusotoError<RegisterWorkspaceDirectoryError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn restore_workspace<'life0, 'async_trait>(
    &'life0 self,
    input: RestoreWorkspaceRequest
) -> Pin<Box<dyn Future<Output = Result<RestoreWorkspaceResult, RusotoError<RestoreWorkspaceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn revoke_ip_rules<'life0, 'async_trait>(
    &'life0 self,
    input: RevokeIpRulesRequest
) -> Pin<Box<dyn Future<Output = Result<RevokeIpRulesResult, RusotoError<RevokeIpRulesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Removes one or more rules from the specified IP access control group.

pub fn start_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: StartWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<StartWorkspacesResult, RusotoError<StartWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.

pub fn stop_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: StopWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<StopWorkspacesResult, RusotoError<StopWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn terminate_workspaces<'life0, 'async_trait>(
    &'life0 self,
    input: TerminateWorkspacesRequest
) -> Pin<Box<dyn Future<Output = Result<TerminateWorkspacesResult, RusotoError<TerminateWorkspacesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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 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.

pub fn update_rules_of_ip_group<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateRulesOfIpGroupRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateRulesOfIpGroupResult, RusotoError<UpdateRulesOfIpGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Replaces the current rules of the specified IP access control group with the specified rules.