aws-sdk-worklink 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-worklink.rb +47 -0
- data/lib/aws-sdk-worklink/client.rb +927 -0
- data/lib/aws-sdk-worklink/client_api.rb +579 -0
- data/lib/aws-sdk-worklink/customizations.rb +0 -0
- data/lib/aws-sdk-worklink/errors.rb +14 -0
- data/lib/aws-sdk-worklink/resource.rb +23 -0
- data/lib/aws-sdk-worklink/types.rb +890 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8860139e55a5aaf18490959c704b84cc8d9ac91a
|
4
|
+
data.tar.gz: 19ee69dca6bc01cfaa9148dc8835295bf5187eee
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: dd3f538cc300fa0fbfdd9ed0242ffa6df7e25562bf1d89dae6550a401eb5aa0bc9f36dc026658f91c67f2d96540cdbbb11fbb8c2e88c5ee11be8c0db936ddd4e
|
7
|
+
data.tar.gz: 1199394309b5520c77ed92f06bab640d2843aa208a649c16d32585cc89d9a72daabb1b09ce6cb3f7fb88f06a36fe995430454b014a1e04d12b6c308964c9b6c9
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-worklink/types'
|
12
|
+
require_relative 'aws-sdk-worklink/client_api'
|
13
|
+
require_relative 'aws-sdk-worklink/client'
|
14
|
+
require_relative 'aws-sdk-worklink/errors'
|
15
|
+
require_relative 'aws-sdk-worklink/resource'
|
16
|
+
require_relative 'aws-sdk-worklink/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon WorkLink. This module is available in the
|
19
|
+
# `aws-sdk-worklink` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon WorkLink all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::WorkLink::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::WorkLink
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,927 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
27
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
28
|
+
|
29
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:worklink)
|
30
|
+
|
31
|
+
module Aws::WorkLink
|
32
|
+
class Client < Seahorse::Client::Base
|
33
|
+
|
34
|
+
include Aws::ClientStubs
|
35
|
+
|
36
|
+
@identifier = :worklink
|
37
|
+
|
38
|
+
set_api(ClientApi::API)
|
39
|
+
|
40
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
41
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
42
|
+
add_plugin(Aws::Plugins::Logging)
|
43
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
44
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
45
|
+
add_plugin(Aws::Plugins::UserAgent)
|
46
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
47
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
48
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
49
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
50
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
51
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
52
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
53
|
+
add_plugin(Aws::Plugins::StubResponses)
|
54
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
55
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
56
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
58
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
59
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
60
|
+
|
61
|
+
# @overload initialize(options)
|
62
|
+
# @param [Hash] options
|
63
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
64
|
+
# Your AWS credentials. This can be an instance of any one of the
|
65
|
+
# following classes:
|
66
|
+
#
|
67
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
68
|
+
# credentials.
|
69
|
+
#
|
70
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
71
|
+
# from an EC2 IMDS on an EC2 instance.
|
72
|
+
#
|
73
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
74
|
+
# shared file, such as `~/.aws/config`.
|
75
|
+
#
|
76
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
77
|
+
#
|
78
|
+
# When `:credentials` are not configured directly, the following
|
79
|
+
# locations will be searched for credentials:
|
80
|
+
#
|
81
|
+
# * `Aws.config[:credentials]`
|
82
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
83
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
84
|
+
# * `~/.aws/credentials`
|
85
|
+
# * `~/.aws/config`
|
86
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
87
|
+
# very aggressive. Construct and pass an instance of
|
88
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
89
|
+
# timeouts.
|
90
|
+
#
|
91
|
+
# @option options [required, String] :region
|
92
|
+
# The AWS region to connect to. The configured `:region` is
|
93
|
+
# used to determine the service `:endpoint`. When not passed,
|
94
|
+
# a default `:region` is search for in the following locations:
|
95
|
+
#
|
96
|
+
# * `Aws.config[:region]`
|
97
|
+
# * `ENV['AWS_REGION']`
|
98
|
+
# * `ENV['AMAZON_REGION']`
|
99
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
100
|
+
# * `~/.aws/credentials`
|
101
|
+
# * `~/.aws/config`
|
102
|
+
#
|
103
|
+
# @option options [String] :access_key_id
|
104
|
+
#
|
105
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
106
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
107
|
+
# the background every 60 secs (default). Defaults to `false`.
|
108
|
+
#
|
109
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
110
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
111
|
+
# this client.
|
112
|
+
#
|
113
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
114
|
+
# Allows you to provide an identifier for this client which will be attached to
|
115
|
+
# all generated client side metrics. Defaults to an empty string.
|
116
|
+
#
|
117
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
118
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
119
|
+
# agent is running on, where client metrics will be published via UDP.
|
120
|
+
#
|
121
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
122
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
123
|
+
# will use the Client Side Monitoring Agent Publisher.
|
124
|
+
#
|
125
|
+
# @option options [Boolean] :convert_params (true)
|
126
|
+
# When `true`, an attempt is made to coerce request parameters into
|
127
|
+
# the required types.
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
130
|
+
# Set to true to disable SDK automatically adding host prefix
|
131
|
+
# to default service endpoint when available.
|
132
|
+
#
|
133
|
+
# @option options [String] :endpoint
|
134
|
+
# The client endpoint is normally constructed from the `:region`
|
135
|
+
# option. You should only configure an `:endpoint` when connecting
|
136
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
137
|
+
#
|
138
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
139
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
140
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
141
|
+
#
|
142
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
143
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
144
|
+
#
|
145
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
146
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
147
|
+
# Use this option to config the time interval in seconds for making
|
148
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
149
|
+
#
|
150
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
151
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
152
|
+
#
|
153
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
154
|
+
# The log formatter.
|
155
|
+
#
|
156
|
+
# @option options [Symbol] :log_level (:info)
|
157
|
+
# The log level to send messages to the `:logger` at.
|
158
|
+
#
|
159
|
+
# @option options [Logger] :logger
|
160
|
+
# The Logger instance to send log messages to. If this option
|
161
|
+
# is not set, logging will be disabled.
|
162
|
+
#
|
163
|
+
# @option options [String] :profile ("default")
|
164
|
+
# Used when loading credentials from the shared credentials file
|
165
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
166
|
+
#
|
167
|
+
# @option options [Float] :retry_base_delay (0.3)
|
168
|
+
# The base delay in seconds used by the default backoff function.
|
169
|
+
#
|
170
|
+
# @option options [Symbol] :retry_jitter (:none)
|
171
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
172
|
+
#
|
173
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
174
|
+
#
|
175
|
+
# @option options [Integer] :retry_limit (3)
|
176
|
+
# The maximum number of times to retry failed requests. Only
|
177
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
178
|
+
# are retried. Generally, these are throttling errors, data
|
179
|
+
# checksum errors, networking errors, timeout errors and auth
|
180
|
+
# errors from expired credentials.
|
181
|
+
#
|
182
|
+
# @option options [Integer] :retry_max_delay (0)
|
183
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
184
|
+
#
|
185
|
+
# @option options [String] :secret_access_key
|
186
|
+
#
|
187
|
+
# @option options [String] :session_token
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :stub_responses (false)
|
190
|
+
# Causes the client to return stubbed responses. By default
|
191
|
+
# fake responses are generated and returned. You can specify
|
192
|
+
# the response data to return or errors to raise by calling
|
193
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
194
|
+
#
|
195
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
196
|
+
# requests are made, and retries are disabled.
|
197
|
+
#
|
198
|
+
# @option options [Boolean] :validate_params (true)
|
199
|
+
# When `true`, request parameters are validated before
|
200
|
+
# sending the request.
|
201
|
+
#
|
202
|
+
def initialize(*args)
|
203
|
+
super
|
204
|
+
end
|
205
|
+
|
206
|
+
# @!group API Operations
|
207
|
+
|
208
|
+
# Imports the root certificate of a certificate authority (CA) used to
|
209
|
+
# obtain TLS certificates used by associated websites within the company
|
210
|
+
# network.
|
211
|
+
#
|
212
|
+
# @option params [required, String] :fleet_arn
|
213
|
+
# The ARN of the fleet.
|
214
|
+
#
|
215
|
+
# @option params [required, String] :certificate
|
216
|
+
# The root certificate of the CA.
|
217
|
+
#
|
218
|
+
# @option params [String] :display_name
|
219
|
+
# The certificate name to display.
|
220
|
+
#
|
221
|
+
# @return [Types::AssociateWebsiteCertificateAuthorityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
222
|
+
#
|
223
|
+
# * {Types::AssociateWebsiteCertificateAuthorityResponse#website_ca_id #website_ca_id} => String
|
224
|
+
#
|
225
|
+
# @example Request syntax with placeholder values
|
226
|
+
#
|
227
|
+
# resp = client.associate_website_certificate_authority({
|
228
|
+
# fleet_arn: "FleetArn", # required
|
229
|
+
# certificate: "Certificate", # required
|
230
|
+
# display_name: "DisplayName",
|
231
|
+
# })
|
232
|
+
#
|
233
|
+
# @example Response structure
|
234
|
+
#
|
235
|
+
# resp.website_ca_id #=> String
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateWebsiteCertificateAuthority AWS API Documentation
|
238
|
+
#
|
239
|
+
# @overload associate_website_certificate_authority(params = {})
|
240
|
+
# @param [Hash] params ({})
|
241
|
+
def associate_website_certificate_authority(params = {}, options = {})
|
242
|
+
req = build_request(:associate_website_certificate_authority, params)
|
243
|
+
req.send_request(options)
|
244
|
+
end
|
245
|
+
|
246
|
+
# Creates a fleet. A fleet consists of resources and the configuration
|
247
|
+
# that delivers associated websites to authorized users who download and
|
248
|
+
# set up the Amazon WorkLink app.
|
249
|
+
#
|
250
|
+
# @option params [required, String] :fleet_name
|
251
|
+
# A unique name for the fleet.
|
252
|
+
#
|
253
|
+
# @option params [String] :display_name
|
254
|
+
# The fleet name to display.
|
255
|
+
#
|
256
|
+
# @option params [Boolean] :optimize_for_end_user_location
|
257
|
+
# The option to optimize for better performance by routing traffic
|
258
|
+
# through the closest AWS Region to users, which may be outside of your
|
259
|
+
# home Region.
|
260
|
+
#
|
261
|
+
# @return [Types::CreateFleetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
262
|
+
#
|
263
|
+
# * {Types::CreateFleetResponse#fleet_arn #fleet_arn} => String
|
264
|
+
#
|
265
|
+
# @example Request syntax with placeholder values
|
266
|
+
#
|
267
|
+
# resp = client.create_fleet({
|
268
|
+
# fleet_name: "FleetName", # required
|
269
|
+
# display_name: "DisplayName",
|
270
|
+
# optimize_for_end_user_location: false,
|
271
|
+
# })
|
272
|
+
#
|
273
|
+
# @example Response structure
|
274
|
+
#
|
275
|
+
# resp.fleet_arn #=> String
|
276
|
+
#
|
277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/CreateFleet AWS API Documentation
|
278
|
+
#
|
279
|
+
# @overload create_fleet(params = {})
|
280
|
+
# @param [Hash] params ({})
|
281
|
+
def create_fleet(params = {}, options = {})
|
282
|
+
req = build_request(:create_fleet, params)
|
283
|
+
req.send_request(options)
|
284
|
+
end
|
285
|
+
|
286
|
+
# Deletes a fleet. Prevents users from accessing previously associated
|
287
|
+
# websites.
|
288
|
+
#
|
289
|
+
# @option params [required, String] :fleet_arn
|
290
|
+
# The ARN of the fleet.
|
291
|
+
#
|
292
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
293
|
+
#
|
294
|
+
# @example Request syntax with placeholder values
|
295
|
+
#
|
296
|
+
# resp = client.delete_fleet({
|
297
|
+
# fleet_arn: "FleetArn", # required
|
298
|
+
# })
|
299
|
+
#
|
300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DeleteFleet AWS API Documentation
|
301
|
+
#
|
302
|
+
# @overload delete_fleet(params = {})
|
303
|
+
# @param [Hash] params ({})
|
304
|
+
def delete_fleet(params = {}, options = {})
|
305
|
+
req = build_request(:delete_fleet, params)
|
306
|
+
req.send_request(options)
|
307
|
+
end
|
308
|
+
|
309
|
+
# Describes the configuration for delivering audit streams to the
|
310
|
+
# customer account.
|
311
|
+
#
|
312
|
+
# @option params [required, String] :fleet_arn
|
313
|
+
# The ARN of the fleet.
|
314
|
+
#
|
315
|
+
# @return [Types::DescribeAuditStreamConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
316
|
+
#
|
317
|
+
# * {Types::DescribeAuditStreamConfigurationResponse#audit_stream_arn #audit_stream_arn} => String
|
318
|
+
#
|
319
|
+
# @example Request syntax with placeholder values
|
320
|
+
#
|
321
|
+
# resp = client.describe_audit_stream_configuration({
|
322
|
+
# fleet_arn: "FleetArn", # required
|
323
|
+
# })
|
324
|
+
#
|
325
|
+
# @example Response structure
|
326
|
+
#
|
327
|
+
# resp.audit_stream_arn #=> String
|
328
|
+
#
|
329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeAuditStreamConfiguration AWS API Documentation
|
330
|
+
#
|
331
|
+
# @overload describe_audit_stream_configuration(params = {})
|
332
|
+
# @param [Hash] params ({})
|
333
|
+
def describe_audit_stream_configuration(params = {}, options = {})
|
334
|
+
req = build_request(:describe_audit_stream_configuration, params)
|
335
|
+
req.send_request(options)
|
336
|
+
end
|
337
|
+
|
338
|
+
# Describes the networking configuration to access the internal websites
|
339
|
+
# associated with the specified fleet.
|
340
|
+
#
|
341
|
+
# @option params [required, String] :fleet_arn
|
342
|
+
# The ARN of the fleet.
|
343
|
+
#
|
344
|
+
# @return [Types::DescribeCompanyNetworkConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
345
|
+
#
|
346
|
+
# * {Types::DescribeCompanyNetworkConfigurationResponse#vpc_id #vpc_id} => String
|
347
|
+
# * {Types::DescribeCompanyNetworkConfigurationResponse#subnet_ids #subnet_ids} => Array<String>
|
348
|
+
# * {Types::DescribeCompanyNetworkConfigurationResponse#security_group_ids #security_group_ids} => Array<String>
|
349
|
+
#
|
350
|
+
# @example Request syntax with placeholder values
|
351
|
+
#
|
352
|
+
# resp = client.describe_company_network_configuration({
|
353
|
+
# fleet_arn: "FleetArn", # required
|
354
|
+
# })
|
355
|
+
#
|
356
|
+
# @example Response structure
|
357
|
+
#
|
358
|
+
# resp.vpc_id #=> String
|
359
|
+
# resp.subnet_ids #=> Array
|
360
|
+
# resp.subnet_ids[0] #=> String
|
361
|
+
# resp.security_group_ids #=> Array
|
362
|
+
# resp.security_group_ids[0] #=> String
|
363
|
+
#
|
364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeCompanyNetworkConfiguration AWS API Documentation
|
365
|
+
#
|
366
|
+
# @overload describe_company_network_configuration(params = {})
|
367
|
+
# @param [Hash] params ({})
|
368
|
+
def describe_company_network_configuration(params = {}, options = {})
|
369
|
+
req = build_request(:describe_company_network_configuration, params)
|
370
|
+
req.send_request(options)
|
371
|
+
end
|
372
|
+
|
373
|
+
# Provides information about a user's device.
|
374
|
+
#
|
375
|
+
# @option params [required, String] :fleet_arn
|
376
|
+
# The ARN of the fleet.
|
377
|
+
#
|
378
|
+
# @option params [required, String] :device_id
|
379
|
+
# A unique identifier for a registered user's device.
|
380
|
+
#
|
381
|
+
# @return [Types::DescribeDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
382
|
+
#
|
383
|
+
# * {Types::DescribeDeviceResponse#status #status} => String
|
384
|
+
# * {Types::DescribeDeviceResponse#model #model} => String
|
385
|
+
# * {Types::DescribeDeviceResponse#manufacturer #manufacturer} => String
|
386
|
+
# * {Types::DescribeDeviceResponse#operating_system #operating_system} => String
|
387
|
+
# * {Types::DescribeDeviceResponse#operating_system_version #operating_system_version} => String
|
388
|
+
# * {Types::DescribeDeviceResponse#patch_level #patch_level} => String
|
389
|
+
# * {Types::DescribeDeviceResponse#first_accessed_time #first_accessed_time} => Time
|
390
|
+
# * {Types::DescribeDeviceResponse#last_accessed_time #last_accessed_time} => Time
|
391
|
+
# * {Types::DescribeDeviceResponse#username #username} => String
|
392
|
+
#
|
393
|
+
# @example Request syntax with placeholder values
|
394
|
+
#
|
395
|
+
# resp = client.describe_device({
|
396
|
+
# fleet_arn: "FleetArn", # required
|
397
|
+
# device_id: "Id", # required
|
398
|
+
# })
|
399
|
+
#
|
400
|
+
# @example Response structure
|
401
|
+
#
|
402
|
+
# resp.status #=> String, one of "ACTIVE", "SIGNED_OUT"
|
403
|
+
# resp.model #=> String
|
404
|
+
# resp.manufacturer #=> String
|
405
|
+
# resp.operating_system #=> String
|
406
|
+
# resp.operating_system_version #=> String
|
407
|
+
# resp.patch_level #=> String
|
408
|
+
# resp.first_accessed_time #=> Time
|
409
|
+
# resp.last_accessed_time #=> Time
|
410
|
+
# resp.username #=> String
|
411
|
+
#
|
412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDevice AWS API Documentation
|
413
|
+
#
|
414
|
+
# @overload describe_device(params = {})
|
415
|
+
# @param [Hash] params ({})
|
416
|
+
def describe_device(params = {}, options = {})
|
417
|
+
req = build_request(:describe_device, params)
|
418
|
+
req.send_request(options)
|
419
|
+
end
|
420
|
+
|
421
|
+
# Describes the device policy configuration for the specified fleet.
|
422
|
+
#
|
423
|
+
# @option params [required, String] :fleet_arn
|
424
|
+
# The ARN of the fleet.
|
425
|
+
#
|
426
|
+
# @return [Types::DescribeDevicePolicyConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
427
|
+
#
|
428
|
+
# * {Types::DescribeDevicePolicyConfigurationResponse#device_ca_certificate #device_ca_certificate} => String
|
429
|
+
#
|
430
|
+
# @example Request syntax with placeholder values
|
431
|
+
#
|
432
|
+
# resp = client.describe_device_policy_configuration({
|
433
|
+
# fleet_arn: "FleetArn", # required
|
434
|
+
# })
|
435
|
+
#
|
436
|
+
# @example Response structure
|
437
|
+
#
|
438
|
+
# resp.device_ca_certificate #=> String
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDevicePolicyConfiguration AWS API Documentation
|
441
|
+
#
|
442
|
+
# @overload describe_device_policy_configuration(params = {})
|
443
|
+
# @param [Hash] params ({})
|
444
|
+
def describe_device_policy_configuration(params = {}, options = {})
|
445
|
+
req = build_request(:describe_device_policy_configuration, params)
|
446
|
+
req.send_request(options)
|
447
|
+
end
|
448
|
+
|
449
|
+
# Provides basic information for the specified fleet, excluding identity
|
450
|
+
# provider, networking, and device configuration details.
|
451
|
+
#
|
452
|
+
# @option params [required, String] :fleet_arn
|
453
|
+
# The ARN of the fleet.
|
454
|
+
#
|
455
|
+
# @return [Types::DescribeFleetMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
456
|
+
#
|
457
|
+
# * {Types::DescribeFleetMetadataResponse#created_time #created_time} => Time
|
458
|
+
# * {Types::DescribeFleetMetadataResponse#last_updated_time #last_updated_time} => Time
|
459
|
+
# * {Types::DescribeFleetMetadataResponse#fleet_name #fleet_name} => String
|
460
|
+
# * {Types::DescribeFleetMetadataResponse#display_name #display_name} => String
|
461
|
+
# * {Types::DescribeFleetMetadataResponse#optimize_for_end_user_location #optimize_for_end_user_location} => Boolean
|
462
|
+
# * {Types::DescribeFleetMetadataResponse#company_code #company_code} => String
|
463
|
+
# * {Types::DescribeFleetMetadataResponse#fleet_status #fleet_status} => String
|
464
|
+
#
|
465
|
+
# @example Request syntax with placeholder values
|
466
|
+
#
|
467
|
+
# resp = client.describe_fleet_metadata({
|
468
|
+
# fleet_arn: "FleetArn", # required
|
469
|
+
# })
|
470
|
+
#
|
471
|
+
# @example Response structure
|
472
|
+
#
|
473
|
+
# resp.created_time #=> Time
|
474
|
+
# resp.last_updated_time #=> Time
|
475
|
+
# resp.fleet_name #=> String
|
476
|
+
# resp.display_name #=> String
|
477
|
+
# resp.optimize_for_end_user_location #=> Boolean
|
478
|
+
# resp.company_code #=> String
|
479
|
+
# resp.fleet_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED_TO_CREATE", "FAILED_TO_DELETE"
|
480
|
+
#
|
481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeFleetMetadata AWS API Documentation
|
482
|
+
#
|
483
|
+
# @overload describe_fleet_metadata(params = {})
|
484
|
+
# @param [Hash] params ({})
|
485
|
+
def describe_fleet_metadata(params = {}, options = {})
|
486
|
+
req = build_request(:describe_fleet_metadata, params)
|
487
|
+
req.send_request(options)
|
488
|
+
end
|
489
|
+
|
490
|
+
# Describes the identity provider configuration of the specified fleet.
|
491
|
+
#
|
492
|
+
# @option params [required, String] :fleet_arn
|
493
|
+
# The ARN of the fleet.
|
494
|
+
#
|
495
|
+
# @return [Types::DescribeIdentityProviderConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
496
|
+
#
|
497
|
+
# * {Types::DescribeIdentityProviderConfigurationResponse#identity_provider_type #identity_provider_type} => String
|
498
|
+
# * {Types::DescribeIdentityProviderConfigurationResponse#service_provider_saml_metadata #service_provider_saml_metadata} => String
|
499
|
+
# * {Types::DescribeIdentityProviderConfigurationResponse#identity_provider_saml_metadata #identity_provider_saml_metadata} => String
|
500
|
+
#
|
501
|
+
# @example Request syntax with placeholder values
|
502
|
+
#
|
503
|
+
# resp = client.describe_identity_provider_configuration({
|
504
|
+
# fleet_arn: "FleetArn", # required
|
505
|
+
# })
|
506
|
+
#
|
507
|
+
# @example Response structure
|
508
|
+
#
|
509
|
+
# resp.identity_provider_type #=> String, one of "SAML"
|
510
|
+
# resp.service_provider_saml_metadata #=> String
|
511
|
+
# resp.identity_provider_saml_metadata #=> String
|
512
|
+
#
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeIdentityProviderConfiguration AWS API Documentation
|
514
|
+
#
|
515
|
+
# @overload describe_identity_provider_configuration(params = {})
|
516
|
+
# @param [Hash] params ({})
|
517
|
+
def describe_identity_provider_configuration(params = {}, options = {})
|
518
|
+
req = build_request(:describe_identity_provider_configuration, params)
|
519
|
+
req.send_request(options)
|
520
|
+
end
|
521
|
+
|
522
|
+
# Provides information about the certificate authority.
|
523
|
+
#
|
524
|
+
# @option params [required, String] :fleet_arn
|
525
|
+
# The ARN of the fleet.
|
526
|
+
#
|
527
|
+
# @option params [required, String] :website_ca_id
|
528
|
+
# A unique identifier for the certificate authority.
|
529
|
+
#
|
530
|
+
# @return [Types::DescribeWebsiteCertificateAuthorityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
531
|
+
#
|
532
|
+
# * {Types::DescribeWebsiteCertificateAuthorityResponse#certificate #certificate} => String
|
533
|
+
# * {Types::DescribeWebsiteCertificateAuthorityResponse#created_time #created_time} => Time
|
534
|
+
# * {Types::DescribeWebsiteCertificateAuthorityResponse#display_name #display_name} => String
|
535
|
+
#
|
536
|
+
# @example Request syntax with placeholder values
|
537
|
+
#
|
538
|
+
# resp = client.describe_website_certificate_authority({
|
539
|
+
# fleet_arn: "FleetArn", # required
|
540
|
+
# website_ca_id: "Id", # required
|
541
|
+
# })
|
542
|
+
#
|
543
|
+
# @example Response structure
|
544
|
+
#
|
545
|
+
# resp.certificate #=> String
|
546
|
+
# resp.created_time #=> Time
|
547
|
+
# resp.display_name #=> String
|
548
|
+
#
|
549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeWebsiteCertificateAuthority AWS API Documentation
|
550
|
+
#
|
551
|
+
# @overload describe_website_certificate_authority(params = {})
|
552
|
+
# @param [Hash] params ({})
|
553
|
+
def describe_website_certificate_authority(params = {}, options = {})
|
554
|
+
req = build_request(:describe_website_certificate_authority, params)
|
555
|
+
req.send_request(options)
|
556
|
+
end
|
557
|
+
|
558
|
+
# Removes a certificate authority (CA).
|
559
|
+
#
|
560
|
+
# @option params [required, String] :fleet_arn
|
561
|
+
# The ARN of the fleet.
|
562
|
+
#
|
563
|
+
# @option params [required, String] :website_ca_id
|
564
|
+
# A unique identifier for the CA.
|
565
|
+
#
|
566
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
567
|
+
#
|
568
|
+
# @example Request syntax with placeholder values
|
569
|
+
#
|
570
|
+
# resp = client.disassociate_website_certificate_authority({
|
571
|
+
# fleet_arn: "FleetArn", # required
|
572
|
+
# website_ca_id: "Id", # required
|
573
|
+
# })
|
574
|
+
#
|
575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateWebsiteCertificateAuthority AWS API Documentation
|
576
|
+
#
|
577
|
+
# @overload disassociate_website_certificate_authority(params = {})
|
578
|
+
# @param [Hash] params ({})
|
579
|
+
def disassociate_website_certificate_authority(params = {}, options = {})
|
580
|
+
req = build_request(:disassociate_website_certificate_authority, params)
|
581
|
+
req.send_request(options)
|
582
|
+
end
|
583
|
+
|
584
|
+
# Retrieves a list of devices registered with the specified fleet.
|
585
|
+
#
|
586
|
+
# @option params [required, String] :fleet_arn
|
587
|
+
# The ARN of the fleet.
|
588
|
+
#
|
589
|
+
# @option params [String] :next_token
|
590
|
+
# The pagination token used to retrieve the next page of results for
|
591
|
+
# this operation. If this value is null, it retrieves the first page.
|
592
|
+
#
|
593
|
+
# @option params [Integer] :max_results
|
594
|
+
# The maximum number of results to be included in the next page.
|
595
|
+
#
|
596
|
+
# @return [Types::ListDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
597
|
+
#
|
598
|
+
# * {Types::ListDevicesResponse#devices #devices} => Array<Types::DeviceSummary>
|
599
|
+
# * {Types::ListDevicesResponse#next_token #next_token} => String
|
600
|
+
#
|
601
|
+
# @example Request syntax with placeholder values
|
602
|
+
#
|
603
|
+
# resp = client.list_devices({
|
604
|
+
# fleet_arn: "FleetArn", # required
|
605
|
+
# next_token: "NextToken",
|
606
|
+
# max_results: 1,
|
607
|
+
# })
|
608
|
+
#
|
609
|
+
# @example Response structure
|
610
|
+
#
|
611
|
+
# resp.devices #=> Array
|
612
|
+
# resp.devices[0].device_id #=> String
|
613
|
+
# resp.devices[0].device_status #=> String, one of "ACTIVE", "SIGNED_OUT"
|
614
|
+
# resp.next_token #=> String
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListDevices AWS API Documentation
|
617
|
+
#
|
618
|
+
# @overload list_devices(params = {})
|
619
|
+
# @param [Hash] params ({})
|
620
|
+
def list_devices(params = {}, options = {})
|
621
|
+
req = build_request(:list_devices, params)
|
622
|
+
req.send_request(options)
|
623
|
+
end
|
624
|
+
|
625
|
+
# Retrieves a list of fleets for the current account and Region.
|
626
|
+
#
|
627
|
+
# @option params [String] :next_token
|
628
|
+
# The pagination token used to retrieve the next page of results for
|
629
|
+
# this operation. If this value is null, it retrieves the first page.
|
630
|
+
#
|
631
|
+
# @option params [Integer] :max_results
|
632
|
+
# The maximum number of results to be included in the next page.
|
633
|
+
#
|
634
|
+
# @return [Types::ListFleetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
635
|
+
#
|
636
|
+
# * {Types::ListFleetsResponse#fleet_summary_list #fleet_summary_list} => Array<Types::FleetSummary>
|
637
|
+
# * {Types::ListFleetsResponse#next_token #next_token} => String
|
638
|
+
#
|
639
|
+
# @example Request syntax with placeholder values
|
640
|
+
#
|
641
|
+
# resp = client.list_fleets({
|
642
|
+
# next_token: "NextToken",
|
643
|
+
# max_results: 1,
|
644
|
+
# })
|
645
|
+
#
|
646
|
+
# @example Response structure
|
647
|
+
#
|
648
|
+
# resp.fleet_summary_list #=> Array
|
649
|
+
# resp.fleet_summary_list[0].fleet_arn #=> String
|
650
|
+
# resp.fleet_summary_list[0].created_time #=> Time
|
651
|
+
# resp.fleet_summary_list[0].last_updated_time #=> Time
|
652
|
+
# resp.fleet_summary_list[0].fleet_name #=> String
|
653
|
+
# resp.fleet_summary_list[0].display_name #=> String
|
654
|
+
# resp.fleet_summary_list[0].company_code #=> String
|
655
|
+
# resp.fleet_summary_list[0].fleet_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED_TO_CREATE", "FAILED_TO_DELETE"
|
656
|
+
# resp.next_token #=> String
|
657
|
+
#
|
658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListFleets AWS API Documentation
|
659
|
+
#
|
660
|
+
# @overload list_fleets(params = {})
|
661
|
+
# @param [Hash] params ({})
|
662
|
+
def list_fleets(params = {}, options = {})
|
663
|
+
req = build_request(:list_fleets, params)
|
664
|
+
req.send_request(options)
|
665
|
+
end
|
666
|
+
|
667
|
+
# Retrieves a list of certificate authorities added for the current
|
668
|
+
# account and Region.
|
669
|
+
#
|
670
|
+
# @option params [required, String] :fleet_arn
|
671
|
+
# The ARN of the fleet.
|
672
|
+
#
|
673
|
+
# @option params [Integer] :max_results
|
674
|
+
# The maximum number of results to be included in the next page.
|
675
|
+
#
|
676
|
+
# @option params [String] :next_token
|
677
|
+
# The pagination token used to retrieve the next page of results for
|
678
|
+
# this operation. If this value is null, it retrieves the first page.
|
679
|
+
#
|
680
|
+
# @return [Types::ListWebsiteCertificateAuthoritiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
681
|
+
#
|
682
|
+
# * {Types::ListWebsiteCertificateAuthoritiesResponse#website_certificate_authorities #website_certificate_authorities} => Array<Types::WebsiteCaSummary>
|
683
|
+
# * {Types::ListWebsiteCertificateAuthoritiesResponse#next_token #next_token} => String
|
684
|
+
#
|
685
|
+
# @example Request syntax with placeholder values
|
686
|
+
#
|
687
|
+
# resp = client.list_website_certificate_authorities({
|
688
|
+
# fleet_arn: "FleetArn", # required
|
689
|
+
# max_results: 1,
|
690
|
+
# next_token: "NextToken",
|
691
|
+
# })
|
692
|
+
#
|
693
|
+
# @example Response structure
|
694
|
+
#
|
695
|
+
# resp.website_certificate_authorities #=> Array
|
696
|
+
# resp.website_certificate_authorities[0].website_ca_id #=> String
|
697
|
+
# resp.website_certificate_authorities[0].created_time #=> Time
|
698
|
+
# resp.website_certificate_authorities[0].display_name #=> String
|
699
|
+
# resp.next_token #=> String
|
700
|
+
#
|
701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListWebsiteCertificateAuthorities AWS API Documentation
|
702
|
+
#
|
703
|
+
# @overload list_website_certificate_authorities(params = {})
|
704
|
+
# @param [Hash] params ({})
|
705
|
+
def list_website_certificate_authorities(params = {}, options = {})
|
706
|
+
req = build_request(:list_website_certificate_authorities, params)
|
707
|
+
req.send_request(options)
|
708
|
+
end
|
709
|
+
|
710
|
+
# Signs the user out from all of their devices. The user can sign in
|
711
|
+
# again if they have valid credentials.
|
712
|
+
#
|
713
|
+
# @option params [required, String] :fleet_arn
|
714
|
+
# The ARN of the fleet.
|
715
|
+
#
|
716
|
+
# @option params [required, String] :username
|
717
|
+
# The name of the user.
|
718
|
+
#
|
719
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
720
|
+
#
|
721
|
+
# @example Request syntax with placeholder values
|
722
|
+
#
|
723
|
+
# resp = client.sign_out_user({
|
724
|
+
# fleet_arn: "FleetArn", # required
|
725
|
+
# username: "Username", # required
|
726
|
+
# })
|
727
|
+
#
|
728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/SignOutUser AWS API Documentation
|
729
|
+
#
|
730
|
+
# @overload sign_out_user(params = {})
|
731
|
+
# @param [Hash] params ({})
|
732
|
+
def sign_out_user(params = {}, options = {})
|
733
|
+
req = build_request(:sign_out_user, params)
|
734
|
+
req.send_request(options)
|
735
|
+
end
|
736
|
+
|
737
|
+
# Updates the audit stream configuration for the fleet.
|
738
|
+
#
|
739
|
+
# @option params [required, String] :fleet_arn
|
740
|
+
# The ARN of the fleet.
|
741
|
+
#
|
742
|
+
# @option params [String] :audit_stream_arn
|
743
|
+
# The ARN of the Amazon Kinesis data stream that receives the audit
|
744
|
+
# events.
|
745
|
+
#
|
746
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
747
|
+
#
|
748
|
+
# @example Request syntax with placeholder values
|
749
|
+
#
|
750
|
+
# resp = client.update_audit_stream_configuration({
|
751
|
+
# fleet_arn: "FleetArn", # required
|
752
|
+
# audit_stream_arn: "AuditStreamArn",
|
753
|
+
# })
|
754
|
+
#
|
755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateAuditStreamConfiguration AWS API Documentation
|
756
|
+
#
|
757
|
+
# @overload update_audit_stream_configuration(params = {})
|
758
|
+
# @param [Hash] params ({})
|
759
|
+
def update_audit_stream_configuration(params = {}, options = {})
|
760
|
+
req = build_request(:update_audit_stream_configuration, params)
|
761
|
+
req.send_request(options)
|
762
|
+
end
|
763
|
+
|
764
|
+
# Updates the company network configuration for the fleet.
|
765
|
+
#
|
766
|
+
# @option params [required, String] :fleet_arn
|
767
|
+
# The ARN of the fleet.
|
768
|
+
#
|
769
|
+
# @option params [required, String] :vpc_id
|
770
|
+
# The VPC with connectivity to associated websites.
|
771
|
+
#
|
772
|
+
# @option params [required, Array<String>] :subnet_ids
|
773
|
+
# The subnets used for X-ENI connections from Amazon WorkLink rendering
|
774
|
+
# containers.
|
775
|
+
#
|
776
|
+
# @option params [required, Array<String>] :security_group_ids
|
777
|
+
# The security groups associated with access to the provided subnets.
|
778
|
+
#
|
779
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
780
|
+
#
|
781
|
+
# @example Request syntax with placeholder values
|
782
|
+
#
|
783
|
+
# resp = client.update_company_network_configuration({
|
784
|
+
# fleet_arn: "FleetArn", # required
|
785
|
+
# vpc_id: "VpcId", # required
|
786
|
+
# subnet_ids: ["SubnetId"], # required
|
787
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
788
|
+
# })
|
789
|
+
#
|
790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateCompanyNetworkConfiguration AWS API Documentation
|
791
|
+
#
|
792
|
+
# @overload update_company_network_configuration(params = {})
|
793
|
+
# @param [Hash] params ({})
|
794
|
+
def update_company_network_configuration(params = {}, options = {})
|
795
|
+
req = build_request(:update_company_network_configuration, params)
|
796
|
+
req.send_request(options)
|
797
|
+
end
|
798
|
+
|
799
|
+
# Updates the device policy configuration for the fleet.
|
800
|
+
#
|
801
|
+
# @option params [required, String] :fleet_arn
|
802
|
+
# The ARN of the fleet.
|
803
|
+
#
|
804
|
+
# @option params [String] :device_ca_certificate
|
805
|
+
# The certificate chain, including intermediate certificates and the
|
806
|
+
# root certificate authority certificate used to issue device
|
807
|
+
# certificates.
|
808
|
+
#
|
809
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
810
|
+
#
|
811
|
+
# @example Request syntax with placeholder values
|
812
|
+
#
|
813
|
+
# resp = client.update_device_policy_configuration({
|
814
|
+
# fleet_arn: "FleetArn", # required
|
815
|
+
# device_ca_certificate: "CertificateChain",
|
816
|
+
# })
|
817
|
+
#
|
818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateDevicePolicyConfiguration AWS API Documentation
|
819
|
+
#
|
820
|
+
# @overload update_device_policy_configuration(params = {})
|
821
|
+
# @param [Hash] params ({})
|
822
|
+
def update_device_policy_configuration(params = {}, options = {})
|
823
|
+
req = build_request(:update_device_policy_configuration, params)
|
824
|
+
req.send_request(options)
|
825
|
+
end
|
826
|
+
|
827
|
+
# Updates fleet metadata, such as DisplayName.
|
828
|
+
#
|
829
|
+
# @option params [required, String] :fleet_arn
|
830
|
+
# The ARN of the fleet.
|
831
|
+
#
|
832
|
+
# @option params [String] :display_name
|
833
|
+
# The fleet name to display. The existing DisplayName is unset if null
|
834
|
+
# is passed.
|
835
|
+
#
|
836
|
+
# @option params [Boolean] :optimize_for_end_user_location
|
837
|
+
# The option to optimize for better performance by routing traffic
|
838
|
+
# through the closest AWS Region to users, which may be outside of your
|
839
|
+
# home Region.
|
840
|
+
#
|
841
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
842
|
+
#
|
843
|
+
# @example Request syntax with placeholder values
|
844
|
+
#
|
845
|
+
# resp = client.update_fleet_metadata({
|
846
|
+
# fleet_arn: "FleetArn", # required
|
847
|
+
# display_name: "DisplayName",
|
848
|
+
# optimize_for_end_user_location: false,
|
849
|
+
# })
|
850
|
+
#
|
851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateFleetMetadata AWS API Documentation
|
852
|
+
#
|
853
|
+
# @overload update_fleet_metadata(params = {})
|
854
|
+
# @param [Hash] params ({})
|
855
|
+
def update_fleet_metadata(params = {}, options = {})
|
856
|
+
req = build_request(:update_fleet_metadata, params)
|
857
|
+
req.send_request(options)
|
858
|
+
end
|
859
|
+
|
860
|
+
# Updates the identity provider configuration for the fleet.
|
861
|
+
#
|
862
|
+
# @option params [required, String] :fleet_arn
|
863
|
+
# The ARN of the fleet.
|
864
|
+
#
|
865
|
+
# @option params [required, String] :identity_provider_type
|
866
|
+
# The type of identity provider.
|
867
|
+
#
|
868
|
+
# @option params [String] :identity_provider_saml_metadata
|
869
|
+
# The SAML metadata document provided by the customer’s identity
|
870
|
+
# provider. The existing IdentityProviderSamlMetadata is unset if null
|
871
|
+
# is passed.
|
872
|
+
#
|
873
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
874
|
+
#
|
875
|
+
# @example Request syntax with placeholder values
|
876
|
+
#
|
877
|
+
# resp = client.update_identity_provider_configuration({
|
878
|
+
# fleet_arn: "FleetArn", # required
|
879
|
+
# identity_provider_type: "SAML", # required, accepts SAML
|
880
|
+
# identity_provider_saml_metadata: "SamlMetadata",
|
881
|
+
# })
|
882
|
+
#
|
883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateIdentityProviderConfiguration AWS API Documentation
|
884
|
+
#
|
885
|
+
# @overload update_identity_provider_configuration(params = {})
|
886
|
+
# @param [Hash] params ({})
|
887
|
+
def update_identity_provider_configuration(params = {}, options = {})
|
888
|
+
req = build_request(:update_identity_provider_configuration, params)
|
889
|
+
req.send_request(options)
|
890
|
+
end
|
891
|
+
|
892
|
+
# @!endgroup
|
893
|
+
|
894
|
+
# @param params ({})
|
895
|
+
# @api private
|
896
|
+
def build_request(operation_name, params = {})
|
897
|
+
handlers = @handlers.for(operation_name)
|
898
|
+
context = Seahorse::Client::RequestContext.new(
|
899
|
+
operation_name: operation_name,
|
900
|
+
operation: config.api.operation(operation_name),
|
901
|
+
client: self,
|
902
|
+
params: params,
|
903
|
+
config: config)
|
904
|
+
context[:gem_name] = 'aws-sdk-worklink'
|
905
|
+
context[:gem_version] = '1.0.0'
|
906
|
+
Seahorse::Client::Request.new(handlers, context)
|
907
|
+
end
|
908
|
+
|
909
|
+
# @api private
|
910
|
+
# @deprecated
|
911
|
+
def waiter_names
|
912
|
+
[]
|
913
|
+
end
|
914
|
+
|
915
|
+
class << self
|
916
|
+
|
917
|
+
# @api private
|
918
|
+
attr_reader :identifier
|
919
|
+
|
920
|
+
# @api private
|
921
|
+
def errors_module
|
922
|
+
Errors
|
923
|
+
end
|
924
|
+
|
925
|
+
end
|
926
|
+
end
|
927
|
+
end
|