Class: Aws::WorkspacesInstances::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WorkspacesInstances::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb
Overview
An API client for WorkspacesInstances. To construct a client, you need to configure a :region and :credentials.
client = Aws::WorkspacesInstances::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_volume(params = {}) ⇒ Struct
Attaches a volume to a WorkSpace Instance.
-
#create_volume(params = {}) ⇒ Types::CreateVolumeResponse
Creates a new volume for WorkSpace Instances.
-
#create_workspace_instance(params = {}) ⇒ Types::CreateWorkspaceInstanceResponse
Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.
-
#delete_volume(params = {}) ⇒ Struct
Deletes a specified volume.
-
#delete_workspace_instance(params = {}) ⇒ Struct
Deletes the specified WorkSpace.
-
#disassociate_volume(params = {}) ⇒ Struct
Detaches a volume from a WorkSpace Instance.
-
#get_workspace_instance(params = {}) ⇒ Types::GetWorkspaceInstanceResponse
Retrieves detailed information about a specific WorkSpace Instance.
-
#list_instance_types(params = {}) ⇒ Types::ListInstanceTypesResponse
Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.
-
#list_regions(params = {}) ⇒ Types::ListRegionsResponse
Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves tags for a WorkSpace Instance.
-
#list_workspace_instances(params = {}) ⇒ Types::ListWorkspaceInstancesResponse
Retrieves a collection of WorkSpaces Instances based on specified filters.
-
#modify_volume(params = {}) ⇒ Types::ModifyVolumeResponse
Modifies the size, volume type, IOPS (input/output operations per second), or throughput of a volume.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a WorkSpace Instance.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a WorkSpace Instance.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#associate_volume(params = {}) ⇒ Struct
Attaches a volume to a WorkSpace Instance.
517 518 519 520 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 517 def associate_volume(params = {}, = {}) req = build_request(:associate_volume, params) req.send_request() end |
#create_volume(params = {}) ⇒ Types::CreateVolumeResponse
Creates a new volume for WorkSpace Instances.
594 595 596 597 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 594 def create_volume(params = {}, = {}) req = build_request(:create_volume, params) req.send_request() end |
#create_workspace_instance(params = {}) ⇒ Types::CreateWorkspaceInstanceResponse
Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.
821 822 823 824 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 821 def create_workspace_instance(params = {}, = {}) req = build_request(:create_workspace_instance, params) req.send_request() end |
#delete_volume(params = {}) ⇒ Struct
Deletes a specified volume.
843 844 845 846 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 843 def delete_volume(params = {}, = {}) req = build_request(:delete_volume, params) req.send_request() end |
#delete_workspace_instance(params = {}) ⇒ Struct
Deletes the specified WorkSpace
Usage of this API will result in deletion of the resource in question.
867 868 869 870 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 867 def delete_workspace_instance(params = {}, = {}) req = build_request(:delete_workspace_instance, params) req.send_request() end |
#disassociate_volume(params = {}) ⇒ Struct
Detaches a volume from a WorkSpace Instance.
901 902 903 904 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 901 def disassociate_volume(params = {}, = {}) req = build_request(:disassociate_volume, params) req.send_request() end |
#get_workspace_instance(params = {}) ⇒ Types::GetWorkspaceInstanceResponse
Retrieves detailed information about a specific WorkSpace Instance.
944 945 946 947 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 944 def get_workspace_instance(params = {}, = {}) req = build_request(:get_workspace_instance, params) req.send_request() end |
#list_instance_types(params = {}) ⇒ Types::ListInstanceTypesResponse
Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
998 999 1000 1001 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 998 def list_instance_types(params = {}, = {}) req = build_request(:list_instance_types, params) req.send_request() end |
#list_regions(params = {}) ⇒ Types::ListRegionsResponse
Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1037 1038 1039 1040 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1037 def list_regions(params = {}, = {}) req = build_request(:list_regions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves tags for a WorkSpace Instance.
1067 1068 1069 1070 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1067 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_workspace_instances(params = {}) ⇒ Types::ListWorkspaceInstancesResponse
Retrieves a collection of WorkSpaces Instances based on specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1112 def list_workspace_instances(params = {}, = {}) req = build_request(:list_workspace_instances, params) req.send_request() end |
#modify_volume(params = {}) ⇒ Types::ModifyVolumeResponse
Modifies the size, volume type, IOPS (input/output operations per second), or throughput of a volume. When you modify a volume, you must specify at least one of these parameters. You can modify a volume only after any previous modification for that volume has finished.
To track the progress of a modification, use the Amazon EC2 DescribeVolumesModifications operation. For more information, see Monitor the progress of Amazon EBS volume modifications in the Amazon EBS User Guide.
After you increase the size of a volume, you must extend the partition and file system to use the new storage capacity. For more information, see Extend the file system after resizing an Amazon EBS volume in the Amazon EBS User Guide, which covers both Linux and Windows instances.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1203 def modify_volume(params = {}, = {}) req = build_request(:modify_volume, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a WorkSpace Instance.
1234 1235 1236 1237 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1234 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a WorkSpace Instance.
1260 1261 1262 1263 |
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1260 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |