WorkspacesInstances class

Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure.

Constructors

WorkspacesInstances({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateVolume({required String device, required String volumeId, required String workspaceInstanceId}) → Future<void>

Attaches a volume to a WorkSpace Instance.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createVolume({required String availabilityZone, String? clientToken, bool? encrypted, int? iops, String? kmsKeyId, int? sizeInGB, String? snapshotId, List<TagSpecification>? tagSpecifications, int? throughput, VolumeTypeEnum? volumeType}) → Future<CreateVolumeResponse>

Creates a new volume for WorkSpace Instances.

createWorkspaceInstance({required ManagedInstanceRequest managedInstance, BillingConfiguration? billingConfiguration, String? clientToken, List<Tag>? tags}) → Future<CreateWorkspaceInstanceResponse>

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

deleteVolume({required String volumeId}) → Future<void>

Deletes a specified volume.

deleteWorkspaceInstance({required String workspaceInstanceId}) → Future<void>

Deletes the specified WorkSpace

disassociateVolume({required String volumeId, required String workspaceInstanceId, String? device, DisassociateModeEnum? disassociateMode}) → Future<void>

Detaches a volume from a WorkSpace Instance.

getWorkspaceInstance({required String workspaceInstanceId}) → Future<GetWorkspaceInstanceResponse>

Retrieves detailed information about a specific WorkSpace Instance.

listInstanceTypes({InstanceConfigurationFilter? instanceConfigurationFilter, int? maxResults, String? nextToken}) → Future<ListInstanceTypesResponse>

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

listRegions({int? maxResults, String? nextToken}) → Future<ListRegionsResponse>

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

listTagsForResource({required String workspaceInstanceId}) → Future<ListTagsForResourceResponse>

Retrieves tags for a WorkSpace Instance.

listWorkspaceInstances({int? maxResults, String? nextToken, List<ProvisionStateEnum>? provisionStates}) → Future<ListWorkspaceInstancesResponse>

Retrieves a collection of WorkSpaces Instances based on specified filters.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

tagResource({required List<Tag> tags, required String workspaceInstanceId}) → Future<void>

Adds tags to a WorkSpace Instance.

toString() → String

A string representation of this object.

inherited

untagResource({required List<String> tagKeys, required String workspaceInstanceId}) → Future<void>

Removes tags from a WorkSpace Instance.

Operators

operator ==(Object other) → bool

The equality operator.

inherited