Struct aws_sdk_workspaces::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Client for Amazon WorkSpaces

Client for invoking operations on Amazon WorkSpaces. Each operation on Amazon WorkSpaces is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_workspaces::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_workspaces::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_workspaces::Client::from_conf(config);

Implementations

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn associate_connection_alias(&self) -> AssociateConnectionAlias<C, M, R>

Constructs a fluent builder for the AssociateConnectionAlias operation.

• The fluent builder is configurable:
  • alias_id(impl Into<String>) / set_alias_id(Option<String>):

    The identifier of the connection alias.

  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the directory to associate the connection alias with.

• On success, responds with AssociateConnectionAliasOutput with field(s):
  • connection_identifier(Option<String>):

    The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you’re configuring your DNS routing policies.

• On failure, responds with SdkError<AssociateConnectionAliasError>

pub fn associate_ip_groups(&self) -> AssociateIpGroups<C, M, R>

Constructs a fluent builder for the AssociateIpGroups operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):

    The identifier of the directory.

  • group_ids(Vec<String>) / set_group_ids(Option<Vec<String>>):

    The identifiers of one or more IP access control groups.

• On success, responds with AssociateIpGroupsOutput
• On failure, responds with SdkError<AssociateIpGroupsError>

pub fn authorize_ip_rules(&self) -> AuthorizeIpRules<C, M, R>

Constructs a fluent builder for the AuthorizeIpRules operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>):

    The identifier of the group.

  • user_rules(Vec<IpRuleItem>) / set_user_rules(Option<Vec<IpRuleItem>>):

    The rules to add to the group.

• On success, responds with AuthorizeIpRulesOutput
• On failure, responds with SdkError<AuthorizeIpRulesError>

pub fn copy_workspace_image(&self) -> CopyWorkspaceImage<C, M, R>

Constructs a fluent builder for the CopyWorkspaceImage operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the image.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the image.

  • source_image_id(impl Into<String>) / set_source_image_id(Option<String>):

    The identifier of the source image.

  • source_region(impl Into<String>) / set_source_region(Option<String>):

    The identifier of the source Region.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags for the image.

• On success, responds with CopyWorkspaceImageOutput with field(s):
  • image_id(Option<String>):

    The identifier of the image.

• On failure, responds with SdkError<CopyWorkspaceImageError>

pub fn create_connect_client_add_in(&self) -> CreateConnectClientAddIn<C, M, R>

Constructs a fluent builder for the CreateConnectClientAddIn operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The directory identifier for which to configure the client add-in.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the client add-in.

  • url(impl Into<String>) / set_url(Option<String>):

    The endpoint URL of the Amazon Connect client add-in.

• On success, responds with CreateConnectClientAddInOutput with field(s):
  • add_in_id(Option<String>):

    The client add-in identifier.

• On failure, responds with SdkError<CreateConnectClientAddInError>

pub fn create_connection_alias(&self) -> CreateConnectionAlias<C, M, R>

Constructs a fluent builder for the CreateConnectionAlias operation.

• The fluent builder is configurable:
  • connection_string(impl Into<String>) / set_connection_string(Option<String>):

    A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

    After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags to associate with the connection alias.

• On success, responds with CreateConnectionAliasOutput with field(s):
  • alias_id(Option<String>):

    The identifier of the connection alias.

• On failure, responds with SdkError<CreateConnectionAliasError>

pub fn create_ip_group(&self) -> CreateIpGroup<C, M, R>

Constructs a fluent builder for the CreateIpGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):

    The name of the group.

  • group_desc(impl Into<String>) / set_group_desc(Option<String>):

    The description of the group.

  • user_rules(Vec<IpRuleItem>) / set_user_rules(Option<Vec<IpRuleItem>>):

    The rules to add to the group.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

• On success, responds with CreateIpGroupOutput with field(s):
  • group_id(Option<String>):

    The identifier of the group.

• On failure, responds with SdkError<CreateIpGroupError>

pub fn create_tags(&self) -> CreateTags<C, M, R>

Constructs a fluent builder for the CreateTags operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

