aws-sdk-workspaces 1.0.0.rc1 → 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workspaces.rb +2 -2
- data/lib/aws-sdk-workspaces/client.rb +810 -688
- data/lib/aws-sdk-workspaces/client_api.rb +480 -482
- data/lib/aws-sdk-workspaces/errors.rb +4 -13
- data/lib/aws-sdk-workspaces/resource.rb +12 -14
- data/lib/aws-sdk-workspaces/types.rb +1199 -1010
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 035b69dd9ff1c36218c54c5b4b330644c8cecb9a
|
|
4
|
+
data.tar.gz: fd56bca1b82104fa5b656ab5ff8174522cafb020
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 56e003fd903a340c1cc8a1aa42e3ba9b148e4debfbb73b4200cc7fc5525010ec1ecf13060b9970625b46025cdd6cdc8374295bf3c84f23b7bcc948110e45ef16
|
|
7
|
+
data.tar.gz: 9523ed1fc5126d1fb61bc56b79392a5fa79fddc618b0c7cb25bc23eb70bee1d985c9c87b77251d4456f1bf9c3df7b02851667ae0f60fa0aab819a6ab42e73af6
|
data/lib/aws-sdk-workspaces.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-workspaces/customizations'
|
|
|
42
42
|
# @service
|
|
43
43
|
module Aws::WorkSpaces
|
|
44
44
|
|
|
45
|
-
GEM_VERSION = '1.0.0.
|
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
|
46
46
|
|
|
47
47
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -18,725 +18,847 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
22
23
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
23
24
|
|
|
24
25
|
Aws::Plugins::GlobalConfiguration.add_identifier(:workspaces)
|
|
25
26
|
|
|
26
|
-
module Aws
|
|
27
|
-
|
|
28
|
-
class Client < Seahorse::Client::Base
|
|
27
|
+
module Aws::WorkSpaces
|
|
28
|
+
class Client < Seahorse::Client::Base
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
include Aws::ClientStubs
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
@identifier = :workspaces
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
set_api(ClientApi::API)
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
51
52
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
|
55
|
+
# following classes:
|
|
56
|
+
#
|
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
58
|
+
# credentials.
|
|
59
|
+
#
|
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
62
|
+
#
|
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
|
64
|
+
# shared file, such as `~/.aws/config`.
|
|
65
|
+
#
|
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
67
|
+
#
|
|
68
|
+
# When `:credentials` are not configured directly, the following
|
|
69
|
+
# locations will be searched for credentials:
|
|
70
|
+
#
|
|
71
|
+
# * `Aws.config[:credentials]`
|
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
|
74
|
+
# * `~/.aws/credentials`
|
|
75
|
+
# * `~/.aws/config`
|
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
|
77
|
+
# very aggressive. Construct and pass an instance of
|
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
|
79
|
+
# timeouts.
|
|
80
|
+
#
|
|
81
|
+
# @option options [required, String] :region
|
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
84
|
+
# a default `:region` is search for in the following locations:
|
|
85
|
+
#
|
|
86
|
+
# * `Aws.config[:region]`
|
|
87
|
+
# * `ENV['AWS_REGION']`
|
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
90
|
+
# * `~/.aws/credentials`
|
|
91
|
+
# * `~/.aws/config`
|
|
92
|
+
#
|
|
93
|
+
# @option options [String] :access_key_id
|
|
94
|
+
#
|
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
97
|
+
# the required types.
|
|
98
|
+
#
|
|
99
|
+
# @option options [String] :endpoint
|
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
|
103
|
+
#
|
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
105
|
+
# The log formatter.
|
|
106
|
+
#
|
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
|
108
|
+
# The log level to send messages to the `:logger` at.
|
|
109
|
+
#
|
|
110
|
+
# @option options [Logger] :logger
|
|
111
|
+
# The Logger instance to send log messages to. If this option
|
|
112
|
+
# is not set, logging will be disabled.
|
|
113
|
+
#
|
|
114
|
+
# @option options [String] :profile ("default")
|
|
115
|
+
# Used when loading credentials from the shared credentials file
|
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
117
|
+
#
|
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
|
123
|
+
# errors from expired credentials.
|
|
124
|
+
#
|
|
125
|
+
# @option options [String] :secret_access_key
|
|
126
|
+
#
|
|
127
|
+
# @option options [String] :session_token
|
|
128
|
+
#
|
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
|
131
|
+
# Also disable response data type conversions. This option is useful
|
|
132
|
+
# when you want to ensure the highest level of performance by
|
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
|
134
|
+
# structures.
|
|
135
|
+
#
|
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
|
138
|
+
#
|
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
|
140
|
+
# Causes the client to return stubbed responses. By default
|
|
141
|
+
# fake responses are generated and returned. You can specify
|
|
142
|
+
# the response data to return or errors to raise by calling
|
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
144
|
+
#
|
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
146
|
+
# requests are made, and retries are disabled.
|
|
147
|
+
#
|
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
|
149
|
+
# When `true`, request parameters are validated before
|
|
150
|
+
# sending the request.
|
|
151
|
+
#
|
|
152
|
+
def initialize(*args)
|
|
153
|
+
super
|
|
154
|
+
end
|
|
139
155
|
|
|
140
|
-
|
|
156
|
+
# @!group API Operations
|
|
141
157
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
# @option params [required, Array<Types::WorkspaceRequest>] :workspaces
|
|
173
|
-
# An array of structures that specify the WorkSpaces to create.
|
|
174
|
-
# @return [Types::CreateWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
175
|
-
#
|
|
176
|
-
# * {Types::CreateWorkspacesResult#failed_requests #FailedRequests} => Array<Types::FailedCreateWorkspaceRequest>
|
|
177
|
-
# * {Types::CreateWorkspacesResult#pending_requests #PendingRequests} => Array<Types::Workspace>
|
|
178
|
-
#
|
|
179
|
-
# @example Request syntax with placeholder values
|
|
180
|
-
# resp = client.create_workspaces({
|
|
181
|
-
# workspaces: [ # required
|
|
182
|
-
# {
|
|
183
|
-
# directory_id: "DirectoryId", # required
|
|
184
|
-
# user_name: "UserName", # required
|
|
185
|
-
# bundle_id: "BundleId", # required
|
|
186
|
-
# volume_encryption_key: "VolumeEncryptionKey",
|
|
187
|
-
# user_volume_encryption_enabled: false,
|
|
188
|
-
# root_volume_encryption_enabled: false,
|
|
189
|
-
# workspace_properties: {
|
|
190
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
|
191
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
|
192
|
-
# },
|
|
193
|
-
# tags: [
|
|
194
|
-
# {
|
|
195
|
-
# key: "TagKey", # required
|
|
196
|
-
# value: "TagValue",
|
|
197
|
-
# },
|
|
198
|
-
# ],
|
|
199
|
-
# },
|
|
200
|
-
# ],
|
|
201
|
-
# })
|
|
202
|
-
#
|
|
203
|
-
# @example Response structure
|
|
204
|
-
# resp.failed_requests #=> Array
|
|
205
|
-
# resp.failed_requests[0].workspace_request.directory_id #=> String
|
|
206
|
-
# resp.failed_requests[0].workspace_request.user_name #=> String
|
|
207
|
-
# resp.failed_requests[0].workspace_request.bundle_id #=> String
|
|
208
|
-
# resp.failed_requests[0].workspace_request.volume_encryption_key #=> String
|
|
209
|
-
# resp.failed_requests[0].workspace_request.user_volume_encryption_enabled #=> Boolean
|
|
210
|
-
# resp.failed_requests[0].workspace_request.root_volume_encryption_enabled #=> Boolean
|
|
211
|
-
# resp.failed_requests[0].workspace_request.workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
|
|
212
|
-
# resp.failed_requests[0].workspace_request.workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
|
|
213
|
-
# resp.failed_requests[0].workspace_request.tags #=> Array
|
|
214
|
-
# resp.failed_requests[0].workspace_request.tags[0].key #=> String
|
|
215
|
-
# resp.failed_requests[0].workspace_request.tags[0].value #=> String
|
|
216
|
-
# resp.failed_requests[0].error_code #=> String
|
|
217
|
-
# resp.failed_requests[0].error_message #=> String
|
|
218
|
-
# resp.pending_requests #=> Array
|
|
219
|
-
# resp.pending_requests[0].workspace_id #=> String
|
|
220
|
-
# resp.pending_requests[0].directory_id #=> String
|
|
221
|
-
# resp.pending_requests[0].user_name #=> String
|
|
222
|
-
# resp.pending_requests[0].ip_address #=> String
|
|
223
|
-
# resp.pending_requests[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "STOPPING", "STOPPED", "ERROR"
|
|
224
|
-
# resp.pending_requests[0].bundle_id #=> String
|
|
225
|
-
# resp.pending_requests[0].subnet_id #=> String
|
|
226
|
-
# resp.pending_requests[0].error_message #=> String
|
|
227
|
-
# resp.pending_requests[0].error_code #=> String
|
|
228
|
-
# resp.pending_requests[0].computer_name #=> String
|
|
229
|
-
# resp.pending_requests[0].volume_encryption_key #=> String
|
|
230
|
-
# resp.pending_requests[0].user_volume_encryption_enabled #=> Boolean
|
|
231
|
-
# resp.pending_requests[0].root_volume_encryption_enabled #=> Boolean
|
|
232
|
-
# resp.pending_requests[0].workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
|
|
233
|
-
# resp.pending_requests[0].workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
|
|
234
|
-
# @overload create_workspaces(params = {})
|
|
235
|
-
# @param [Hash] params ({})
|
|
236
|
-
def create_workspaces(params = {}, options = {})
|
|
237
|
-
req = build_request(:create_workspaces, params)
|
|
238
|
-
req.send_request(options)
|
|
239
|
-
end
|
|
158
|
+
# Creates tags for a WorkSpace.
|
|
159
|
+
#
|
|
160
|
+
# @option params [required, String] :resource_id
|
|
161
|
+
# The resource ID of the request.
|
|
162
|
+
#
|
|
163
|
+
# @option params [required, Array<Types::Tag>] :tags
|
|
164
|
+
# The tags of the request.
|
|
165
|
+
#
|
|
166
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
167
|
+
#
|
|
168
|
+
# @example Request syntax with placeholder values
|
|
169
|
+
#
|
|
170
|
+
# resp = client.create_tags({
|
|
171
|
+
# resource_id: "NonEmptyString", # required
|
|
172
|
+
# tags: [ # required
|
|
173
|
+
# {
|
|
174
|
+
# key: "TagKey", # required
|
|
175
|
+
# value: "TagValue",
|
|
176
|
+
# },
|
|
177
|
+
# ],
|
|
178
|
+
# })
|
|
179
|
+
#
|
|
180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTags AWS API Documentation
|
|
181
|
+
#
|
|
182
|
+
# @overload create_tags(params = {})
|
|
183
|
+
# @param [Hash] params ({})
|
|
184
|
+
def create_tags(params = {}, options = {})
|
|
185
|
+
req = build_request(:create_tags, params)
|
|
186
|
+
req.send_request(options)
|
|
187
|
+
end
|
|
240
188
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
189
|
+
# Creates one or more WorkSpaces.
|
|
190
|
+
#
|
|
191
|
+
# <note markdown="1"> This operation is asynchronous and returns before the WorkSpaces are
|
|
192
|
+
# created.
|
|
193
|
+
#
|
|
194
|
+
# </note>
|
|
195
|
+
#
|
|
196
|
+
# @option params [required, Array<Types::WorkspaceRequest>] :workspaces
|
|
197
|
+
# An array of structures that specify the WorkSpaces to create.
|
|
198
|
+
#
|
|
199
|
+
# @return [Types::CreateWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
200
|
+
#
|
|
201
|
+
# * {Types::CreateWorkspacesResult#failed_requests #failed_requests} => Array<Types::FailedCreateWorkspaceRequest>
|
|
202
|
+
# * {Types::CreateWorkspacesResult#pending_requests #pending_requests} => Array<Types::Workspace>
|
|
203
|
+
#
|
|
204
|
+
# @example Request syntax with placeholder values
|
|
205
|
+
#
|
|
206
|
+
# resp = client.create_workspaces({
|
|
207
|
+
# workspaces: [ # required
|
|
208
|
+
# {
|
|
209
|
+
# directory_id: "DirectoryId", # required
|
|
210
|
+
# user_name: "UserName", # required
|
|
211
|
+
# bundle_id: "BundleId", # required
|
|
212
|
+
# volume_encryption_key: "VolumeEncryptionKey",
|
|
213
|
+
# user_volume_encryption_enabled: false,
|
|
214
|
+
# root_volume_encryption_enabled: false,
|
|
215
|
+
# workspace_properties: {
|
|
216
|
+
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
|
217
|
+
# running_mode_auto_stop_timeout_in_minutes: 1,
|
|
218
|
+
# },
|
|
219
|
+
# tags: [
|
|
220
|
+
# {
|
|
221
|
+
# key: "TagKey", # required
|
|
222
|
+
# value: "TagValue",
|
|
223
|
+
# },
|
|
224
|
+
# ],
|
|
225
|
+
# },
|
|
226
|
+
# ],
|
|
227
|
+
# })
|
|
228
|
+
#
|
|
229
|
+
# @example Response structure
|
|
230
|
+
#
|
|
231
|
+
# resp.failed_requests #=> Array
|
|
232
|
+
# resp.failed_requests[0].workspace_request.directory_id #=> String
|
|
233
|
+
# resp.failed_requests[0].workspace_request.user_name #=> String
|
|
234
|
+
# resp.failed_requests[0].workspace_request.bundle_id #=> String
|
|
235
|
+
# resp.failed_requests[0].workspace_request.volume_encryption_key #=> String
|
|
236
|
+
# resp.failed_requests[0].workspace_request.user_volume_encryption_enabled #=> Boolean
|
|
237
|
+
# resp.failed_requests[0].workspace_request.root_volume_encryption_enabled #=> Boolean
|
|
238
|
+
# resp.failed_requests[0].workspace_request.workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
|
|
239
|
+
# resp.failed_requests[0].workspace_request.workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
|
|
240
|
+
# resp.failed_requests[0].workspace_request.tags #=> Array
|
|
241
|
+
# resp.failed_requests[0].workspace_request.tags[0].key #=> String
|
|
242
|
+
# resp.failed_requests[0].workspace_request.tags[0].value #=> String
|
|
243
|
+
# resp.failed_requests[0].error_code #=> String
|
|
244
|
+
# resp.failed_requests[0].error_message #=> String
|
|
245
|
+
# resp.pending_requests #=> Array
|
|
246
|
+
# resp.pending_requests[0].workspace_id #=> String
|
|
247
|
+
# resp.pending_requests[0].directory_id #=> String
|
|
248
|
+
# resp.pending_requests[0].user_name #=> String
|
|
249
|
+
# resp.pending_requests[0].ip_address #=> String
|
|
250
|
+
# resp.pending_requests[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "STOPPING", "STOPPED", "ERROR"
|
|
251
|
+
# resp.pending_requests[0].bundle_id #=> String
|
|
252
|
+
# resp.pending_requests[0].subnet_id #=> String
|
|
253
|
+
# resp.pending_requests[0].error_message #=> String
|
|
254
|
+
# resp.pending_requests[0].error_code #=> String
|
|
255
|
+
# resp.pending_requests[0].computer_name #=> String
|
|
256
|
+
# resp.pending_requests[0].volume_encryption_key #=> String
|
|
257
|
+
# resp.pending_requests[0].user_volume_encryption_enabled #=> Boolean
|
|
258
|
+
# resp.pending_requests[0].root_volume_encryption_enabled #=> Boolean
|
|
259
|
+
# resp.pending_requests[0].workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
|
|
260
|
+
# resp.pending_requests[0].workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
|
|
261
|
+
#
|
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces AWS API Documentation
|
|
263
|
+
#
|
|
264
|
+
# @overload create_workspaces(params = {})
|
|
265
|
+
# @param [Hash] params ({})
|
|
266
|
+
def create_workspaces(params = {}, options = {})
|
|
267
|
+
req = build_request(:create_workspaces, params)
|
|
268
|
+
req.send_request(options)
|
|
269
|
+
end
|
|
259
270
|
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
271
|
+
# Deletes tags from a WorkSpace.
|
|
272
|
+
#
|
|
273
|
+
# @option params [required, String] :resource_id
|
|
274
|
+
# The resource ID of the request.
|
|
275
|
+
#
|
|
276
|
+
# @option params [required, Array<String>] :tag_keys
|
|
277
|
+
# The tag keys of the request.
|
|
278
|
+
#
|
|
279
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
280
|
+
#
|
|
281
|
+
# @example Request syntax with placeholder values
|
|
282
|
+
#
|
|
283
|
+
# resp = client.delete_tags({
|
|
284
|
+
# resource_id: "NonEmptyString", # required
|
|
285
|
+
# tag_keys: ["NonEmptyString"], # required
|
|
286
|
+
# })
|
|
287
|
+
#
|
|
288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTags AWS API Documentation
|
|
289
|
+
#
|
|
290
|
+
# @overload delete_tags(params = {})
|
|
291
|
+
# @param [Hash] params ({})
|
|
292
|
+
def delete_tags(params = {}, options = {})
|
|
293
|
+
req = build_request(:delete_tags, params)
|
|
294
|
+
req.send_request(options)
|
|
295
|
+
end
|
|
282
296
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
# * {Types::DescribeWorkspaceBundlesResult#bundles #Bundles} => Array<Types::WorkspaceBundle>
|
|
313
|
-
# * {Types::DescribeWorkspaceBundlesResult#next_token #NextToken} => String
|
|
314
|
-
#
|
|
315
|
-
# @example Request syntax with placeholder values
|
|
316
|
-
# resp = client.describe_workspace_bundles({
|
|
317
|
-
# bundle_ids: ["BundleId"],
|
|
318
|
-
# owner: "BundleOwner",
|
|
319
|
-
# next_token: "PaginationToken",
|
|
320
|
-
# })
|
|
321
|
-
#
|
|
322
|
-
# @example Response structure
|
|
323
|
-
# resp.bundles #=> Array
|
|
324
|
-
# resp.bundles[0].bundle_id #=> String
|
|
325
|
-
# resp.bundles[0].name #=> String
|
|
326
|
-
# resp.bundles[0].owner #=> String
|
|
327
|
-
# resp.bundles[0].description #=> String
|
|
328
|
-
# resp.bundles[0].user_storage.capacity #=> String
|
|
329
|
-
# resp.bundles[0].compute_type.name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE"
|
|
330
|
-
# resp.next_token #=> String
|
|
331
|
-
# @overload describe_workspace_bundles(params = {})
|
|
332
|
-
# @param [Hash] params ({})
|
|
333
|
-
def describe_workspace_bundles(params = {}, options = {})
|
|
334
|
-
req = build_request(:describe_workspace_bundles, params)
|
|
335
|
-
req.send_request(options)
|
|
336
|
-
end
|
|
297
|
+
# Describes tags for a WorkSpace.
|
|
298
|
+
#
|
|
299
|
+
# @option params [required, String] :resource_id
|
|
300
|
+
# The resource ID of the request.
|
|
301
|
+
#
|
|
302
|
+
# @return [Types::DescribeTagsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
303
|
+
#
|
|
304
|
+
# * {Types::DescribeTagsResult#tag_list #tag_list} => Array<Types::Tag>
|
|
305
|
+
#
|
|
306
|
+
# @example Request syntax with placeholder values
|
|
307
|
+
#
|
|
308
|
+
# resp = client.describe_tags({
|
|
309
|
+
# resource_id: "NonEmptyString", # required
|
|
310
|
+
# })
|
|
311
|
+
#
|
|
312
|
+
# @example Response structure
|
|
313
|
+
#
|
|
314
|
+
# resp.tag_list #=> Array
|
|
315
|
+
# resp.tag_list[0].key #=> String
|
|
316
|
+
# resp.tag_list[0].value #=> String
|
|
317
|
+
#
|
|
318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags AWS API Documentation
|
|
319
|
+
#
|
|
320
|
+
# @overload describe_tags(params = {})
|
|
321
|
+
# @param [Hash] params ({})
|
|
322
|
+
def describe_tags(params = {}, options = {})
|
|
323
|
+
req = build_request(:describe_tags, params)
|
|
324
|
+
req.send_request(options)
|
|
325
|
+
end
|
|
337
326
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
327
|
+
# Obtains information about the WorkSpace bundles that are available to
|
|
328
|
+
# your account in the specified region.
|
|
329
|
+
#
|
|
330
|
+
# You can filter the results with either the `BundleIds` parameter, or
|
|
331
|
+
# the `Owner` parameter, but not both.
|
|
332
|
+
#
|
|
333
|
+
# This operation supports pagination with the use of the `NextToken`
|
|
334
|
+
# request and response parameters. If more results are available, the
|
|
335
|
+
# `NextToken` response member contains a token that you pass in the next
|
|
336
|
+
# call to this operation to retrieve the next set of items.
|
|
337
|
+
#
|
|
338
|
+
# @option params [Array<String>] :bundle_ids
|
|
339
|
+
# An array of strings that contains the identifiers of the bundles to
|
|
340
|
+
# retrieve. This parameter cannot be combined with any other filter
|
|
341
|
+
# parameter.
|
|
342
|
+
#
|
|
343
|
+
# @option params [String] :owner
|
|
344
|
+
# The owner of the bundles to retrieve. This parameter cannot be
|
|
345
|
+
# combined with any other filter parameter.
|
|
346
|
+
#
|
|
347
|
+
# This contains one of the following values:
|
|
348
|
+
#
|
|
349
|
+
# * null- Retrieves the bundles that belong to the account making the
|
|
350
|
+
# call.
|
|
351
|
+
#
|
|
352
|
+
# * `AMAZON`- Retrieves the bundles that are provided by AWS.
|
|
353
|
+
#
|
|
354
|
+
# @option params [String] :next_token
|
|
355
|
+
# The `NextToken` value from a previous call to this operation. Pass
|
|
356
|
+
# null if this is the first call.
|
|
357
|
+
#
|
|
358
|
+
# @return [Types::DescribeWorkspaceBundlesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
359
|
+
#
|
|
360
|
+
# * {Types::DescribeWorkspaceBundlesResult#bundles #bundles} => Array<Types::WorkspaceBundle>
|
|
361
|
+
# * {Types::DescribeWorkspaceBundlesResult#next_token #next_token} => String
|
|
362
|
+
#
|
|
363
|
+
# @example Request syntax with placeholder values
|
|
364
|
+
#
|
|
365
|
+
# resp = client.describe_workspace_bundles({
|
|
366
|
+
# bundle_ids: ["BundleId"],
|
|
367
|
+
# owner: "BundleOwner",
|
|
368
|
+
# next_token: "PaginationToken",
|
|
369
|
+
# })
|
|
370
|
+
#
|
|
371
|
+
# @example Response structure
|
|
372
|
+
#
|
|
373
|
+
# resp.bundles #=> Array
|
|
374
|
+
# resp.bundles[0].bundle_id #=> String
|
|
375
|
+
# resp.bundles[0].name #=> String
|
|
376
|
+
# resp.bundles[0].owner #=> String
|
|
377
|
+
# resp.bundles[0].description #=> String
|
|
378
|
+
# resp.bundles[0].user_storage.capacity #=> String
|
|
379
|
+
# resp.bundles[0].compute_type.name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE"
|
|
380
|
+
# resp.next_token #=> String
|
|
381
|
+
#
|
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles AWS API Documentation
|
|
383
|
+
#
|
|
384
|
+
# @overload describe_workspace_bundles(params = {})
|
|
385
|
+
# @param [Hash] params ({})
|
|
386
|
+
def describe_workspace_bundles(params = {}, options = {})
|
|
387
|
+
req = build_request(:describe_workspace_bundles, params)
|
|
388
|
+
req.send_request(options)
|
|
389
|
+
end
|
|
391
390
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
# resp.workspaces[0].volume_encryption_key #=> String
|
|
454
|
-
# resp.workspaces[0].user_volume_encryption_enabled #=> Boolean
|
|
455
|
-
# resp.workspaces[0].root_volume_encryption_enabled #=> Boolean
|
|
456
|
-
# resp.workspaces[0].workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
|
|
457
|
-
# resp.workspaces[0].workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
|
|
458
|
-
# resp.next_token #=> String
|
|
459
|
-
# @overload describe_workspaces(params = {})
|
|
460
|
-
# @param [Hash] params ({})
|
|
461
|
-
def describe_workspaces(params = {}, options = {})
|
|
462
|
-
req = build_request(:describe_workspaces, params)
|
|
463
|
-
req.send_request(options)
|
|
464
|
-
end
|
|
391
|
+
# Retrieves information about the AWS Directory Service directories in
|
|
392
|
+
# the region that are registered with Amazon WorkSpaces and are
|
|
393
|
+
# available to your account.
|
|
394
|
+
#
|
|
395
|
+
# This operation supports pagination with the use of the `NextToken`
|
|
396
|
+
# request and response parameters. If more results are available, the
|
|
397
|
+
# `NextToken` response member contains a token that you pass in the next
|
|
398
|
+
# call to this operation to retrieve the next set of items.
|
|
399
|
+
#
|
|
400
|
+
# @option params [Array<String>] :directory_ids
|
|
401
|
+
# An array of strings that contains the directory identifiers to
|
|
402
|
+
# retrieve information for. If this member is null, all directories are
|
|
403
|
+
# retrieved.
|
|
404
|
+
#
|
|
405
|
+
# @option params [String] :next_token
|
|
406
|
+
# The `NextToken` value from a previous call to this operation. Pass
|
|
407
|
+
# null if this is the first call.
|
|
408
|
+
#
|
|
409
|
+
# @return [Types::DescribeWorkspaceDirectoriesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
410
|
+
#
|
|
411
|
+
# * {Types::DescribeWorkspaceDirectoriesResult#directories #directories} => Array<Types::WorkspaceDirectory>
|
|
412
|
+
# * {Types::DescribeWorkspaceDirectoriesResult#next_token #next_token} => String
|
|
413
|
+
#
|
|
414
|
+
# @example Request syntax with placeholder values
|
|
415
|
+
#
|
|
416
|
+
# resp = client.describe_workspace_directories({
|
|
417
|
+
# directory_ids: ["DirectoryId"],
|
|
418
|
+
# next_token: "PaginationToken",
|
|
419
|
+
# })
|
|
420
|
+
#
|
|
421
|
+
# @example Response structure
|
|
422
|
+
#
|
|
423
|
+
# resp.directories #=> Array
|
|
424
|
+
# resp.directories[0].directory_id #=> String
|
|
425
|
+
# resp.directories[0].alias #=> String
|
|
426
|
+
# resp.directories[0].directory_name #=> String
|
|
427
|
+
# resp.directories[0].registration_code #=> String
|
|
428
|
+
# resp.directories[0].subnet_ids #=> Array
|
|
429
|
+
# resp.directories[0].subnet_ids[0] #=> String
|
|
430
|
+
# resp.directories[0].dns_ip_addresses #=> Array
|
|
431
|
+
# resp.directories[0].dns_ip_addresses[0] #=> String
|
|
432
|
+
# resp.directories[0].customer_user_name #=> String
|
|
433
|
+
# resp.directories[0].iam_role_id #=> String
|
|
434
|
+
# resp.directories[0].directory_type #=> String, one of "SIMPLE_AD", "AD_CONNECTOR"
|
|
435
|
+
# resp.directories[0].workspace_security_group_id #=> String
|
|
436
|
+
# resp.directories[0].state #=> String, one of "REGISTERING", "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ERROR"
|
|
437
|
+
# resp.directories[0].workspace_creation_properties.enable_work_docs #=> Boolean
|
|
438
|
+
# resp.directories[0].workspace_creation_properties.enable_internet_access #=> Boolean
|
|
439
|
+
# resp.directories[0].workspace_creation_properties.default_ou #=> String
|
|
440
|
+
# resp.directories[0].workspace_creation_properties.custom_security_group_id #=> String
|
|
441
|
+
# resp.directories[0].workspace_creation_properties.user_enabled_as_local_administrator #=> Boolean
|
|
442
|
+
# resp.next_token #=> String
|
|
443
|
+
#
|
|
444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories AWS API Documentation
|
|
445
|
+
#
|
|
446
|
+
# @overload describe_workspace_directories(params = {})
|
|
447
|
+
# @param [Hash] params ({})
|
|
448
|
+
def describe_workspace_directories(params = {}, options = {})
|
|
449
|
+
req = build_request(:describe_workspace_directories, params)
|
|
450
|
+
req.send_request(options)
|
|
451
|
+
end
|
|
465
452
|
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
453
|
+
# Obtains information about the specified WorkSpaces.
|
|
454
|
+
#
|
|
455
|
+
# Only one of the filter parameters, such as `BundleId`, `DirectoryId`,
|
|
456
|
+
# or `WorkspaceIds`, can be specified at a time.
|
|
457
|
+
#
|
|
458
|
+
# This operation supports pagination with the use of the `NextToken`
|
|
459
|
+
# request and response parameters. If more results are available, the
|
|
460
|
+
# `NextToken` response member contains a token that you pass in the next
|
|
461
|
+
# call to this operation to retrieve the next set of items.
|
|
462
|
+
#
|
|
463
|
+
# @option params [Array<String>] :workspace_ids
|
|
464
|
+
# An array of strings that contain the identifiers of the WorkSpaces for
|
|
465
|
+
# which to retrieve information. This parameter cannot be combined with
|
|
466
|
+
# any other filter parameter.
|
|
467
|
+
#
|
|
468
|
+
# Because the CreateWorkspaces operation is asynchronous, the identifier
|
|
469
|
+
# it returns is not immediately available. If you immediately call
|
|
470
|
+
# DescribeWorkspaces with this identifier, no information is returned.
|
|
471
|
+
#
|
|
472
|
+
# @option params [String] :directory_id
|
|
473
|
+
# Specifies the directory identifier to which to limit the WorkSpaces.
|
|
474
|
+
# Optionally, you can specify a specific directory user with the
|
|
475
|
+
# `UserName` parameter. This parameter cannot be combined with any other
|
|
476
|
+
# filter parameter.
|
|
477
|
+
#
|
|
478
|
+
# @option params [String] :user_name
|
|
479
|
+
# Used with the `DirectoryId` parameter to specify the directory user
|
|
480
|
+
# for whom to obtain the WorkSpace.
|
|
481
|
+
#
|
|
482
|
+
# @option params [String] :bundle_id
|
|
483
|
+
# The identifier of a bundle to obtain the WorkSpaces for. All
|
|
484
|
+
# WorkSpaces that are created from this bundle will be retrieved. This
|
|
485
|
+
# parameter cannot be combined with any other filter parameter.
|
|
486
|
+
#
|
|
487
|
+
# @option params [Integer] :limit
|
|
488
|
+
# The maximum number of items to return.
|
|
489
|
+
#
|
|
490
|
+
# @option params [String] :next_token
|
|
491
|
+
# The `NextToken` value from a previous call to this operation. Pass
|
|
492
|
+
# null if this is the first call.
|
|
493
|
+
#
|
|
494
|
+
# @return [Types::DescribeWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
495
|
+
#
|
|
496
|
+
# * {Types::DescribeWorkspacesResult#workspaces #workspaces} => Array<Types::Workspace>
|
|
497
|
+
# * {Types::DescribeWorkspacesResult#next_token #next_token} => String
|
|
498
|
+
#
|
|
499
|
+
# @example Request syntax with placeholder values
|
|
500
|
+
#
|
|
501
|
+
# resp = client.describe_workspaces({
|
|
502
|
+
# workspace_ids: ["WorkspaceId"],
|
|
503
|
+
# directory_id: "DirectoryId",
|
|
504
|
+
# user_name: "UserName",
|
|
505
|
+
# bundle_id: "BundleId",
|
|
506
|
+
# limit: 1,
|
|
507
|
+
# next_token: "PaginationToken",
|
|
508
|
+
# })
|
|
509
|
+
#
|
|
510
|
+
# @example Response structure
|
|
511
|
+
#
|
|
512
|
+
# resp.workspaces #=> Array
|
|
513
|
+
# resp.workspaces[0].workspace_id #=> String
|
|
514
|
+
# resp.workspaces[0].directory_id #=> String
|
|
515
|
+
# resp.workspaces[0].user_name #=> String
|
|
516
|
+
# resp.workspaces[0].ip_address #=> String
|
|
517
|
+
# resp.workspaces[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "STOPPING", "STOPPED", "ERROR"
|
|
518
|
+
# resp.workspaces[0].bundle_id #=> String
|
|
519
|
+
# resp.workspaces[0].subnet_id #=> String
|
|
520
|
+
# resp.workspaces[0].error_message #=> String
|
|
521
|
+
# resp.workspaces[0].error_code #=> String
|
|
522
|
+
# resp.workspaces[0].computer_name #=> String
|
|
523
|
+
# resp.workspaces[0].volume_encryption_key #=> String
|
|
524
|
+
# resp.workspaces[0].user_volume_encryption_enabled #=> Boolean
|
|
525
|
+
# resp.workspaces[0].root_volume_encryption_enabled #=> Boolean
|
|
526
|
+
# resp.workspaces[0].workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
|
|
527
|
+
# resp.workspaces[0].workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
|
|
528
|
+
# resp.next_token #=> String
|
|
529
|
+
#
|
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces AWS API Documentation
|
|
531
|
+
#
|
|
532
|
+
# @overload describe_workspaces(params = {})
|
|
533
|
+
# @param [Hash] params ({})
|
|
534
|
+
def describe_workspaces(params = {}, options = {})
|
|
535
|
+
req = build_request(:describe_workspaces, params)
|
|
536
|
+
req.send_request(options)
|
|
537
|
+
end
|
|
495
538
|
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
539
|
+
# Describes the connection status of a specified WorkSpace.
|
|
540
|
+
#
|
|
541
|
+
# @option params [Array<String>] :workspace_ids
|
|
542
|
+
# An array of strings that contain the identifiers of the WorkSpaces.
|
|
543
|
+
#
|
|
544
|
+
# @option params [String] :next_token
|
|
545
|
+
# The next token of the request.
|
|
546
|
+
#
|
|
547
|
+
# @return [Types::DescribeWorkspacesConnectionStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
548
|
+
#
|
|
549
|
+
# * {Types::DescribeWorkspacesConnectionStatusResult#workspaces_connection_status #workspaces_connection_status} => Array<Types::WorkspaceConnectionStatus>
|
|
550
|
+
# * {Types::DescribeWorkspacesConnectionStatusResult#next_token #next_token} => String
|
|
551
|
+
#
|
|
552
|
+
# @example Request syntax with placeholder values
|
|
553
|
+
#
|
|
554
|
+
# resp = client.describe_workspaces_connection_status({
|
|
555
|
+
# workspace_ids: ["WorkspaceId"],
|
|
556
|
+
# next_token: "PaginationToken",
|
|
557
|
+
# })
|
|
558
|
+
#
|
|
559
|
+
# @example Response structure
|
|
560
|
+
#
|
|
561
|
+
# resp.workspaces_connection_status #=> Array
|
|
562
|
+
# resp.workspaces_connection_status[0].workspace_id #=> String
|
|
563
|
+
# resp.workspaces_connection_status[0].connection_state #=> String, one of "CONNECTED", "DISCONNECTED", "UNKNOWN"
|
|
564
|
+
# resp.workspaces_connection_status[0].connection_state_check_timestamp #=> Time
|
|
565
|
+
# resp.workspaces_connection_status[0].last_known_user_connection_timestamp #=> Time
|
|
566
|
+
# resp.next_token #=> String
|
|
567
|
+
#
|
|
568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus AWS API Documentation
|
|
569
|
+
#
|
|
570
|
+
# @overload describe_workspaces_connection_status(params = {})
|
|
571
|
+
# @param [Hash] params ({})
|
|
572
|
+
def describe_workspaces_connection_status(params = {}, options = {})
|
|
573
|
+
req = build_request(:describe_workspaces_connection_status, params)
|
|
574
|
+
req.send_request(options)
|
|
575
|
+
end
|
|
518
576
|
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
# @overload reboot_workspaces(params = {})
|
|
549
|
-
# @param [Hash] params ({})
|
|
550
|
-
def reboot_workspaces(params = {}, options = {})
|
|
551
|
-
req = build_request(:reboot_workspaces, params)
|
|
552
|
-
req.send_request(options)
|
|
553
|
-
end
|
|
577
|
+
# Modifies the WorkSpace properties, including the RunningMode and
|
|
578
|
+
# AutoStop time.
|
|
579
|
+
#
|
|
580
|
+
# @option params [required, String] :workspace_id
|
|
581
|
+
# The ID of the WorkSpace.
|
|
582
|
+
#
|
|
583
|
+
# @option params [required, Types::WorkspaceProperties] :workspace_properties
|
|
584
|
+
# The WorkSpace properties of the request.
|
|
585
|
+
#
|
|
586
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
587
|
+
#
|
|
588
|
+
# @example Request syntax with placeholder values
|
|
589
|
+
#
|
|
590
|
+
# resp = client.modify_workspace_properties({
|
|
591
|
+
# workspace_id: "WorkspaceId", # required
|
|
592
|
+
# workspace_properties: { # required
|
|
593
|
+
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
|
594
|
+
# running_mode_auto_stop_timeout_in_minutes: 1,
|
|
595
|
+
# },
|
|
596
|
+
# })
|
|
597
|
+
#
|
|
598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties AWS API Documentation
|
|
599
|
+
#
|
|
600
|
+
# @overload modify_workspace_properties(params = {})
|
|
601
|
+
# @param [Hash] params ({})
|
|
602
|
+
def modify_workspace_properties(params = {}, options = {})
|
|
603
|
+
req = build_request(:modify_workspace_properties, params)
|
|
604
|
+
req.send_request(options)
|
|
605
|
+
end
|
|
554
606
|
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
# resp.failed_requests[0].error_code #=> String
|
|
598
|
-
# resp.failed_requests[0].error_message #=> String
|
|
599
|
-
# @overload rebuild_workspaces(params = {})
|
|
600
|
-
# @param [Hash] params ({})
|
|
601
|
-
def rebuild_workspaces(params = {}, options = {})
|
|
602
|
-
req = build_request(:rebuild_workspaces, params)
|
|
603
|
-
req.send_request(options)
|
|
604
|
-
end
|
|
607
|
+
# Reboots the specified WorkSpaces.
|
|
608
|
+
#
|
|
609
|
+
# To be able to reboot a WorkSpace, the WorkSpace must have a **State**
|
|
610
|
+
# of `AVAILABLE`, `IMPAIRED`, or `INOPERABLE`.
|
|
611
|
+
#
|
|
612
|
+
# <note markdown="1"> This operation is asynchronous and returns before the WorkSpaces have
|
|
613
|
+
# rebooted.
|
|
614
|
+
#
|
|
615
|
+
# </note>
|
|
616
|
+
#
|
|
617
|
+
# @option params [required, Array<Types::RebootRequest>] :reboot_workspace_requests
|
|
618
|
+
# An array of structures that specify the WorkSpaces to reboot.
|
|
619
|
+
#
|
|
620
|
+
# @return [Types::RebootWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
621
|
+
#
|
|
622
|
+
# * {Types::RebootWorkspacesResult#failed_requests #failed_requests} => Array<Types::FailedWorkspaceChangeRequest>
|
|
623
|
+
#
|
|
624
|
+
# @example Request syntax with placeholder values
|
|
625
|
+
#
|
|
626
|
+
# resp = client.reboot_workspaces({
|
|
627
|
+
# reboot_workspace_requests: [ # required
|
|
628
|
+
# {
|
|
629
|
+
# workspace_id: "WorkspaceId", # required
|
|
630
|
+
# },
|
|
631
|
+
# ],
|
|
632
|
+
# })
|
|
633
|
+
#
|
|
634
|
+
# @example Response structure
|
|
635
|
+
#
|
|
636
|
+
# resp.failed_requests #=> Array
|
|
637
|
+
# resp.failed_requests[0].workspace_id #=> String
|
|
638
|
+
# resp.failed_requests[0].error_code #=> String
|
|
639
|
+
# resp.failed_requests[0].error_message #=> String
|
|
640
|
+
#
|
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces AWS API Documentation
|
|
642
|
+
#
|
|
643
|
+
# @overload reboot_workspaces(params = {})
|
|
644
|
+
# @param [Hash] params ({})
|
|
645
|
+
def reboot_workspaces(params = {}, options = {})
|
|
646
|
+
req = build_request(:reboot_workspaces, params)
|
|
647
|
+
req.send_request(options)
|
|
648
|
+
end
|
|
605
649
|
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
650
|
+
# Rebuilds the specified WorkSpaces.
|
|
651
|
+
#
|
|
652
|
+
# Rebuilding a WorkSpace is a potentially destructive action that can
|
|
653
|
+
# result in the loss of data. Rebuilding a WorkSpace causes the
|
|
654
|
+
# following to occur:
|
|
655
|
+
#
|
|
656
|
+
# * The system is restored to the image of the bundle that the WorkSpace
|
|
657
|
+
# is created from. Any applications that have been installed, or
|
|
658
|
+
# system settings that have been made since the WorkSpace was created
|
|
659
|
+
# will be lost.
|
|
660
|
+
#
|
|
661
|
+
# * The data drive (D drive) is re-created from the last automatic
|
|
662
|
+
# snapshot taken of the data drive. The current contents of the data
|
|
663
|
+
# drive are overwritten. Automatic snapshots of the data drive are
|
|
664
|
+
# taken every 12 hours, so the snapshot can be as much as 12 hours
|
|
665
|
+
# old.
|
|
666
|
+
#
|
|
667
|
+
# To be able to rebuild a WorkSpace, the WorkSpace must have a **State**
|
|
668
|
+
# of `AVAILABLE` or `ERROR`.
|
|
669
|
+
#
|
|
670
|
+
# <note markdown="1"> This operation is asynchronous and returns before the WorkSpaces have
|
|
671
|
+
# been completely rebuilt.
|
|
672
|
+
#
|
|
673
|
+
# </note>
|
|
674
|
+
#
|
|
675
|
+
# @option params [required, Array<Types::RebuildRequest>] :rebuild_workspace_requests
|
|
676
|
+
# An array of structures that specify the WorkSpaces to rebuild.
|
|
677
|
+
#
|
|
678
|
+
# @return [Types::RebuildWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
679
|
+
#
|
|
680
|
+
# * {Types::RebuildWorkspacesResult#failed_requests #failed_requests} => Array<Types::FailedWorkspaceChangeRequest>
|
|
681
|
+
#
|
|
682
|
+
# @example Request syntax with placeholder values
|
|
683
|
+
#
|
|
684
|
+
# resp = client.rebuild_workspaces({
|
|
685
|
+
# rebuild_workspace_requests: [ # required
|
|
686
|
+
# {
|
|
687
|
+
# workspace_id: "WorkspaceId", # required
|
|
688
|
+
# },
|
|
689
|
+
# ],
|
|
690
|
+
# })
|
|
691
|
+
#
|
|
692
|
+
# @example Response structure
|
|
693
|
+
#
|
|
694
|
+
# resp.failed_requests #=> Array
|
|
695
|
+
# resp.failed_requests[0].workspace_id #=> String
|
|
696
|
+
# resp.failed_requests[0].error_code #=> String
|
|
697
|
+
# resp.failed_requests[0].error_message #=> String
|
|
698
|
+
#
|
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces AWS API Documentation
|
|
700
|
+
#
|
|
701
|
+
# @overload rebuild_workspaces(params = {})
|
|
702
|
+
# @param [Hash] params ({})
|
|
703
|
+
def rebuild_workspaces(params = {}, options = {})
|
|
704
|
+
req = build_request(:rebuild_workspaces, params)
|
|
705
|
+
req.send_request(options)
|
|
706
|
+
end
|
|
635
707
|
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
708
|
+
# Starts the specified WorkSpaces. The API only works with WorkSpaces
|
|
709
|
+
# that have RunningMode configured as AutoStop and the State set to
|
|
710
|
+
# “STOPPED.”
|
|
711
|
+
#
|
|
712
|
+
# @option params [required, Array<Types::StartRequest>] :start_workspace_requests
|
|
713
|
+
# The requests.
|
|
714
|
+
#
|
|
715
|
+
# @return [Types::StartWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
716
|
+
#
|
|
717
|
+
# * {Types::StartWorkspacesResult#failed_requests #failed_requests} => Array<Types::FailedWorkspaceChangeRequest>
|
|
718
|
+
#
|
|
719
|
+
# @example Request syntax with placeholder values
|
|
720
|
+
#
|
|
721
|
+
# resp = client.start_workspaces({
|
|
722
|
+
# start_workspace_requests: [ # required
|
|
723
|
+
# {
|
|
724
|
+
# workspace_id: "WorkspaceId",
|
|
725
|
+
# },
|
|
726
|
+
# ],
|
|
727
|
+
# })
|
|
728
|
+
#
|
|
729
|
+
# @example Response structure
|
|
730
|
+
#
|
|
731
|
+
# resp.failed_requests #=> Array
|
|
732
|
+
# resp.failed_requests[0].workspace_id #=> String
|
|
733
|
+
# resp.failed_requests[0].error_code #=> String
|
|
734
|
+
# resp.failed_requests[0].error_message #=> String
|
|
735
|
+
#
|
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces AWS API Documentation
|
|
737
|
+
#
|
|
738
|
+
# @overload start_workspaces(params = {})
|
|
739
|
+
# @param [Hash] params ({})
|
|
740
|
+
def start_workspaces(params = {}, options = {})
|
|
741
|
+
req = build_request(:start_workspaces, params)
|
|
742
|
+
req.send_request(options)
|
|
743
|
+
end
|
|
665
744
|
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
req = build_request(:terminate_workspaces, params)
|
|
703
|
-
req.send_request(options)
|
|
704
|
-
end
|
|
745
|
+
# Stops the specified WorkSpaces. The API only works with WorkSpaces
|
|
746
|
+
# that have RunningMode configured as AutoStop and the State set to
|
|
747
|
+
# AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
|
|
748
|
+
#
|
|
749
|
+
# @option params [required, Array<Types::StopRequest>] :stop_workspace_requests
|
|
750
|
+
# The requests.
|
|
751
|
+
#
|
|
752
|
+
# @return [Types::StopWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
753
|
+
#
|
|
754
|
+
# * {Types::StopWorkspacesResult#failed_requests #failed_requests} => Array<Types::FailedWorkspaceChangeRequest>
|
|
755
|
+
#
|
|
756
|
+
# @example Request syntax with placeholder values
|
|
757
|
+
#
|
|
758
|
+
# resp = client.stop_workspaces({
|
|
759
|
+
# stop_workspace_requests: [ # required
|
|
760
|
+
# {
|
|
761
|
+
# workspace_id: "WorkspaceId",
|
|
762
|
+
# },
|
|
763
|
+
# ],
|
|
764
|
+
# })
|
|
765
|
+
#
|
|
766
|
+
# @example Response structure
|
|
767
|
+
#
|
|
768
|
+
# resp.failed_requests #=> Array
|
|
769
|
+
# resp.failed_requests[0].workspace_id #=> String
|
|
770
|
+
# resp.failed_requests[0].error_code #=> String
|
|
771
|
+
# resp.failed_requests[0].error_message #=> String
|
|
772
|
+
#
|
|
773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces AWS API Documentation
|
|
774
|
+
#
|
|
775
|
+
# @overload stop_workspaces(params = {})
|
|
776
|
+
# @param [Hash] params ({})
|
|
777
|
+
def stop_workspaces(params = {}, options = {})
|
|
778
|
+
req = build_request(:stop_workspaces, params)
|
|
779
|
+
req.send_request(options)
|
|
780
|
+
end
|
|
705
781
|
|
|
706
|
-
|
|
782
|
+
# Terminates the specified WorkSpaces.
|
|
783
|
+
#
|
|
784
|
+
# Terminating a WorkSpace is a permanent action and cannot be undone.
|
|
785
|
+
# The user's data is not maintained and will be destroyed. If you need
|
|
786
|
+
# to archive any user data, contact Amazon Web Services before
|
|
787
|
+
# terminating the WorkSpace.
|
|
788
|
+
#
|
|
789
|
+
# You can terminate a WorkSpace that is in any state except `SUSPENDED`.
|
|
790
|
+
#
|
|
791
|
+
# <note markdown="1"> This operation is asynchronous and returns before the WorkSpaces have
|
|
792
|
+
# been completely terminated.
|
|
793
|
+
#
|
|
794
|
+
# </note>
|
|
795
|
+
#
|
|
796
|
+
# @option params [required, Array<Types::TerminateRequest>] :terminate_workspace_requests
|
|
797
|
+
# An array of structures that specify the WorkSpaces to terminate.
|
|
798
|
+
#
|
|
799
|
+
# @return [Types::TerminateWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
800
|
+
#
|
|
801
|
+
# * {Types::TerminateWorkspacesResult#failed_requests #failed_requests} => Array<Types::FailedWorkspaceChangeRequest>
|
|
802
|
+
#
|
|
803
|
+
# @example Request syntax with placeholder values
|
|
804
|
+
#
|
|
805
|
+
# resp = client.terminate_workspaces({
|
|
806
|
+
# terminate_workspace_requests: [ # required
|
|
807
|
+
# {
|
|
808
|
+
# workspace_id: "WorkspaceId", # required
|
|
809
|
+
# },
|
|
810
|
+
# ],
|
|
811
|
+
# })
|
|
812
|
+
#
|
|
813
|
+
# @example Response structure
|
|
814
|
+
#
|
|
815
|
+
# resp.failed_requests #=> Array
|
|
816
|
+
# resp.failed_requests[0].workspace_id #=> String
|
|
817
|
+
# resp.failed_requests[0].error_code #=> String
|
|
818
|
+
# resp.failed_requests[0].error_message #=> String
|
|
819
|
+
#
|
|
820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces AWS API Documentation
|
|
821
|
+
#
|
|
822
|
+
# @overload terminate_workspaces(params = {})
|
|
823
|
+
# @param [Hash] params ({})
|
|
824
|
+
def terminate_workspaces(params = {}, options = {})
|
|
825
|
+
req = build_request(:terminate_workspaces, params)
|
|
826
|
+
req.send_request(options)
|
|
827
|
+
end
|
|
707
828
|
|
|
708
|
-
|
|
709
|
-
# @api private
|
|
710
|
-
def build_request(operation_name, params = {})
|
|
711
|
-
handlers = @handlers.for(operation_name)
|
|
712
|
-
context = Seahorse::Client::RequestContext.new(
|
|
713
|
-
operation_name: operation_name,
|
|
714
|
-
operation: config.api.operation(operation_name),
|
|
715
|
-
client: self,
|
|
716
|
-
params: params,
|
|
717
|
-
config: config)
|
|
718
|
-
context[:gem_name] = 'aws-sdk-workspaces'
|
|
719
|
-
context[:gem_version] = '1.0.0.rc1'
|
|
720
|
-
Seahorse::Client::Request.new(handlers, context)
|
|
721
|
-
end
|
|
829
|
+
# @!endgroup
|
|
722
830
|
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
831
|
+
# @param params ({})
|
|
832
|
+
# @api private
|
|
833
|
+
def build_request(operation_name, params = {})
|
|
834
|
+
handlers = @handlers.for(operation_name)
|
|
835
|
+
context = Seahorse::Client::RequestContext.new(
|
|
836
|
+
operation_name: operation_name,
|
|
837
|
+
operation: config.api.operation(operation_name),
|
|
838
|
+
client: self,
|
|
839
|
+
params: params,
|
|
840
|
+
config: config)
|
|
841
|
+
context[:gem_name] = 'aws-sdk-workspaces'
|
|
842
|
+
context[:gem_version] = '1.0.0.rc2'
|
|
843
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
844
|
+
end
|
|
728
845
|
|
|
729
|
-
|
|
846
|
+
# @api private
|
|
847
|
+
# @deprecated
|
|
848
|
+
def waiter_names
|
|
849
|
+
[]
|
|
850
|
+
end
|
|
730
851
|
|
|
731
|
-
|
|
732
|
-
attr_reader :identifier
|
|
852
|
+
class << self
|
|
733
853
|
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
Errors
|
|
737
|
-
end
|
|
854
|
+
# @api private
|
|
855
|
+
attr_reader :identifier
|
|
738
856
|
|
|
857
|
+
# @api private
|
|
858
|
+
def errors_module
|
|
859
|
+
Errors
|
|
739
860
|
end
|
|
861
|
+
|
|
740
862
|
end
|
|
741
863
|
end
|
|
742
864
|
end
|