Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Workspaces Instances

Client for invoking operations on Amazon Workspaces Instances. Each operation on Amazon Workspaces Instances 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_workspacesinstances::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 Builder 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_workspacesinstances::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 AssociateVolume operation has a Client::associate_volume, 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.associate_volume()
    .workspace_instance_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

impl Client

pub fn associate_volume(&self) -> AssociateVolumeFluentBuilder

Constructs a fluent builder for the AssociateVolume operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    WorkSpace Instance to attach volume to.

    
    
  • volume_id(impl Into<String>) / set_volume_id(Option<String>):
    required: true
    

    Volume to be attached.

    
    
  • device(impl Into<String>) / set_device(Option<String>):
    required: true
    

    Device path for volume attachment.

    
    
• On success, responds with AssociateVolumeOutput
• On failure, responds with SdkError<AssociateVolumeError>

impl Client

pub fn create_volume(&self) -> CreateVolumeFluentBuilder

Constructs a fluent builder for the CreateVolume operation.

• The fluent builder is configurable:
  • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):
    required: true
    

    Availability zone for the volume.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique token to prevent duplicate volume creation.

    
    
  • encrypted(bool) / set_encrypted(Option<bool>):
    required: false
    

    Indicates if the volume should be encrypted.

    
    
  • iops(i32) / set_iops(Option<i32>):
    required: false
    

    Input/output operations per second for the volume.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    KMS key for volume encryption.

    
    
  • size_in_gb(i32) / set_size_in_gb(Option<i32>):
    required: false
    

    Volume size in gigabytes.

    
    
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: false
    

    Source snapshot for volume creation.

    
    
  • tag_specifications(TagSpecification) / set_tag_specifications(Option<Vec::<TagSpecification>>):
    required: false
    

    Metadata tags for the volume.

    
    
  • throughput(i32) / set_throughput(Option<i32>):
    required: false
    

    Volume throughput performance.

    
    
  • volume_type(VolumeTypeEnum) / set_volume_type(Option<VolumeTypeEnum>):
    required: false
    

    Type of EBS volume.

    
    
• On success, responds with CreateVolumeOutput with field(s):
  • volume_id(Option<String>):

    Unique identifier for the new volume.

• On failure, responds with SdkError<CreateVolumeError>

impl Client

pub fn create_workspace_instance(&self) -> CreateWorkspaceInstanceFluentBuilder

Constructs a fluent builder for the CreateWorkspaceInstance operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.

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

    Optional metadata tags for categorizing and managing WorkSpaces Instances.

    
    
  • managed_instance(ManagedInstanceRequest) / set_managed_instance(Option<ManagedInstanceRequest>):
    required: true
    

    Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.

    
    
• On success, responds with CreateWorkspaceInstanceOutput with field(s):
  • workspace_instance_id(Option<String>):

    Unique identifier assigned to the newly created WorkSpaces Instance.

• On failure, responds with SdkError<CreateWorkspaceInstanceError>

impl Client

pub fn delete_volume(&self) -> DeleteVolumeFluentBuilder

Constructs a fluent builder for the DeleteVolume operation.

• The fluent builder is configurable:
  • volume_id(impl Into<String>) / set_volume_id(Option<String>):
    required: true
    

    Identifier of the volume to delete.

    
    
• On success, responds with DeleteVolumeOutput
• On failure, responds with SdkError<DeleteVolumeError>

impl Client

pub fn delete_workspace_instance(&self) -> DeleteWorkspaceInstanceFluentBuilder

Constructs a fluent builder for the DeleteWorkspaceInstance operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    Unique identifier of the WorkSpaces Instance targeted for deletion.

    
    
• On success, responds with DeleteWorkspaceInstanceOutput
• On failure, responds with SdkError<DeleteWorkspaceInstanceError>

impl Client

pub fn disassociate_volume(&self) -> DisassociateVolumeFluentBuilder