• On success, responds with CreateTagsOutput
• On failure, responds with SdkError<CreateTagsError>

pub fn create_updated_workspace_image(
    &self
) -> CreateUpdatedWorkspaceImage<C, M, R>

Constructs a fluent builder for the CreateUpdatedWorkspaceImage operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the new updated WorkSpace image.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of whether updates for the WorkSpace image are available.

  • source_image_id(impl Into<String>) / set_source_image_id(Option<String>):

    The identifier of the source WorkSpace image.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags that you want to add to the new updated WorkSpace image.

    To add tags at the same time when you’re creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

• On success, responds with CreateUpdatedWorkspaceImageOutput with field(s):
  • image_id(Option<String>):

    The identifier of the new updated WorkSpace image.

• On failure, responds with SdkError<CreateUpdatedWorkspaceImageError>

pub fn create_workspace_bundle(&self) -> CreateWorkspaceBundle<C, M, R>

Constructs a fluent builder for the CreateWorkspaceBundle operation.

• The fluent builder is configurable:
  • bundle_name(impl Into<String>) / set_bundle_name(Option<String>):

    The name of the bundle.

  • bundle_description(impl Into<String>) / set_bundle_description(Option<String>):

    The description of the bundle.

  • image_id(impl Into<String>) / set_image_id(Option<String>):

    The identifier of the image that is used to create the bundle.

  • compute_type(ComputeType) / set_compute_type(Option<ComputeType>):

    Describes the compute type of the bundle.

  • user_storage(UserStorage) / set_user_storage(Option<UserStorage>):

    Describes the user volume for a WorkSpace bundle.

  • root_storage(RootStorage) / set_root_storage(Option<RootStorage>):

    Describes the root volume for a WorkSpace bundle.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags associated with the bundle.

    To add tags at the same time when you’re creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

• On success, responds with CreateWorkspaceBundleOutput with field(s):
  • workspace_bundle(Option<WorkspaceBundle>):

    Describes a WorkSpace bundle.

• On failure, responds with SdkError<CreateWorkspaceBundleError>

pub fn create_workspaces(&self) -> CreateWorkspaces<C, M, R>

Constructs a fluent builder for the CreateWorkspaces operation.

• The fluent builder is configurable:
  • workspaces(Vec<WorkspaceRequest>) / set_workspaces(Option<Vec<WorkspaceRequest>>):

    The WorkSpaces to create. You can specify up to 25 WorkSpaces.

• On success, responds with CreateWorkspacesOutput with field(s):
  • failed_requests(Option<Vec<FailedCreateWorkspaceRequest>>):

    Information about the WorkSpaces that could not be created.

  • pending_requests(Option<Vec<Workspace>>):

    Information about the WorkSpaces that were created.

    Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

• On failure, responds with SdkError<CreateWorkspacesError>

pub fn delete_connect_client_add_in(&self) -> DeleteConnectClientAddIn<C, M, R>

Constructs a fluent builder for the DeleteConnectClientAddIn operation.

• The fluent builder is configurable:
  • add_in_id(impl Into<String>) / set_add_in_id(Option<String>):

    The identifier of the client add-in to delete.

  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The directory identifier for which the client add-in is configured.

• On success, responds with DeleteConnectClientAddInOutput
• On failure, responds with SdkError<DeleteConnectClientAddInError>

pub fn delete_connection_alias(&self) -> DeleteConnectionAlias<C, M, R>

Constructs a fluent builder for the DeleteConnectionAlias operation.

• The fluent builder is configurable:
  • alias_id(impl Into<String>) / set_alias_id(Option<String>):

    The identifier of the connection alias to delete.

• On success, responds with DeleteConnectionAliasOutput
• On failure, responds with SdkError<DeleteConnectionAliasError>

pub fn delete_ip_group(&self) -> DeleteIpGroup<C, M, R>

Constructs a fluent builder for the DeleteIpGroup operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>):

    The identifier of the IP access control group.

• On success, responds with DeleteIpGroupOutput
• On failure, responds with SdkError<DeleteIpGroupError>

pub fn delete_tags(&self) -> DeleteTags<C, M, R>

Constructs a fluent builder for the DeleteTags operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The tag keys.

