Struct aws_sdk_workspaces::client::Client
source · pub struct Client { /* private fields */ }
Expand description
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.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_workspaces::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_workspaces::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AcceptAccountLinkInvitation
operation has
a Client::accept_account_link_invitation
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.accept_account_link_invitation()
.link_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn accept_account_link_invitation(
&self
) -> AcceptAccountLinkInvitationFluentBuilder
pub fn accept_account_link_invitation( &self ) -> AcceptAccountLinkInvitationFluentBuilder
Constructs a fluent builder for the AcceptAccountLinkInvitation
operation.
- The fluent builder is configurable:
link_id(impl Into<String>)
/set_link_id(Option<String>)
:
required: trueThe identifier of the account link.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
- On success, responds with
AcceptAccountLinkInvitationOutput
with field(s):account_link(Option<AccountLink>)
:Information about the account link.
- On failure, responds with
SdkError<AcceptAccountLinkInvitationError>
source§impl Client
impl Client
sourcepub fn associate_connection_alias(
&self
) -> AssociateConnectionAliasFluentBuilder
pub fn associate_connection_alias( &self ) -> AssociateConnectionAliasFluentBuilder
Constructs a fluent builder for the AssociateConnectionAlias
operation.
- The fluent builder is configurable:
alias_id(impl Into<String>)
/set_alias_id(Option<String>)
:
required: trueThe identifier of the connection alias.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn associate_ip_groups(&self) -> AssociateIpGroupsFluentBuilder
pub fn associate_ip_groups(&self) -> AssociateIpGroupsFluentBuilder
Constructs a fluent builder for the AssociateIpGroups
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:
required: trueThe identifier of the directory.
group_ids(impl Into<String>)
/set_group_ids(Option<Vec::<String>>)
:
required: trueThe identifiers of one or more IP access control groups.
- On success, responds with
AssociateIpGroupsOutput
- On failure, responds with
SdkError<AssociateIpGroupsError>
source§impl Client
impl Client
sourcepub fn associate_workspace_application(
&self
) -> AssociateWorkspaceApplicationFluentBuilder
pub fn associate_workspace_application( &self ) -> AssociateWorkspaceApplicationFluentBuilder
Constructs a fluent builder for the AssociateWorkspaceApplication
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application.
- On success, responds with
AssociateWorkspaceApplicationOutput
with field(s):association(Option<WorkspaceResourceAssociation>)
:Information about the association between the specified WorkSpace and the specified application.
- On failure, responds with
SdkError<AssociateWorkspaceApplicationError>
source§impl Client
impl Client
Constructs a fluent builder for the AuthorizeIpRules
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier of the group.
user_rules(IpRuleItem)
/set_user_rules(Option<Vec::<IpRuleItem>>)
:
required: trueThe rules to add to the group.
- On success, responds with
AuthorizeIpRulesOutput
- On failure, responds with
SdkError<AuthorizeIpRulesError>
source§impl Client
impl Client
sourcepub fn copy_workspace_image(&self) -> CopyWorkspaceImageFluentBuilder
pub fn copy_workspace_image(&self) -> CopyWorkspaceImageFluentBuilder
Constructs a fluent builder for the CopyWorkspaceImage
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the image.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the image.
source_image_id(impl Into<String>)
/set_source_image_id(Option<String>)
:
required: trueThe identifier of the source image.
source_region(impl Into<String>)
/set_source_region(Option<String>)
:
required: trueThe identifier of the source Region.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_account_link_invitation(
&self
) -> CreateAccountLinkInvitationFluentBuilder
pub fn create_account_link_invitation( &self ) -> CreateAccountLinkInvitationFluentBuilder
Constructs a fluent builder for the CreateAccountLinkInvitation
operation.
- The fluent builder is configurable:
target_account_id(impl Into<String>)
/set_target_account_id(Option<String>)
:
required: trueThe identifier of the target account.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
- On success, responds with
CreateAccountLinkInvitationOutput
with field(s):account_link(Option<AccountLink>)
:Information about the account link.
- On failure, responds with
SdkError<CreateAccountLinkInvitationError>
source§impl Client
impl Client
sourcepub fn create_connect_client_add_in(
&self
) -> CreateConnectClientAddInFluentBuilder
pub fn create_connect_client_add_in( &self ) -> CreateConnectClientAddInFluentBuilder
Constructs a fluent builder for the CreateConnectClientAddIn
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier for which to configure the client add-in.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the client add-in.
url(impl Into<String>)
/set_url(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn create_connection_alias(&self) -> CreateConnectionAliasFluentBuilder
pub fn create_connection_alias(&self) -> CreateConnectionAliasFluentBuilder
Constructs a fluent builder for the CreateConnectionAlias
operation.
- The fluent builder is configurable:
connection_string(impl Into<String>)
/set_connection_string(Option<String>)
:
required: trueA 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_ip_group(&self) -> CreateIpGroupFluentBuilder
pub fn create_ip_group(&self) -> CreateIpGroupFluentBuilder
Constructs a fluent builder for the CreateIpGroup
operation.
- The fluent builder is configurable:
group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: trueThe name of the group.
group_desc(impl Into<String>)
/set_group_desc(Option<String>)
:
required: falseThe description of the group.
user_rules(IpRuleItem)
/set_user_rules(Option<Vec::<IpRuleItem>>)
:
required: falseThe rules to add to the group.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_standby_workspaces(&self) -> CreateStandbyWorkspacesFluentBuilder
pub fn create_standby_workspaces(&self) -> CreateStandbyWorkspacesFluentBuilder
Constructs a fluent builder for the CreateStandbyWorkspaces
operation.
- The fluent builder is configurable:
primary_region(impl Into<String>)
/set_primary_region(Option<String>)
:
required: trueThe Region of the primary WorkSpace.
standby_workspaces(StandbyWorkspace)
/set_standby_workspaces(Option<Vec::<StandbyWorkspace>>)
:
required: trueInformation about the standby WorkSpace to be created.
- On success, responds with
CreateStandbyWorkspacesOutput
with field(s):failed_standby_requests(Option<Vec::<FailedCreateStandbyWorkspacesRequest>>)
:Information about the standby WorkSpace that could not be created.
pending_standby_requests(Option<Vec::<PendingCreateStandbyWorkspacesRequest>>)
:Information about the standby WorkSpace that was created.
- On failure, responds with
SdkError<CreateStandbyWorkspacesError>
source§impl Client
impl Client
Constructs a fluent builder for the CreateTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueThe tags. Each WorkSpaces resource can have a maximum of 50 tags.
- On success, responds with
CreateTagsOutput
- On failure, responds with
SdkError<CreateTagsError>
source§impl Client
impl Client
sourcepub fn create_updated_workspace_image(
&self
) -> CreateUpdatedWorkspaceImageFluentBuilder
pub fn create_updated_workspace_image( &self ) -> CreateUpdatedWorkspaceImageFluentBuilder
Constructs a fluent builder for the CreateUpdatedWorkspaceImage
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the new updated WorkSpace image.
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueA description of whether updates for the WorkSpace image are available.
source_image_id(impl Into<String>)
/set_source_image_id(Option<String>)
:
required: trueThe identifier of the source WorkSpace image.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_workspace_bundle(&self) -> CreateWorkspaceBundleFluentBuilder
pub fn create_workspace_bundle(&self) -> CreateWorkspaceBundleFluentBuilder
Constructs a fluent builder for the CreateWorkspaceBundle
operation.
- The fluent builder is configurable:
bundle_name(impl Into<String>)
/set_bundle_name(Option<String>)
:
required: trueThe name of the bundle.
bundle_description(impl Into<String>)
/set_bundle_description(Option<String>)
:
required: trueThe description of the bundle.
image_id(impl Into<String>)
/set_image_id(Option<String>)
:
required: trueThe identifier of the image that is used to create the bundle.
compute_type(ComputeType)
/set_compute_type(Option<ComputeType>)
:
required: trueDescribes the compute type of the bundle.
user_storage(UserStorage)
/set_user_storage(Option<UserStorage>)
:
required: trueDescribes the user volume for a WorkSpace bundle.
root_storage(RootStorage)
/set_root_storage(Option<RootStorage>)
:
required: falseDescribes the root volume for a WorkSpace bundle.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_workspace_image(&self) -> CreateWorkspaceImageFluentBuilder
pub fn create_workspace_image(&self) -> CreateWorkspaceImageFluentBuilder
Constructs a fluent builder for the CreateWorkspaceImage
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the new WorkSpace image.
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueThe description of the new WorkSpace image.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the source WorkSpace
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags that you want to add to the new WorkSpace image. To add tags when you’re creating the image, you must create an IAM policy that grants your IAM user permission to use
workspaces:CreateTags
.
- On success, responds with
CreateWorkspaceImageOutput
with field(s):image_id(Option<String>)
:The identifier of the new WorkSpace image.
name(Option<String>)
:The name of the image.
description(Option<String>)
:The description of the image.
operating_system(Option<OperatingSystem>)
:The operating system that the image is running.
state(Option<WorkspaceImageState>)
:The availability status of the image.
required_tenancy(Option<WorkspaceImageRequiredTenancy>)
:Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
created(Option<DateTime>)
:The date when the image was created.
owner_account_id(Option<String>)
:The identifier of the Amazon Web Services account that owns the image.
- On failure, responds with
SdkError<CreateWorkspaceImageError>
source§impl Client
impl Client
sourcepub fn create_workspaces(&self) -> CreateWorkspacesFluentBuilder
pub fn create_workspaces(&self) -> CreateWorkspacesFluentBuilder
Constructs a fluent builder for the CreateWorkspaces
operation.
- The fluent builder is configurable:
workspaces(WorkspaceRequest)
/set_workspaces(Option<Vec::<WorkspaceRequest>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn delete_account_link_invitation(
&self
) -> DeleteAccountLinkInvitationFluentBuilder
pub fn delete_account_link_invitation( &self ) -> DeleteAccountLinkInvitationFluentBuilder
Constructs a fluent builder for the DeleteAccountLinkInvitation
operation.
- The fluent builder is configurable:
link_id(impl Into<String>)
/set_link_id(Option<String>)
:
required: trueThe identifier of the account link.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
- On success, responds with
DeleteAccountLinkInvitationOutput
with field(s):account_link(Option<AccountLink>)
:Information about the account link.
- On failure, responds with
SdkError<DeleteAccountLinkInvitationError>
source§impl Client
impl Client
sourcepub fn delete_client_branding(&self) -> DeleteClientBrandingFluentBuilder
pub fn delete_client_branding(&self) -> DeleteClientBrandingFluentBuilder
Constructs a fluent builder for the DeleteClientBranding
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier of the WorkSpace for which you want to delete client branding.
platforms(ClientDeviceType)
/set_platforms(Option<Vec::<ClientDeviceType>>)
:
required: trueThe device type for which you want to delete client branding.
- On success, responds with
DeleteClientBrandingOutput
- On failure, responds with
SdkError<DeleteClientBrandingError>
source§impl Client
impl Client
sourcepub fn delete_connect_client_add_in(
&self
) -> DeleteConnectClientAddInFluentBuilder
pub fn delete_connect_client_add_in( &self ) -> DeleteConnectClientAddInFluentBuilder
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>)
:
required: trueThe identifier of the client add-in to delete.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier for which the client add-in is configured.
- On success, responds with
DeleteConnectClientAddInOutput
- On failure, responds with
SdkError<DeleteConnectClientAddInError>
source§impl Client
impl Client
sourcepub fn delete_connection_alias(&self) -> DeleteConnectionAliasFluentBuilder
pub fn delete_connection_alias(&self) -> DeleteConnectionAliasFluentBuilder
Constructs a fluent builder for the DeleteConnectionAlias
operation.
- The fluent builder is configurable:
alias_id(impl Into<String>)
/set_alias_id(Option<String>)
:
required: trueThe identifier of the connection alias to delete.
- On success, responds with
DeleteConnectionAliasOutput
- On failure, responds with
SdkError<DeleteConnectionAliasError>
source§impl Client
impl Client
sourcepub fn delete_ip_group(&self) -> DeleteIpGroupFluentBuilder
pub fn delete_ip_group(&self) -> DeleteIpGroupFluentBuilder
Constructs a fluent builder for the DeleteIpGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier of the IP access control group.
- On success, responds with
DeleteIpGroupOutput
- On failure, responds with
SdkError<DeleteIpGroupError>
source§impl Client
impl Client
Constructs a fluent builder for the DeleteTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe 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(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys.
- On success, responds with
DeleteTagsOutput
- On failure, responds with
SdkError<DeleteTagsError>
source§impl Client
impl Client
sourcepub fn delete_workspace_bundle(&self) -> DeleteWorkspaceBundleFluentBuilder
pub fn delete_workspace_bundle(&self) -> DeleteWorkspaceBundleFluentBuilder
Constructs a fluent builder for the DeleteWorkspaceBundle
operation.
- The fluent builder is configurable:
bundle_id(impl Into<String>)
/set_bundle_id(Option<String>)
:
required: falseThe identifier of the bundle.
- On success, responds with
DeleteWorkspaceBundleOutput
- On failure, responds with
SdkError<DeleteWorkspaceBundleError>
source§impl Client
impl Client
sourcepub fn delete_workspace_image(&self) -> DeleteWorkspaceImageFluentBuilder
pub fn delete_workspace_image(&self) -> DeleteWorkspaceImageFluentBuilder
Constructs a fluent builder for the DeleteWorkspaceImage
operation.
- The fluent builder is configurable:
image_id(impl Into<String>)
/set_image_id(Option<String>)
:
required: trueThe identifier of the image.
- On success, responds with
DeleteWorkspaceImageOutput
- On failure, responds with
SdkError<DeleteWorkspaceImageError>
source§impl Client
impl Client
sourcepub fn deploy_workspace_applications(
&self
) -> DeployWorkspaceApplicationsFluentBuilder
pub fn deploy_workspace_applications( &self ) -> DeployWorkspaceApplicationsFluentBuilder
Constructs a fluent builder for the DeployWorkspaceApplications
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
force(bool)
/set_force(Option<bool>)
:
required: falseIndicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
- On success, responds with
DeployWorkspaceApplicationsOutput
with field(s):deployment(Option<WorkSpaceApplicationDeployment>)
:The list of deployed associations and information about them.
- On failure, responds with
SdkError<DeployWorkspaceApplicationsError>
source§impl Client
impl Client
sourcepub fn deregister_workspace_directory(
&self
) -> DeregisterWorkspaceDirectoryFluentBuilder
pub fn deregister_workspace_directory( &self ) -> DeregisterWorkspaceDirectoryFluentBuilder
Constructs a fluent builder for the DeregisterWorkspaceDirectory
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_account(&self) -> DescribeAccountFluentBuilder
pub fn describe_account(&self) -> DescribeAccountFluentBuilder
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.
dedicated_tenancy_account_type(Option<DedicatedTenancyAccountType>)
:The type of linked account.
- On failure, responds with
SdkError<DescribeAccountError>
source§impl Client
impl Client
sourcepub fn describe_account_modifications(
&self
) -> DescribeAccountModificationsFluentBuilder
pub fn describe_account_modifications( &self ) -> DescribeAccountModificationsFluentBuilder
Constructs a fluent builder for the DescribeAccountModifications
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>
source§impl Client
impl Client
sourcepub fn describe_application_associations(
&self
) -> DescribeApplicationAssociationsFluentBuilder
pub fn describe_application_associations( &self ) -> DescribeApplicationAssociationsFluentBuilder
Constructs a fluent builder for the DescribeApplicationAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of associations to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf you received a
NextToken
from a previous call that was paginated, provide this token to receive the next set of results.application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the specified application.
associated_resource_types(ApplicationAssociatedResourceType)
/set_associated_resource_types(Option<Vec::<ApplicationAssociatedResourceType>>)
:
required: trueThe resource type of the associated resources.
- On success, responds with
DescribeApplicationAssociationsOutput
with field(s):associations(Option<Vec::<ApplicationResourceAssociation>>)
:List of associations and information about them.
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 failure, responds with
SdkError<DescribeApplicationAssociationsError>
source§impl Client
impl Client
sourcepub fn describe_applications(&self) -> DescribeApplicationsFluentBuilder
pub fn describe_applications(&self) -> DescribeApplicationsFluentBuilder
Constructs a fluent builder for the DescribeApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_ids(impl Into<String>)
/set_application_ids(Option<Vec::<String>>)
:
required: falseThe identifiers of one or more applications.
compute_type_names(Compute)
/set_compute_type_names(Option<Vec::<Compute>>)
:
required: falseThe compute types supported by the applications.
license_type(WorkSpaceApplicationLicenseType)
/set_license_type(Option<WorkSpaceApplicationLicenseType>)
:
required: falseThe license availability for the applications.
operating_system_names(OperatingSystemName)
/set_operating_system_names(Option<Vec::<OperatingSystemName>>)
:
required: falseThe operating systems supported by the applications.
owner(impl Into<String>)
/set_owner(Option<String>)
:
required: falseThe owner of the applications.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of applications to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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
DescribeApplicationsOutput
with field(s):applications(Option<Vec::<WorkSpaceApplication>>)
:List of information about the specified applications.
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 failure, responds with
SdkError<DescribeApplicationsError>
source§impl Client
impl Client
sourcepub fn describe_bundle_associations(
&self
) -> DescribeBundleAssociationsFluentBuilder
pub fn describe_bundle_associations( &self ) -> DescribeBundleAssociationsFluentBuilder
Constructs a fluent builder for the DescribeBundleAssociations
operation.
- The fluent builder is configurable:
bundle_id(impl Into<String>)
/set_bundle_id(Option<String>)
:
required: trueThe identifier of the bundle.
associated_resource_types(BundleAssociatedResourceType)
/set_associated_resource_types(Option<Vec::<BundleAssociatedResourceType>>)
:
required: trueThe resource types of the associated resource.
- On success, responds with
DescribeBundleAssociationsOutput
with field(s):associations(Option<Vec::<BundleResourceAssociation>>)
:List of information about the specified associations.
- On failure, responds with
SdkError<DescribeBundleAssociationsError>
source§impl Client
impl Client
sourcepub fn describe_client_branding(&self) -> DescribeClientBrandingFluentBuilder
pub fn describe_client_branding(&self) -> DescribeClientBrandingFluentBuilder
Constructs a fluent builder for the DescribeClientBranding
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier of the WorkSpace for which you want to view client branding information.
- On success, responds with
DescribeClientBrandingOutput
with field(s):device_type_windows(Option<DefaultClientBrandingAttributes>)
:The branding information for Windows devices.
device_type_osx(Option<DefaultClientBrandingAttributes>)
:The branding information for macOS devices.
device_type_android(Option<DefaultClientBrandingAttributes>)
:The branding information for Android devices.
device_type_ios(Option<IosClientBrandingAttributes>)
:The branding information for iOS devices.
device_type_linux(Option<DefaultClientBrandingAttributes>)
:The branding information for Linux devices.
device_type_web(Option<DefaultClientBrandingAttributes>)
:The branding information for Web access.
- On failure, responds with
SdkError<DescribeClientBrandingError>
source§impl Client
impl Client
sourcepub fn describe_client_properties(
&self
) -> DescribeClientPropertiesFluentBuilder
pub fn describe_client_properties( &self ) -> DescribeClientPropertiesFluentBuilder
Constructs a fluent builder for the DescribeClientProperties
operation.
- The fluent builder is configurable:
resource_ids(impl Into<String>)
/set_resource_ids(Option<Vec::<String>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_connect_client_add_ins(
&self
) -> DescribeConnectClientAddInsFluentBuilder
pub fn describe_connect_client_add_ins( &self ) -> DescribeConnectClientAddInsFluentBuilder
Constructs a fluent builder for the DescribeConnectClientAddIns
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier for which the client add-in is configured.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_connection_alias_permissions(
&self
) -> DescribeConnectionAliasPermissionsFluentBuilder
pub fn describe_connection_alias_permissions( &self ) -> DescribeConnectionAliasPermissionsFluentBuilder
Constructs a fluent builder for the DescribeConnectionAliasPermissions
operation.
- The fluent builder is configurable:
alias_id(impl Into<String>)
/set_alias_id(Option<String>)
:
required: trueThe identifier of the connection alias.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_connection_aliases(
&self
) -> DescribeConnectionAliasesFluentBuilder
pub fn describe_connection_aliases( &self ) -> DescribeConnectionAliasesFluentBuilder
Constructs a fluent builder for the DescribeConnectionAliases
operation.
- The fluent builder is configurable:
alias_ids(impl Into<String>)
/set_alias_ids(Option<Vec::<String>>)
:
required: falseThe identifiers of the connection aliases to describe.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: falseThe identifier of the directory associated with the connection alias.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of connection aliases to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>
source§impl Client
impl Client
sourcepub fn describe_image_associations(
&self
) -> DescribeImageAssociationsFluentBuilder
pub fn describe_image_associations( &self ) -> DescribeImageAssociationsFluentBuilder
Constructs a fluent builder for the DescribeImageAssociations
operation.
- The fluent builder is configurable:
image_id(impl Into<String>)
/set_image_id(Option<String>)
:
required: trueThe identifier of the image.
associated_resource_types(ImageAssociatedResourceType)
/set_associated_resource_types(Option<Vec::<ImageAssociatedResourceType>>)
:
required: trueThe resource types of the associated resource.
- On success, responds with
DescribeImageAssociationsOutput
with field(s):associations(Option<Vec::<ImageResourceAssociation>>)
:List of information about the specified associations.
- On failure, responds with
SdkError<DescribeImageAssociationsError>
source§impl Client
impl Client
sourcepub fn describe_ip_groups(&self) -> DescribeIpGroupsFluentBuilder
pub fn describe_ip_groups(&self) -> DescribeIpGroupsFluentBuilder
Constructs a fluent builder for the DescribeIpGroups
operation.
- The fluent builder is configurable:
group_ids(impl Into<String>)
/set_group_ids(Option<Vec::<String>>)
:
required: falseThe identifiers of one or more IP access control groups.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseThe 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>
source§impl Client
impl Client
Constructs a fluent builder for the DescribeTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_workspace_associations(
&self
) -> DescribeWorkspaceAssociationsFluentBuilder
pub fn describe_workspace_associations( &self ) -> DescribeWorkspaceAssociationsFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceAssociations
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
associated_resource_types(WorkSpaceAssociatedResourceType)
/set_associated_resource_types(Option<Vec::<WorkSpaceAssociatedResourceType>>)
:
required: trueThe resource types of the associated resources.
- On success, responds with
DescribeWorkspaceAssociationsOutput
with field(s):associations(Option<Vec::<WorkspaceResourceAssociation>>)
:List of information about the specified associations.
- On failure, responds with
SdkError<DescribeWorkspaceAssociationsError>
source§impl Client
impl Client
sourcepub fn describe_workspace_bundles(
&self
) -> DescribeWorkspaceBundlesFluentBuilder
pub fn describe_workspace_bundles( &self ) -> DescribeWorkspaceBundlesFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceBundles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
bundle_ids(impl Into<String>)
/set_bundle_ids(Option<Vec::<String>>)
:
required: falseThe identifiers of the bundles. You cannot combine this parameter with any other filter.
owner(impl Into<String>)
/set_owner(Option<String>)
:
required: falseThe 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_workspace_directories(
&self
) -> DescribeWorkspaceDirectoriesFluentBuilder
pub fn describe_workspace_directories( &self ) -> DescribeWorkspaceDirectoriesFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceDirectories
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_ids(impl Into<String>)
/set_directory_ids(Option<Vec::<String>>)
:
required: falseThe identifiers of the directories. If the value is null, all directories are retrieved.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of directories to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>
source§impl Client
impl Client
sourcepub fn describe_workspace_image_permissions(
&self
) -> DescribeWorkspaceImagePermissionsFluentBuilder
pub fn describe_workspace_image_permissions( &self ) -> DescribeWorkspaceImagePermissionsFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceImagePermissions
operation.
- The fluent builder is configurable:
image_id(impl Into<String>)
/set_image_id(Option<String>)
:
required: trueThe identifier of the image.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_workspace_images(&self) -> DescribeWorkspaceImagesFluentBuilder
pub fn describe_workspace_images(&self) -> DescribeWorkspaceImagesFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceImages
operation.
- The fluent builder is configurable:
image_ids(impl Into<String>)
/set_image_ids(Option<Vec::<String>>)
:
required: falseThe identifier of the image.
image_type(ImageType)
/set_image_type(Option<ImageType>)
:
required: falseThe type (owned or shared) of the image.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_workspace_snapshots(
&self
) -> DescribeWorkspaceSnapshotsFluentBuilder
pub fn describe_workspace_snapshots( &self ) -> DescribeWorkspaceSnapshotsFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceSnapshots
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_workspaces(&self) -> DescribeWorkspacesFluentBuilder
pub fn describe_workspaces(&self) -> DescribeWorkspacesFluentBuilder
Constructs a fluent builder for the DescribeWorkspaces
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workspace_ids(impl Into<String>)
/set_workspace_ids(Option<Vec::<String>>)
:
required: falseThe 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 callDescribeWorkspaces
with this identifier, no information is returned.directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:
required: falseThe 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>)
:
required: falseThe name of the directory user. You must specify this parameter with
DirectoryId
.bundle_id(impl Into<String>)
/set_bundle_id(Option<String>)
:
required: falseThe 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>)
:
required: falseThe maximum number of items to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf you received a
NextToken
from a previous call that was paginated, provide this token to receive the next set of results.workspace_name(impl Into<String>)
/set_workspace_name(Option<String>)
:
required: falseThe name of the user-decoupled WorkSpace.
- 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>
source§impl Client
impl Client
sourcepub fn describe_workspaces_connection_status(
&self
) -> DescribeWorkspacesConnectionStatusFluentBuilder
pub fn describe_workspaces_connection_status( &self ) -> DescribeWorkspacesConnectionStatusFluentBuilder
Constructs a fluent builder for the DescribeWorkspacesConnectionStatus
operation.
- The fluent builder is configurable:
workspace_ids(impl Into<String>)
/set_workspace_ids(Option<Vec::<String>>)
:
required: falseThe identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>
source§impl Client
impl Client
sourcepub fn disassociate_connection_alias(
&self
) -> DisassociateConnectionAliasFluentBuilder
pub fn disassociate_connection_alias( &self ) -> DisassociateConnectionAliasFluentBuilder
Constructs a fluent builder for the DisassociateConnectionAlias
operation.
- The fluent builder is configurable:
alias_id(impl Into<String>)
/set_alias_id(Option<String>)
:
required: trueThe identifier of the connection alias to disassociate.
- On success, responds with
DisassociateConnectionAliasOutput
- On failure, responds with
SdkError<DisassociateConnectionAliasError>
source§impl Client
impl Client
sourcepub fn disassociate_ip_groups(&self) -> DisassociateIpGroupsFluentBuilder
pub fn disassociate_ip_groups(&self) -> DisassociateIpGroupsFluentBuilder
Constructs a fluent builder for the DisassociateIpGroups
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:
required: trueThe identifier of the directory.
group_ids(impl Into<String>)
/set_group_ids(Option<Vec::<String>>)
:
required: trueThe identifiers of one or more IP access control groups.
- On success, responds with
DisassociateIpGroupsOutput
- On failure, responds with
SdkError<DisassociateIpGroupsError>
source§impl Client
impl Client
sourcepub fn disassociate_workspace_application(
&self
) -> DisassociateWorkspaceApplicationFluentBuilder
pub fn disassociate_workspace_application( &self ) -> DisassociateWorkspaceApplicationFluentBuilder
Constructs a fluent builder for the DisassociateWorkspaceApplication
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application.
- On success, responds with
DisassociateWorkspaceApplicationOutput
with field(s):association(Option<WorkspaceResourceAssociation>)
:Information about the targeted association.
- On failure, responds with
SdkError<DisassociateWorkspaceApplicationError>
source§impl Client
impl Client
sourcepub fn get_account_link(&self) -> GetAccountLinkFluentBuilder
pub fn get_account_link(&self) -> GetAccountLinkFluentBuilder
Constructs a fluent builder for the GetAccountLink
operation.
- The fluent builder is configurable:
link_id(impl Into<String>)
/set_link_id(Option<String>)
:
required: falseThe identifier of the account to link.
linked_account_id(impl Into<String>)
/set_linked_account_id(Option<String>)
:
required: falseThe identifier of the account link
- On success, responds with
GetAccountLinkOutput
with field(s):account_link(Option<AccountLink>)
:The account link of the account link to retrieve.
- On failure, responds with
SdkError<GetAccountLinkError>
source§impl Client
impl Client
sourcepub fn import_client_branding(&self) -> ImportClientBrandingFluentBuilder
pub fn import_client_branding(&self) -> ImportClientBrandingFluentBuilder
Constructs a fluent builder for the ImportClientBranding
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier of the WorkSpace for which you want to import client branding.
device_type_windows(DefaultImportClientBrandingAttributes)
/set_device_type_windows(Option<DefaultImportClientBrandingAttributes>)
:
required: falseThe branding information to import for Windows devices.
device_type_osx(DefaultImportClientBrandingAttributes)
/set_device_type_osx(Option<DefaultImportClientBrandingAttributes>)
:
required: falseThe branding information to import for macOS devices.
device_type_android(DefaultImportClientBrandingAttributes)
/set_device_type_android(Option<DefaultImportClientBrandingAttributes>)
:
required: falseThe branding information to import for Android devices.
device_type_ios(IosImportClientBrandingAttributes)
/set_device_type_ios(Option<IosImportClientBrandingAttributes>)
:
required: falseThe branding information to import for iOS devices.
device_type_linux(DefaultImportClientBrandingAttributes)
/set_device_type_linux(Option<DefaultImportClientBrandingAttributes>)
:
required: falseThe branding information to import for Linux devices.
device_type_web(DefaultImportClientBrandingAttributes)
/set_device_type_web(Option<DefaultImportClientBrandingAttributes>)
:
required: falseThe branding information to import for web access.
- On success, responds with
ImportClientBrandingOutput
with field(s):device_type_windows(Option<DefaultClientBrandingAttributes>)
:The branding information configured for Windows devices.
device_type_osx(Option<DefaultClientBrandingAttributes>)
:The branding information configured for macOS devices.
device_type_android(Option<DefaultClientBrandingAttributes>)
:The branding information configured for Android devices.
device_type_ios(Option<IosClientBrandingAttributes>)
:The branding information configured for iOS devices.
device_type_linux(Option<DefaultClientBrandingAttributes>)
:The branding information configured for Linux devices.
device_type_web(Option<DefaultClientBrandingAttributes>)
:The branding information configured for web access.
- On failure, responds with
SdkError<ImportClientBrandingError>
source§impl Client
impl Client
sourcepub fn import_workspace_image(&self) -> ImportWorkspaceImageFluentBuilder
pub fn import_workspace_image(&self) -> ImportWorkspaceImageFluentBuilder
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>)
:
required: trueThe identifier of the EC2 image.
ingestion_process(WorkspaceImageIngestionProcess)
/set_ingestion_process(Option<WorkspaceImageIngestionProcess>)
:
required: trueThe ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in
_WSP
. To use PCoIP, specify a value that does not end in_WSP
. To use BYOP, specify a value that ends in_BYOP
.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR
,BYOL_REGULAR_WSP
, orBYOL_REGULAR_BYOP
, depending on the protocol.The
BYOL_REGULAR_BYOP
andBYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.image_name(impl Into<String>)
/set_image_name(Option<String>)
:
required: trueThe name of the WorkSpace image.
image_description(impl Into<String>)
/set_image_description(Option<String>)
:
required: trueThe description of the WorkSpace image.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags. Each WorkSpaces resource can have a maximum of 50 tags.
applications(Application)
/set_applications(Option<Vec::<Application>>)
:
required: falseIf specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 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.
-
Windows 11 only supports
Microsoft_Office_2019
.
-
- On success, responds with
ImportWorkspaceImageOutput
with field(s):image_id(Option<String>)
:The identifier of the WorkSpace image.
- On failure, responds with
SdkError<ImportWorkspaceImageError>
source§impl Client
impl Client
sourcepub fn list_account_links(&self) -> ListAccountLinksFluentBuilder
pub fn list_account_links(&self) -> ListAccountLinksFluentBuilder
Constructs a fluent builder for the ListAccountLinks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
link_status_filter(AccountLinkStatusEnum)
/set_link_status_filter(Option<Vec::<AccountLinkStatusEnum>>)
:
required: falseFilters the account based on their link status.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to use to retrieve the next page of results. This value is null when there are no more results to return.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of accounts to return.
- On success, responds with
ListAccountLinksOutput
with field(s):account_links(Option<Vec::<AccountLink>>)
:Information about the account links.
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<ListAccountLinksError>
source§impl Client
impl Client
sourcepub fn list_available_management_cidr_ranges(
&self
) -> ListAvailableManagementCidrRangesFluentBuilder
pub fn list_available_management_cidr_ranges( &self ) -> ListAvailableManagementCidrRangesFluentBuilder
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>)
:
required: trueThe 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>)
:
required: falseThe maximum number of items to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>
source§impl Client
impl Client
sourcepub fn migrate_workspace(&self) -> MigrateWorkspaceFluentBuilder
pub fn migrate_workspace(&self) -> MigrateWorkspaceFluentBuilder
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>)
:
required: trueThe identifier of the WorkSpace to migrate from.
bundle_id(impl Into<String>)
/set_bundle_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn modify_account(&self) -> ModifyAccountFluentBuilder
pub fn modify_account(&self) -> ModifyAccountFluentBuilder
Constructs a fluent builder for the ModifyAccount
operation.
- The fluent builder is configurable:
dedicated_tenancy_support(DedicatedTenancySupportEnum)
/set_dedicated_tenancy_support(Option<DedicatedTenancySupportEnum>)
:
required: falseThe status of BYOL.
dedicated_tenancy_management_cidr_range(impl Into<String>)
/set_dedicated_tenancy_management_cidr_range(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn modify_certificate_based_auth_properties(
&self
) -> ModifyCertificateBasedAuthPropertiesFluentBuilder
pub fn modify_certificate_based_auth_properties( &self ) -> ModifyCertificateBasedAuthPropertiesFluentBuilder
Constructs a fluent builder for the ModifyCertificateBasedAuthProperties
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe resource identifiers, in the form of directory IDs.
certificate_based_auth_properties(CertificateBasedAuthProperties)
/set_certificate_based_auth_properties(Option<CertificateBasedAuthProperties>)
:
required: falseThe properties of the certificate-based authentication.
properties_to_delete(DeletableCertificateBasedAuthProperty)
/set_properties_to_delete(Option<Vec::<DeletableCertificateBasedAuthProperty>>)
:
required: falseThe properties of the certificate-based authentication you want to delete.
- On success, responds with
ModifyCertificateBasedAuthPropertiesOutput
- On failure, responds with
SdkError<ModifyCertificateBasedAuthPropertiesError>
source§impl Client
impl Client
sourcepub fn modify_client_properties(&self) -> ModifyClientPropertiesFluentBuilder
pub fn modify_client_properties(&self) -> ModifyClientPropertiesFluentBuilder
Constructs a fluent builder for the ModifyClientProperties
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe resource identifiers, in the form of directory IDs.
client_properties(ClientProperties)
/set_client_properties(Option<ClientProperties>)
:
required: trueInformation about the Amazon WorkSpaces client.
- On success, responds with
ModifyClientPropertiesOutput
- On failure, responds with
SdkError<ModifyClientPropertiesError>
source§impl Client
impl Client
sourcepub fn modify_saml_properties(&self) -> ModifySamlPropertiesFluentBuilder
pub fn modify_saml_properties(&self) -> ModifySamlPropertiesFluentBuilder
Constructs a fluent builder for the ModifySamlProperties
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier for which you want to configure SAML properties.
saml_properties(SamlProperties)
/set_saml_properties(Option<SamlProperties>)
:
required: falseThe properties for configuring SAML 2.0 authentication.
properties_to_delete(DeletableSamlProperty)
/set_properties_to_delete(Option<Vec::<DeletableSamlProperty>>)
:
required: falseThe SAML properties to delete as part of your request.
Specify one of the following options:
-
SAML_PROPERTIES_USER_ACCESS_URL
to delete the user access URL. -
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
to delete the relay state parameter name.
-
- On success, responds with
ModifySamlPropertiesOutput
- On failure, responds with
SdkError<ModifySamlPropertiesError>
source§impl Client
impl Client
sourcepub fn modify_selfservice_permissions(
&self
) -> ModifySelfservicePermissionsFluentBuilder
pub fn modify_selfservice_permissions( &self ) -> ModifySelfservicePermissionsFluentBuilder
Constructs a fluent builder for the ModifySelfservicePermissions
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier of the directory.
selfservice_permissions(SelfservicePermissions)
/set_selfservice_permissions(Option<SelfservicePermissions>)
:
required: trueThe permissions to enable or disable self-service capabilities.
- On success, responds with
ModifySelfservicePermissionsOutput
- On failure, responds with
SdkError<ModifySelfservicePermissionsError>
source§impl Client
impl Client
sourcepub fn modify_workspace_access_properties(
&self
) -> ModifyWorkspaceAccessPropertiesFluentBuilder
pub fn modify_workspace_access_properties( &self ) -> ModifyWorkspaceAccessPropertiesFluentBuilder
Constructs a fluent builder for the ModifyWorkspaceAccessProperties
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier of the directory.
workspace_access_properties(WorkspaceAccessProperties)
/set_workspace_access_properties(Option<WorkspaceAccessProperties>)
:
required: trueThe device types and operating systems to enable or disable for access.
- On success, responds with
ModifyWorkspaceAccessPropertiesOutput
- On failure, responds with
SdkError<ModifyWorkspaceAccessPropertiesError>
source§impl Client
impl Client
sourcepub fn modify_workspace_creation_properties(
&self
) -> ModifyWorkspaceCreationPropertiesFluentBuilder
pub fn modify_workspace_creation_properties( &self ) -> ModifyWorkspaceCreationPropertiesFluentBuilder
Constructs a fluent builder for the ModifyWorkspaceCreationProperties
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier of the directory.
workspace_creation_properties(WorkspaceCreationProperties)
/set_workspace_creation_properties(Option<WorkspaceCreationProperties>)
:
required: trueThe default properties for creating WorkSpaces.
- On success, responds with
ModifyWorkspaceCreationPropertiesOutput
- On failure, responds with
SdkError<ModifyWorkspaceCreationPropertiesError>
source§impl Client
impl Client
sourcepub fn modify_workspace_properties(
&self
) -> ModifyWorkspacePropertiesFluentBuilder
pub fn modify_workspace_properties( &self ) -> ModifyWorkspacePropertiesFluentBuilder
Constructs a fluent builder for the ModifyWorkspaceProperties
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
workspace_properties(WorkspaceProperties)
/set_workspace_properties(Option<WorkspaceProperties>)
:
required: falseThe properties of the WorkSpace.
data_replication(DataReplication)
/set_data_replication(Option<DataReplication>)
:
required: falseIndicates the data replication status.
- On success, responds with
ModifyWorkspacePropertiesOutput
- On failure, responds with
SdkError<ModifyWorkspacePropertiesError>
source§impl Client
impl Client
sourcepub fn modify_workspace_state(&self) -> ModifyWorkspaceStateFluentBuilder
pub fn modify_workspace_state(&self) -> ModifyWorkspaceStateFluentBuilder
Constructs a fluent builder for the ModifyWorkspaceState
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
workspace_state(TargetWorkspaceState)
/set_workspace_state(Option<TargetWorkspaceState>)
:
required: trueThe WorkSpace state.
- On success, responds with
ModifyWorkspaceStateOutput
- On failure, responds with
SdkError<ModifyWorkspaceStateError>
source§impl Client
impl Client
sourcepub fn reboot_workspaces(&self) -> RebootWorkspacesFluentBuilder
pub fn reboot_workspaces(&self) -> RebootWorkspacesFluentBuilder
Constructs a fluent builder for the RebootWorkspaces
operation.
- The fluent builder is configurable:
reboot_workspace_requests(RebootRequest)
/set_reboot_workspace_requests(Option<Vec::<RebootRequest>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn rebuild_workspaces(&self) -> RebuildWorkspacesFluentBuilder
pub fn rebuild_workspaces(&self) -> RebuildWorkspacesFluentBuilder
Constructs a fluent builder for the RebuildWorkspaces
operation.
- The fluent builder is configurable:
rebuild_workspace_requests(RebuildRequest)
/set_rebuild_workspace_requests(Option<Vec::<RebuildRequest>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn register_workspace_directory(
&self
) -> RegisterWorkspaceDirectoryFluentBuilder
pub fn register_workspace_directory( &self ) -> RegisterWorkspaceDirectoryFluentBuilder
Constructs a fluent builder for the RegisterWorkspaceDirectory
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:
required: trueThe 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(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: falseThe 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>)
:
required: trueIndicates 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>)
:
required: falseIndicates whether self-service capabilities are enabled or disabled.
tenancy(Tenancy)
/set_tenancy(Option<Tenancy>)
:
required: falseIndicates 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags associated with the directory.
- On success, responds with
RegisterWorkspaceDirectoryOutput
- On failure, responds with
SdkError<RegisterWorkspaceDirectoryError>
source§impl Client
impl Client
sourcepub fn reject_account_link_invitation(
&self
) -> RejectAccountLinkInvitationFluentBuilder
pub fn reject_account_link_invitation( &self ) -> RejectAccountLinkInvitationFluentBuilder
Constructs a fluent builder for the RejectAccountLinkInvitation
operation.
- The fluent builder is configurable:
link_id(impl Into<String>)
/set_link_id(Option<String>)
:
required: trueThe identifier of the account link
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe client token of the account link invitation to reject.
- On success, responds with
RejectAccountLinkInvitationOutput
with field(s):account_link(Option<AccountLink>)
:Information about the account link.
- On failure, responds with
SdkError<RejectAccountLinkInvitationError>
source§impl Client
impl Client
sourcepub fn restore_workspace(&self) -> RestoreWorkspaceFluentBuilder
pub fn restore_workspace(&self) -> RestoreWorkspaceFluentBuilder
Constructs a fluent builder for the RestoreWorkspace
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe identifier of the WorkSpace.
- On success, responds with
RestoreWorkspaceOutput
- On failure, responds with
SdkError<RestoreWorkspaceError>
source§impl Client
impl Client
sourcepub fn revoke_ip_rules(&self) -> RevokeIpRulesFluentBuilder
pub fn revoke_ip_rules(&self) -> RevokeIpRulesFluentBuilder
Constructs a fluent builder for the RevokeIpRules
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier of the group.
user_rules(impl Into<String>)
/set_user_rules(Option<Vec::<String>>)
:
required: trueThe rules to remove from the group.
- On success, responds with
RevokeIpRulesOutput
- On failure, responds with
SdkError<RevokeIpRulesError>
source§impl Client
impl Client
sourcepub fn start_workspaces(&self) -> StartWorkspacesFluentBuilder
pub fn start_workspaces(&self) -> StartWorkspacesFluentBuilder
Constructs a fluent builder for the StartWorkspaces
operation.
- The fluent builder is configurable:
start_workspace_requests(StartRequest)
/set_start_workspace_requests(Option<Vec::<StartRequest>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn stop_workspaces(&self) -> StopWorkspacesFluentBuilder
pub fn stop_workspaces(&self) -> StopWorkspacesFluentBuilder
Constructs a fluent builder for the StopWorkspaces
operation.
- The fluent builder is configurable:
stop_workspace_requests(StopRequest)
/set_stop_workspace_requests(Option<Vec::<StopRequest>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn terminate_workspaces(&self) -> TerminateWorkspacesFluentBuilder
pub fn terminate_workspaces(&self) -> TerminateWorkspacesFluentBuilder
Constructs a fluent builder for the TerminateWorkspaces
operation.
- The fluent builder is configurable:
terminate_workspace_requests(TerminateRequest)
/set_terminate_workspace_requests(Option<Vec::<TerminateRequest>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn update_connect_client_add_in(
&self
) -> UpdateConnectClientAddInFluentBuilder
pub fn update_connect_client_add_in( &self ) -> UpdateConnectClientAddInFluentBuilder
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>)
:
required: trueThe identifier of the client add-in to update.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe directory identifier for which the client add-in is configured.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the client add-in.
url(impl Into<String>)
/set_url(Option<String>)
:
required: falseThe endpoint URL of the Amazon Connect client add-in.
- On success, responds with
UpdateConnectClientAddInOutput
- On failure, responds with
SdkError<UpdateConnectClientAddInError>
source§impl Client
impl Client
sourcepub fn update_connection_alias_permission(
&self
) -> UpdateConnectionAliasPermissionFluentBuilder
pub fn update_connection_alias_permission( &self ) -> UpdateConnectionAliasPermissionFluentBuilder
Constructs a fluent builder for the UpdateConnectionAliasPermission
operation.
- The fluent builder is configurable:
alias_id(impl Into<String>)
/set_alias_id(Option<String>)
:
required: trueThe identifier of the connection alias that you want to update permissions for.
connection_alias_permission(ConnectionAliasPermission)
/set_connection_alias_permission(Option<ConnectionAliasPermission>)
:
required: trueIndicates 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>
source§impl Client
impl Client
sourcepub fn update_rules_of_ip_group(&self) -> UpdateRulesOfIpGroupFluentBuilder
pub fn update_rules_of_ip_group(&self) -> UpdateRulesOfIpGroupFluentBuilder
Constructs a fluent builder for the UpdateRulesOfIpGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier of the group.
user_rules(IpRuleItem)
/set_user_rules(Option<Vec::<IpRuleItem>>)
:
required: trueOne or more rules.
- On success, responds with
UpdateRulesOfIpGroupOutput
- On failure, responds with
SdkError<UpdateRulesOfIpGroupError>
source§impl Client
impl Client
sourcepub fn update_workspace_bundle(&self) -> UpdateWorkspaceBundleFluentBuilder
pub fn update_workspace_bundle(&self) -> UpdateWorkspaceBundleFluentBuilder
Constructs a fluent builder for the UpdateWorkspaceBundle
operation.
- The fluent builder is configurable:
bundle_id(impl Into<String>)
/set_bundle_id(Option<String>)
:
required: falseThe identifier of the bundle.
image_id(impl Into<String>)
/set_image_id(Option<String>)
:
required: falseThe identifier of the image.
- On success, responds with
UpdateWorkspaceBundleOutput
- On failure, responds with
SdkError<UpdateWorkspaceBundleError>
source§impl Client
impl Client
sourcepub fn update_workspace_image_permission(
&self
) -> UpdateWorkspaceImagePermissionFluentBuilder
pub fn update_workspace_image_permission( &self ) -> UpdateWorkspaceImagePermissionFluentBuilder
Constructs a fluent builder for the UpdateWorkspaceImagePermission
operation.
- The fluent builder is configurable:
image_id(impl Into<String>)
/set_image_id(Option<String>)
:
required: trueThe identifier of the image.
allow_copy_image(bool)
/set_allow_copy_image(Option<bool>)
:
required: trueThe 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>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more