Expand description

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

Crate Organization

The entry point for most customers will be Client. Client exposes one method for each API offered by the service.

Some APIs require complex or nested arguments. These exist in model.

Lastly, errors that can be returned by the service are contained within error. Error defines a meta error encompassing all possible errors that can be returned by the service.

The other modules within this crate are not required for normal usage.

Modules

Client and fluent builders for calling the service.
Configuration for the service.
Endpoint resolution functionality
All error types that operations can return. Documentation on these types is copied from the model.
Input structures for operations. Documentation on these types is copied from the model.
Base Middleware Stack
Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.
All operations that this crate can perform.
Output structures for operations. Documentation on these types is copied from the model.
Paginators for the service
Data primitives referenced by other data types.

Structs

App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for Amazon WorkSpaces
Service config.
AWS SDK Credentials
EndpointDeprecated
API Endpoint
The region to send requests to.

Enums

All possible error types for this service.

Statics

Crate version number.