• On success, responds with DeleteTagsOutput
• On failure, responds with SdkError<DeleteTagsError>

pub fn delete_workspace_bundle(&self) -> DeleteWorkspaceBundle<C, M, R>

Constructs a fluent builder for the DeleteWorkspaceBundle operation.

• The fluent builder is configurable:
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):

    The identifier of the bundle.

• On success, responds with DeleteWorkspaceBundleOutput
• On failure, responds with SdkError<DeleteWorkspaceBundleError>

pub fn delete_workspace_image(&self) -> DeleteWorkspaceImage<C, M, R>

Constructs a fluent builder for the DeleteWorkspaceImage operation.

• The fluent builder is configurable:
  • image_id(impl Into<String>) / set_image_id(Option<String>):

    The identifier of the image.

• On success, responds with DeleteWorkspaceImageOutput
• On failure, responds with SdkError<DeleteWorkspaceImageError>

pub fn deregister_workspace_directory(
    &self
) -> DeregisterWorkspaceDirectory<C, M, R>

Constructs a fluent builder for the DeregisterWorkspaceDirectory operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):

    The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.

• On success, responds with DeregisterWorkspaceDirectoryOutput
• On failure, responds with SdkError<DeregisterWorkspaceDirectoryError>

pub fn describe_account(&self) -> DescribeAccount<C, M, R>

Constructs a fluent builder for the DescribeAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeAccountOutput with field(s):
  • dedicated_tenancy_support(Option<DedicatedTenancySupportResultEnum>):

    The status of BYOL (whether BYOL is enabled or disabled).

  • dedicated_tenancy_management_cidr_range(Option<String>):

    The IP address range, specified as an IPv4 CIDR block, used for the management network interface.

    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.

• On failure, responds with SdkError<DescribeAccountError>

pub fn describe_account_modifications(
    &self
) -> DescribeAccountModifications<C, M, R>

Constructs a fluent builder for the DescribeAccountModifications operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

• On success, responds with DescribeAccountModificationsOutput with field(s):
  • account_modifications(Option<Vec<AccountModification>>):

    The list of modifications to the configuration of BYOL.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeAccountModificationsError>

pub fn describe_client_properties(&self) -> DescribeClientProperties<C, M, R>

Constructs a fluent builder for the DescribeClientProperties operation.

• The fluent builder is configurable:
  • resource_ids(Vec<String>) / set_resource_ids(Option<Vec<String>>):

    The resource identifier, in the form of directory IDs.

• On success, responds with DescribeClientPropertiesOutput with field(s):
  • client_properties_list(Option<Vec<ClientPropertiesResult>>):

    Information about the specified Amazon WorkSpaces clients.

• On failure, responds with SdkError<DescribeClientPropertiesError>

pub fn describe_connect_client_add_ins(
    &self
) -> DescribeConnectClientAddIns<C, M, R>

Constructs a fluent builder for the DescribeConnectClientAddIns operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The directory identifier for which the client add-in is configured.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of items to return.

• On success, responds with DescribeConnectClientAddInsOutput with field(s):
  • add_ins(Option<Vec<ConnectClientAddIn>>):

    Information about client add-ins.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeConnectClientAddInsError>

pub fn describe_connection_aliases(&self) -> DescribeConnectionAliases<C, M, R>

Constructs a fluent builder for the DescribeConnectionAliases operation.

• The fluent builder is configurable:
  • alias_ids(Vec<String>) / set_alias_ids(Option<Vec<String>>):

    The identifiers of the connection aliases to describe.

  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the directory associated with the connection alias.

  • limit(i32) / set_limit(Option<i32>):

    The maximum number of connection aliases to return.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

• On success, responds with DescribeConnectionAliasesOutput with field(s):
  • connection_aliases(Option<Vec<ConnectionAlias>>):

    Information about the specified connection aliases.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeConnectionAliasesError>

pub fn describe_connection_alias_permissions(
    &self
) -> DescribeConnectionAliasPermissions<C, M, R>

Constructs a fluent builder for the DescribeConnectionAliasPermissions operation.

• The fluent builder is configurable:
  • alias_id(impl Into<String>) / set_alias_id(Option<String>):

    The identifier of the connection alias.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return.

• On success, responds with DescribeConnectionAliasPermissionsOutput with field(s):
  • alias_id(Option<String>):

    The identifier of the connection alias.

  • connection_alias_permissions(Option<Vec<ConnectionAliasPermission>>):

    The permissions associated with a connection alias.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeConnectionAliasPermissionsError>

pub fn describe_ip_groups(&self) -> DescribeIpGroups<C, M, R>

Constructs a fluent builder for the DescribeIpGroups operation.

• The fluent builder is configurable:
  • group_ids(Vec<String>) / set_group_ids(Option<Vec<String>>):

    The identifiers of one or more IP access control groups.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of items to return.

• On success, responds with DescribeIpGroupsOutput with field(s):
  • result(Option<Vec<WorkspacesIpGroup>>):

    Information about the IP access control groups.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeIpGroupsError>

pub fn describe_tags(&self) -> DescribeTags<C, M, R>

Constructs a fluent builder for the DescribeTags operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

• On success, responds with DescribeTagsOutput with field(s):
  • tag_list(Option<Vec<Tag>>):

    The tags.

• On failure, responds with SdkError<DescribeTagsError>

pub fn describe_workspace_bundles(&self) -> DescribeWorkspaceBundles<C, M, R>

Constructs a fluent builder for the DescribeWorkspaceBundles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bundle_ids(Vec<String>) / set_bundle_ids(Option<Vec<String>>):

    The identifiers of the bundles. You cannot combine this parameter with any other filter.

  • owner(impl Into<String>) / set_owner(Option<String>):

    The owner of the bundles. You cannot combine this parameter with any other filter.

    To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don’t specify a value.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token for the next set of results. (You received this token from a previous call.)

• On success, responds with DescribeWorkspaceBundlesOutput with field(s):
  • bundles(Option<Vec<WorkspaceBundle>>):

    Information about the bundles.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.

• On failure, responds with SdkError<DescribeWorkspaceBundlesError>

pub fn describe_workspace_directories(
    &self
) -> DescribeWorkspaceDirectories<C, M, R>

Constructs a fluent builder for the DescribeWorkspaceDirectories operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_ids(Vec<String>) / set_directory_ids(Option<Vec<String>>):

    The identifiers of the directories. If the value is null, all directories are retrieved.

  • limit(i32) / set_limit(Option<i32>):

    The maximum number of directories to return.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

• On success, responds with DescribeWorkspaceDirectoriesOutput with field(s):
  • directories(Option<Vec<WorkspaceDirectory>>):

    Information about the directories.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeWorkspaceDirectoriesError>

pub fn describe_workspace_image_permissions(
    &self
) -> DescribeWorkspaceImagePermissions<C, M, R>

Constructs a fluent builder for the DescribeWorkspaceImagePermissions operation.

• The fluent builder is configurable:
  • image_id(impl Into<String>) / set_image_id(Option<String>):

    The identifier of the image.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of items to return.

• On success, responds with DescribeWorkspaceImagePermissionsOutput with field(s):
  • image_id(Option<String>):

    The identifier of the image.

  • image_permissions(Option<Vec<ImagePermission>>):

    The identifiers of the Amazon Web Services accounts that the image has been shared with.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeWorkspaceImagePermissionsError>

pub fn describe_workspace_images(&self) -> DescribeWorkspaceImages<C, M, R>

Constructs a fluent builder for the DescribeWorkspaceImages operation.

• The fluent builder is configurable:
  • image_ids(Vec<String>) / set_image_ids(Option<Vec<String>>):

    The identifier of the image.

  • image_type(ImageType) / set_image_type(Option<ImageType>):

    The type (owned or shared) of the image.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of items to return.

• On success, responds with DescribeWorkspaceImagesOutput with field(s):
  • images(Option<Vec<WorkspaceImage>>):

    Information about the images.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeWorkspaceImagesError>

pub fn describe_workspaces(&self) -> DescribeWorkspaces<C, M, R>