Constructs a fluent builder for the DisassociateVolume operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    WorkSpace Instance to detach volume from.

    
    
  • volume_id(impl Into<String>) / set_volume_id(Option<String>):
    required: true
    

    Volume to be detached.

    
    
  • device(impl Into<String>) / set_device(Option<String>):
    required: false
    

    Device path of volume to detach.

    
    
  • disassociate_mode(DisassociateModeEnum) / set_disassociate_mode(Option<DisassociateModeEnum>):
    required: false
    

    Mode for volume detachment.

    
    
• On success, responds with DisassociateVolumeOutput
• On failure, responds with SdkError<DisassociateVolumeError>

impl Client

pub fn get_workspace_instance(&self) -> GetWorkspaceInstanceFluentBuilder

Constructs a fluent builder for the GetWorkspaceInstance operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    Unique identifier of the WorkSpace Instance to retrieve.

    
    
• On success, responds with GetWorkspaceInstanceOutput with field(s):
  • workspace_instance_errors(Option<Vec::<WorkspaceInstanceError>>):

    Captures any errors specific to the WorkSpace Instance lifecycle.

  • ec2_instance_errors(Option<Vec::<Ec2InstanceError>>):

    Includes any underlying EC2 instance errors encountered.

  • provision_state(Option<ProvisionStateEnum>):

    Current provisioning state of the WorkSpaces Instance.

  • workspace_instance_id(Option<String>):

    Unique identifier of the retrieved WorkSpaces Instance.

  • ec2_managed_instance(Option<Ec2ManagedInstance>):

    Details of the associated EC2 managed instance.

• On failure, responds with SdkError<GetWorkspaceInstanceError>

impl Client

pub fn list_instance_types(&self) -> ListInstanceTypesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of instance types to return in a single API call. Enables pagination of instance type results.

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

    Pagination token for retrieving subsequent pages of instance type results.

    
    
• On success, responds with ListInstanceTypesOutput with field(s):
  • instance_types(Vec::<InstanceTypeInfo>):

    Collection of supported instance types for WorkSpaces Instances.

  • next_token(Option<String>):

    Token for retrieving additional instance types if the result set is paginated.

• On failure, responds with SdkError<ListInstanceTypesError>

impl Client

pub fn list_regions(&self) -> ListRegionsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of regions to return in a single API call. Enables pagination of region results.

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

    Pagination token for retrieving subsequent pages of region results.

    
    
• On success, responds with ListRegionsOutput with field(s):
  • regions(Vec::<Region>):

    Collection of AWS regions supported by WorkSpaces Instances.

  • next_token(Option<String>):

    Token for retrieving additional regions if the result set is paginated.

• On failure, responds with SdkError<ListRegionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    Unique identifier of the WorkSpace Instance.

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

    Collection of tags associated with the WorkSpace Instance.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_workspace_instances(&self) -> ListWorkspaceInstancesFluentBuilder

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

• The fluent builder is configurable:
  • provision_states(ProvisionStateEnum) / set_provision_states(Option<Vec::<ProvisionStateEnum>>):
    required: false
    

    Filter WorkSpaces Instances by their current provisioning states.

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

    Maximum number of WorkSpaces Instances to return in a single response.

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

    Pagination token for retrieving subsequent pages of WorkSpaces Instances.

    
    
• On success, responds with ListWorkspaceInstancesOutput with field(s):
  • workspace_instances(Vec::<WorkspaceInstance>):

    Collection of WorkSpaces Instances returned by the query.

  • next_token(Option<String>):

    Token for retrieving additional WorkSpaces Instances if the result set is paginated.

• On failure, responds with SdkError<ListWorkspaceInstancesError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    Unique identifier of the WorkSpace Instance to tag.

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

    Tags to be added to the WorkSpace Instance.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • workspace_instance_id(impl Into<String>) / set_workspace_instance_id(Option<String>):
    required: true
    

    Unique identifier of the WorkSpace Instance to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Keys of tags to be removed.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.