Constructs a fluent builder for the DescribeWorkspaces operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_ids(Vec<String>) / set_workspace_ids(Option<Vec<String>>):

    The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

    Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

  • directory_id(impl Into<String>) / set_directory_id(Option<String>):

    The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

  • user_name(impl Into<String>) / set_user_name(Option<String>):

    The name of the directory user. You must specify this parameter with DirectoryId.

  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):

    The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

  • limit(i32) / set_limit(Option<i32>):

    The maximum number of items to return.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

• On success, responds with DescribeWorkspacesOutput with field(s):
  • workspaces(Option<Vec<Workspace>>):

    Information about the WorkSpaces.

    Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeWorkspacesError>

pub fn describe_workspaces_connection_status(
    &self
) -> DescribeWorkspacesConnectionStatus<C, M, R>

Constructs a fluent builder for the DescribeWorkspacesConnectionStatus operation.

• The fluent builder is configurable:
  • workspace_ids(Vec<String>) / set_workspace_ids(Option<Vec<String>>):

    The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

• On success, responds with DescribeWorkspacesConnectionStatusOutput with field(s):
  • workspaces_connection_status(Option<Vec<WorkspaceConnectionStatus>>):

    Information about the connection status of the WorkSpace.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeWorkspacesConnectionStatusError>

pub fn describe_workspace_snapshots(
    &self
) -> DescribeWorkspaceSnapshots<C, M, R>

Constructs a fluent builder for the DescribeWorkspaceSnapshots operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The identifier of the WorkSpace.

• On success, responds with DescribeWorkspaceSnapshotsOutput with field(s):
  • rebuild_snapshots(Option<Vec<Snapshot>>):

    Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.

  • restore_snapshots(Option<Vec<Snapshot>>):

    Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.

• On failure, responds with SdkError<DescribeWorkspaceSnapshotsError>

pub fn disassociate_connection_alias(
    &self
) -> DisassociateConnectionAlias<C, M, R>

Constructs a fluent builder for the DisassociateConnectionAlias operation.

• The fluent builder is configurable:
  • alias_id(impl Into<String>) / set_alias_id(Option<String>):

    The identifier of the connection alias to disassociate.

• On success, responds with DisassociateConnectionAliasOutput
• On failure, responds with SdkError<DisassociateConnectionAliasError>

pub fn disassociate_ip_groups(&self) -> DisassociateIpGroups<C, M, R>

Constructs a fluent builder for the DisassociateIpGroups operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):

    The identifier of the directory.

  • group_ids(Vec<String>) / set_group_ids(Option<Vec<String>>):

    The identifiers of one or more IP access control groups.

• On success, responds with DisassociateIpGroupsOutput
• On failure, responds with SdkError<DisassociateIpGroupsError>

pub fn import_workspace_image(&self) -> ImportWorkspaceImage<C, M, R>

Constructs a fluent builder for the ImportWorkspaceImage operation.

• The fluent builder is configurable:
  • ec2_image_id(impl Into<String>) / set_ec2_image_id(Option<String>):

    The identifier of the EC2 image.

  • ingestion_process(WorkspaceImageIngestionProcess) / set_ingestion_process(Option<WorkspaceImageIngestionProcess>):

    The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP.

    For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the protocol.

  • image_name(impl Into<String>) / set_image_name(Option<String>):

    The name of the WorkSpace image.

  • image_description(impl Into<String>) / set_image_description(Option<String>):

    The description of the WorkSpace image.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

  • applications(Vec<Application>) / set_applications(Option<Vec<Application>>):

    If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

    Although this parameter is an array, only one item is allowed at this time.

• On success, responds with ImportWorkspaceImageOutput with field(s):
  • image_id(Option<String>):

    The identifier of the WorkSpace image.

• On failure, responds with SdkError<ImportWorkspaceImageError>

pub fn list_available_management_cidr_ranges(
    &self
) -> ListAvailableManagementCidrRanges<C, M, R>

Constructs a fluent builder for the ListAvailableManagementCidrRanges operation.

• The fluent builder is configurable:
  • management_cidr_range_constraint(impl Into<String>) / set_management_cidr_range_constraint(Option<String>):

    The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of items to return.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

• On success, responds with ListAvailableManagementCidrRangesOutput with field(s):
  • management_cidr_ranges(Option<Vec<String>>):

    The list of available IP address ranges, specified as IPv4 CIDR blocks.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListAvailableManagementCidrRangesError>

pub fn migrate_workspace(&self) -> MigrateWorkspace<C, M, R>

Constructs a fluent builder for the MigrateWorkspace operation.

• The fluent builder is configurable:
  • source_workspace_id(impl Into<String>) / set_source_workspace_id(Option<String>):

    The identifier of the WorkSpace to migrate from.

  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):

    The identifier of the target bundle type to migrate the WorkSpace to.

• On success, responds with MigrateWorkspaceOutput with field(s):
  • source_workspace_id(Option<String>):

    The original identifier of the WorkSpace that is being migrated.

  • target_workspace_id(Option<String>):

    The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.

• On failure, responds with SdkError<MigrateWorkspaceError>

pub fn modify_account(&self) -> ModifyAccount<C, M, R>

Constructs a fluent builder for the ModifyAccount operation.

• The fluent builder is configurable:
  • dedicated_tenancy_support(DedicatedTenancySupportEnum) / set_dedicated_tenancy_support(Option<DedicatedTenancySupportEnum>):

    The status of BYOL.

  • dedicated_tenancy_management_cidr_range(impl Into<String>) / set_dedicated_tenancy_management_cidr_range(Option<String>):

    The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.

• On success, responds with ModifyAccountOutput
• On failure, responds with SdkError<ModifyAccountError>

pub fn modify_client_properties(&self) -> ModifyClientProperties<C, M, R>

Constructs a fluent builder for the ModifyClientProperties operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The resource identifiers, in the form of directory IDs.

  • client_properties(ClientProperties) / set_client_properties(Option<ClientProperties>):

    Information about the Amazon WorkSpaces client.

• On success, responds with ModifyClientPropertiesOutput
• On failure, responds with SdkError<ModifyClientPropertiesError>

pub fn modify_selfservice_permissions(
    &self
) -> ModifySelfservicePermissions<C, M, R>

Constructs a fluent builder for the ModifySelfservicePermissions operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the directory.

  • selfservice_permissions(SelfservicePermissions) / set_selfservice_permissions(Option<SelfservicePermissions>):

    The permissions to enable or disable self-service capabilities.

• On success, responds with ModifySelfservicePermissionsOutput
• On failure, responds with SdkError<ModifySelfservicePermissionsError>

pub fn modify_workspace_access_properties(
    &self
) -> ModifyWorkspaceAccessProperties<C, M, R>

Constructs a fluent builder for the ModifyWorkspaceAccessProperties operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the directory.

  • workspace_access_properties(WorkspaceAccessProperties) / set_workspace_access_properties(Option<WorkspaceAccessProperties>):

    The device types and operating systems to enable or disable for access.

• On success, responds with ModifyWorkspaceAccessPropertiesOutput
• On failure, responds with SdkError<ModifyWorkspaceAccessPropertiesError>

pub fn modify_workspace_creation_properties(
    &self
) -> ModifyWorkspaceCreationProperties<C, M, R>

Constructs a fluent builder for the ModifyWorkspaceCreationProperties operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The identifier of the directory.

  • workspace_creation_properties(WorkspaceCreationProperties) / set_workspace_creation_properties(Option<WorkspaceCreationProperties>):

    The default properties for creating WorkSpaces.

• On success, responds with ModifyWorkspaceCreationPropertiesOutput
• On failure, responds with SdkError<ModifyWorkspaceCreationPropertiesError>

pub fn modify_workspace_properties(&self) -> ModifyWorkspaceProperties<C, M, R>

Constructs a fluent builder for the ModifyWorkspaceProperties operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The identifier of the WorkSpace.

  • workspace_properties(WorkspaceProperties) / set_workspace_properties(Option<WorkspaceProperties>):

    The properties of the WorkSpace.

• On success, responds with ModifyWorkspacePropertiesOutput
• On failure, responds with SdkError<ModifyWorkspacePropertiesError>

pub fn modify_workspace_state(&self) -> ModifyWorkspaceState<C, M, R>

Constructs a fluent builder for the ModifyWorkspaceState operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The identifier of the WorkSpace.

  • workspace_state(TargetWorkspaceState) / set_workspace_state(Option<TargetWorkspaceState>):

    The WorkSpace state.

• On success, responds with ModifyWorkspaceStateOutput
• On failure, responds with SdkError<ModifyWorkspaceStateError>

pub fn reboot_workspaces(&self) -> RebootWorkspaces<C, M, R>

Constructs a fluent builder for the RebootWorkspaces operation.

• The fluent builder is configurable:
  • reboot_workspace_requests(Vec<RebootRequest>) / set_reboot_workspace_requests(Option<Vec<RebootRequest>>):

    The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.

• On success, responds with RebootWorkspacesOutput with field(s):
  • failed_requests(Option<Vec<FailedWorkspaceChangeRequest>>):

    Information about the WorkSpaces that could not be rebooted.

• On failure, responds with SdkError<RebootWorkspacesError>

pub fn rebuild_workspaces(&self) -> RebuildWorkspaces<C, M, R>

Constructs a fluent builder for the RebuildWorkspaces operation.

• The fluent builder is configurable:
  • rebuild_workspace_requests(Vec<RebuildRequest>) / set_rebuild_workspace_requests(Option<Vec<RebuildRequest>>):

    The WorkSpace to rebuild. You can specify a single WorkSpace.

• On success, responds with RebuildWorkspacesOutput with field(s):
  • failed_requests(Option<Vec<FailedWorkspaceChangeRequest>>):

    Information about the WorkSpace that could not be rebuilt.

• On failure, responds with SdkError<RebuildWorkspacesError>

pub fn register_workspace_directory(
    &self
) -> RegisterWorkspaceDirectory<C, M, R>

Constructs a fluent builder for the RegisterWorkspaceDirectory operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):

    The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

  • subnet_ids(Vec<String>) / set_subnet_ids(Option<Vec<String>>):

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

  • enable_work_docs(bool) / set_enable_work_docs(Option<bool>):

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

  • enable_self_service(bool) / set_enable_self_service(Option<bool>):

    Indicates whether self-service capabilities are enabled or disabled.

  • tenancy(Tenancy) / set_tenancy(Option<Tenancy>):

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags associated with the directory.

• On success, responds with RegisterWorkspaceDirectoryOutput
• On failure, responds with SdkError<RegisterWorkspaceDirectoryError>

pub fn restore_workspace(&self) -> RestoreWorkspace<C, M, R>

Constructs a fluent builder for the RestoreWorkspace operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The identifier of the WorkSpace.

• On success, responds with RestoreWorkspaceOutput
• On failure, responds with SdkError<RestoreWorkspaceError>

pub fn revoke_ip_rules(&self) -> RevokeIpRules<C, M, R>

Constructs a fluent builder for the RevokeIpRules operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>):

    The identifier of the group.

  • user_rules(Vec<String>) / set_user_rules(Option<Vec<String>>):

    The rules to remove from the group.

• On success, responds with RevokeIpRulesOutput
• On failure, responds with SdkError<RevokeIpRulesError>

pub fn start_workspaces(&self) -> StartWorkspaces<C, M, R>

Constructs a fluent builder for the StartWorkspaces operation.

• The fluent builder is configurable:
  • start_workspace_requests(Vec<StartRequest>) / set_start_workspace_requests(Option<Vec<StartRequest>>):

    The WorkSpaces to start. You can specify up to 25 WorkSpaces.

• On success, responds with StartWorkspacesOutput with field(s):
  • failed_requests(Option<Vec<FailedWorkspaceChangeRequest>>):

    Information about the WorkSpaces that could not be started.

• On failure, responds with SdkError<StartWorkspacesError>

pub fn stop_workspaces(&self) -> StopWorkspaces<C, M, R>

Constructs a fluent builder for the StopWorkspaces operation.

• The fluent builder is configurable:
  • stop_workspace_requests(Vec<StopRequest>) / set_stop_workspace_requests(Option<Vec<StopRequest>>):

    The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

• On success, responds with StopWorkspacesOutput with field(s):
  • failed_requests(Option<Vec<FailedWorkspaceChangeRequest>>):

    Information about the WorkSpaces that could not be stopped.

• On failure, responds with SdkError<StopWorkspacesError>

pub fn terminate_workspaces(&self) -> TerminateWorkspaces<C, M, R>

Constructs a fluent builder for the TerminateWorkspaces operation.

• The fluent builder is configurable:
  • terminate_workspace_requests(Vec<TerminateRequest>) / set_terminate_workspace_requests(Option<Vec<TerminateRequest>>):

    The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.

• On success, responds with TerminateWorkspacesOutput with field(s):
  • failed_requests(Option<Vec<FailedWorkspaceChangeRequest>>):

    Information about the WorkSpaces that could not be terminated.

• On failure, responds with SdkError<TerminateWorkspacesError>

pub fn update_connect_client_add_in(&self) -> UpdateConnectClientAddIn<C, M, R>

Constructs a fluent builder for the UpdateConnectClientAddIn operation.

• The fluent builder is configurable:
  • add_in_id(impl Into<String>) / set_add_in_id(Option<String>):

    The identifier of the client add-in to update.

  • resource_id(impl Into<String>) / set_resource_id(Option<String>):

    The directory identifier for which the client add-in is configured.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the client add-in.

  • url(impl Into<String>) / set_url(Option<String>):

    The endpoint URL of the Amazon Connect client add-in.

• On success, responds with UpdateConnectClientAddInOutput
• On failure, responds with SdkError<UpdateConnectClientAddInError>

pub fn update_connection_alias_permission(
    &self
) -> UpdateConnectionAliasPermission<C, M, R>

Constructs a fluent builder for the UpdateConnectionAliasPermission operation.

• The fluent builder is configurable:
  • alias_id(impl Into<String>) / set_alias_id(Option<String>):

    The identifier of the connection alias that you want to update permissions for.

  • connection_alias_permission(ConnectionAliasPermission) / set_connection_alias_permission(Option<ConnectionAliasPermission>):

    Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.

• On success, responds with UpdateConnectionAliasPermissionOutput
• On failure, responds with SdkError<UpdateConnectionAliasPermissionError>

pub fn update_rules_of_ip_group(&self) -> UpdateRulesOfIpGroup<C, M, R>

Constructs a fluent builder for the UpdateRulesOfIpGroup operation.

• The fluent builder is configurable:
  • group_id(impl Into<String>) / set_group_id(Option<String>):

    The identifier of the group.

  • user_rules(Vec<IpRuleItem>) / set_user_rules(Option<Vec<IpRuleItem>>):

    One or more rules.

• On success, responds with UpdateRulesOfIpGroupOutput
• On failure, responds with SdkError<UpdateRulesOfIpGroupError>

pub fn update_workspace_bundle(&self) -> UpdateWorkspaceBundle<C, M, R>

Constructs a fluent builder for the UpdateWorkspaceBundle operation.

• The fluent builder is configurable:
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):

    The identifier of the bundle.

  • image_id(impl Into<String>) / set_image_id(Option<String>):

    The identifier of the image.

• On success, responds with UpdateWorkspaceBundleOutput
• On failure, responds with SdkError<UpdateWorkspaceBundleError>

pub fn update_workspace_image_permission(
    &self
) -> UpdateWorkspaceImagePermission<C, M, R>

Constructs a fluent builder for the UpdateWorkspaceImagePermission operation.

• The fluent builder is configurable:
  • image_id(impl Into<String>) / set_image_id(Option<String>):

    The identifier of the image.

  • allow_copy_image(bool) / set_allow_copy_image(Option<bool>):

    The permission to copy the image. This permission can be revoked only after an image has been shared.

  • shared_account_id(impl Into<String>) / set_shared_account_id(Option<String>):

    The identifier of the Amazon Web Services account to share or unshare the image with.

    Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

• On success, responds with UpdateWorkspaceImagePermissionOutput
• On failure, responds with SdkError<UpdateWorkspaceImagePermissionError>

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.