UNPKG

39.5 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class WorkLink extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: WorkLink.Types.ClientConfiguration)
13 config: Config & WorkLink.Types.ClientConfiguration;
14 /**
15 * Specifies a domain to be associated to Amazon WorkLink.
16 */
17 associateDomain(params: WorkLink.Types.AssociateDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateDomainResponse) => void): Request<WorkLink.Types.AssociateDomainResponse, AWSError>;
18 /**
19 * Specifies a domain to be associated to Amazon WorkLink.
20 */
21 associateDomain(callback?: (err: AWSError, data: WorkLink.Types.AssociateDomainResponse) => void): Request<WorkLink.Types.AssociateDomainResponse, AWSError>;
22 /**
23 * Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
24 */
25 associateWebsiteAuthorizationProvider(params: WorkLink.Types.AssociateWebsiteAuthorizationProviderRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse, AWSError>;
26 /**
27 * Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
28 */
29 associateWebsiteAuthorizationProvider(callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse, AWSError>;
30 /**
31 * Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
32 */
33 associateWebsiteCertificateAuthority(params: WorkLink.Types.AssociateWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse, AWSError>;
34 /**
35 * Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
36 */
37 associateWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse, AWSError>;
38 /**
39 * Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.
40 */
41 createFleet(params: WorkLink.Types.CreateFleetRequest, callback?: (err: AWSError, data: WorkLink.Types.CreateFleetResponse) => void): Request<WorkLink.Types.CreateFleetResponse, AWSError>;
42 /**
43 * Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.
44 */
45 createFleet(callback?: (err: AWSError, data: WorkLink.Types.CreateFleetResponse) => void): Request<WorkLink.Types.CreateFleetResponse, AWSError>;
46 /**
47 * Deletes a fleet. Prevents users from accessing previously associated websites.
48 */
49 deleteFleet(params: WorkLink.Types.DeleteFleetRequest, callback?: (err: AWSError, data: WorkLink.Types.DeleteFleetResponse) => void): Request<WorkLink.Types.DeleteFleetResponse, AWSError>;
50 /**
51 * Deletes a fleet. Prevents users from accessing previously associated websites.
52 */
53 deleteFleet(callback?: (err: AWSError, data: WorkLink.Types.DeleteFleetResponse) => void): Request<WorkLink.Types.DeleteFleetResponse, AWSError>;
54 /**
55 * Describes the configuration for delivering audit streams to the customer account.
56 */
57 describeAuditStreamConfiguration(params: WorkLink.Types.DescribeAuditStreamConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.DescribeAuditStreamConfigurationResponse, AWSError>;
58 /**
59 * Describes the configuration for delivering audit streams to the customer account.
60 */
61 describeAuditStreamConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.DescribeAuditStreamConfigurationResponse, AWSError>;
62 /**
63 * Describes the networking configuration to access the internal websites associated with the specified fleet.
64 */
65 describeCompanyNetworkConfiguration(params: WorkLink.Types.DescribeCompanyNetworkConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.DescribeCompanyNetworkConfigurationResponse, AWSError>;
66 /**
67 * Describes the networking configuration to access the internal websites associated with the specified fleet.
68 */
69 describeCompanyNetworkConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.DescribeCompanyNetworkConfigurationResponse, AWSError>;
70 /**
71 * Provides information about a user's device.
72 */
73 describeDevice(params: WorkLink.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDeviceResponse) => void): Request<WorkLink.Types.DescribeDeviceResponse, AWSError>;
74 /**
75 * Provides information about a user's device.
76 */
77 describeDevice(callback?: (err: AWSError, data: WorkLink.Types.DescribeDeviceResponse) => void): Request<WorkLink.Types.DescribeDeviceResponse, AWSError>;
78 /**
79 * Describes the device policy configuration for the specified fleet.
80 */
81 describeDevicePolicyConfiguration(params: WorkLink.Types.DescribeDevicePolicyConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.DescribeDevicePolicyConfigurationResponse, AWSError>;
82 /**
83 * Describes the device policy configuration for the specified fleet.
84 */
85 describeDevicePolicyConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.DescribeDevicePolicyConfigurationResponse, AWSError>;
86 /**
87 * Provides information about the domain.
88 */
89 describeDomain(params: WorkLink.Types.DescribeDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDomainResponse) => void): Request<WorkLink.Types.DescribeDomainResponse, AWSError>;
90 /**
91 * Provides information about the domain.
92 */
93 describeDomain(callback?: (err: AWSError, data: WorkLink.Types.DescribeDomainResponse) => void): Request<WorkLink.Types.DescribeDomainResponse, AWSError>;
94 /**
95 * Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
96 */
97 describeFleetMetadata(params: WorkLink.Types.DescribeFleetMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeFleetMetadataResponse) => void): Request<WorkLink.Types.DescribeFleetMetadataResponse, AWSError>;
98 /**
99 * Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
100 */
101 describeFleetMetadata(callback?: (err: AWSError, data: WorkLink.Types.DescribeFleetMetadataResponse) => void): Request<WorkLink.Types.DescribeFleetMetadataResponse, AWSError>;
102 /**
103 * Describes the identity provider configuration of the specified fleet.
104 */
105 describeIdentityProviderConfiguration(params: WorkLink.Types.DescribeIdentityProviderConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.DescribeIdentityProviderConfigurationResponse, AWSError>;
106 /**
107 * Describes the identity provider configuration of the specified fleet.
108 */
109 describeIdentityProviderConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.DescribeIdentityProviderConfigurationResponse, AWSError>;
110 /**
111 * Provides information about the certificate authority.
112 */
113 describeWebsiteCertificateAuthority(params: WorkLink.Types.DescribeWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse, AWSError>;
114 /**
115 * Provides information about the certificate authority.
116 */
117 describeWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse, AWSError>;
118 /**
119 * Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
120 */
121 disassociateDomain(params: WorkLink.Types.DisassociateDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateDomainResponse) => void): Request<WorkLink.Types.DisassociateDomainResponse, AWSError>;
122 /**
123 * Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
124 */
125 disassociateDomain(callback?: (err: AWSError, data: WorkLink.Types.DisassociateDomainResponse) => void): Request<WorkLink.Types.DisassociateDomainResponse, AWSError>;
126 /**
127 * Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.
128 */
129 disassociateWebsiteAuthorizationProvider(params: WorkLink.Types.DisassociateWebsiteAuthorizationProviderRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse, AWSError>;
130 /**
131 * Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.
132 */
133 disassociateWebsiteAuthorizationProvider(callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse, AWSError>;
134 /**
135 * Removes a certificate authority (CA).
136 */
137 disassociateWebsiteCertificateAuthority(params: WorkLink.Types.DisassociateWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse, AWSError>;
138 /**
139 * Removes a certificate authority (CA).
140 */
141 disassociateWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse, AWSError>;
142 /**
143 * Retrieves a list of devices registered with the specified fleet.
144 */
145 listDevices(params: WorkLink.Types.ListDevicesRequest, callback?: (err: AWSError, data: WorkLink.Types.ListDevicesResponse) => void): Request<WorkLink.Types.ListDevicesResponse, AWSError>;
146 /**
147 * Retrieves a list of devices registered with the specified fleet.
148 */
149 listDevices(callback?: (err: AWSError, data: WorkLink.Types.ListDevicesResponse) => void): Request<WorkLink.Types.ListDevicesResponse, AWSError>;
150 /**
151 * Retrieves a list of domains associated to a specified fleet.
152 */
153 listDomains(params: WorkLink.Types.ListDomainsRequest, callback?: (err: AWSError, data: WorkLink.Types.ListDomainsResponse) => void): Request<WorkLink.Types.ListDomainsResponse, AWSError>;
154 /**
155 * Retrieves a list of domains associated to a specified fleet.
156 */
157 listDomains(callback?: (err: AWSError, data: WorkLink.Types.ListDomainsResponse) => void): Request<WorkLink.Types.ListDomainsResponse, AWSError>;
158 /**
159 * Retrieves a list of fleets for the current account and Region.
160 */
161 listFleets(params: WorkLink.Types.ListFleetsRequest, callback?: (err: AWSError, data: WorkLink.Types.ListFleetsResponse) => void): Request<WorkLink.Types.ListFleetsResponse, AWSError>;
162 /**
163 * Retrieves a list of fleets for the current account and Region.
164 */
165 listFleets(callback?: (err: AWSError, data: WorkLink.Types.ListFleetsResponse) => void): Request<WorkLink.Types.ListFleetsResponse, AWSError>;
166 /**
167 * Retrieves a list of website authorization providers associated with a specified fleet.
168 */
169 listWebsiteAuthorizationProviders(params: WorkLink.Types.ListWebsiteAuthorizationProvidersRequest, callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteAuthorizationProvidersResponse) => void): Request<WorkLink.Types.ListWebsiteAuthorizationProvidersResponse, AWSError>;
170 /**
171 * Retrieves a list of website authorization providers associated with a specified fleet.
172 */
173 listWebsiteAuthorizationProviders(callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteAuthorizationProvidersResponse) => void): Request<WorkLink.Types.ListWebsiteAuthorizationProvidersResponse, AWSError>;
174 /**
175 * Retrieves a list of certificate authorities added for the current account and Region.
176 */
177 listWebsiteCertificateAuthorities(params: WorkLink.Types.ListWebsiteCertificateAuthoritiesRequest, callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse) => void): Request<WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse, AWSError>;
178 /**
179 * Retrieves a list of certificate authorities added for the current account and Region.
180 */
181 listWebsiteCertificateAuthorities(callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse) => void): Request<WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse, AWSError>;
182 /**
183 * Moves a domain to ACTIVE status if it was in the INACTIVE status.
184 */
185 restoreDomainAccess(params: WorkLink.Types.RestoreDomainAccessRequest, callback?: (err: AWSError, data: WorkLink.Types.RestoreDomainAccessResponse) => void): Request<WorkLink.Types.RestoreDomainAccessResponse, AWSError>;
186 /**
187 * Moves a domain to ACTIVE status if it was in the INACTIVE status.
188 */
189 restoreDomainAccess(callback?: (err: AWSError, data: WorkLink.Types.RestoreDomainAccessResponse) => void): Request<WorkLink.Types.RestoreDomainAccessResponse, AWSError>;
190 /**
191 * Moves a domain to INACTIVE status if it was in the ACTIVE status.
192 */
193 revokeDomainAccess(params: WorkLink.Types.RevokeDomainAccessRequest, callback?: (err: AWSError, data: WorkLink.Types.RevokeDomainAccessResponse) => void): Request<WorkLink.Types.RevokeDomainAccessResponse, AWSError>;
194 /**
195 * Moves a domain to INACTIVE status if it was in the ACTIVE status.
196 */
197 revokeDomainAccess(callback?: (err: AWSError, data: WorkLink.Types.RevokeDomainAccessResponse) => void): Request<WorkLink.Types.RevokeDomainAccessResponse, AWSError>;
198 /**
199 * Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
200 */
201 signOutUser(params: WorkLink.Types.SignOutUserRequest, callback?: (err: AWSError, data: WorkLink.Types.SignOutUserResponse) => void): Request<WorkLink.Types.SignOutUserResponse, AWSError>;
202 /**
203 * Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
204 */
205 signOutUser(callback?: (err: AWSError, data: WorkLink.Types.SignOutUserResponse) => void): Request<WorkLink.Types.SignOutUserResponse, AWSError>;
206 /**
207 * Updates the audit stream configuration for the fleet.
208 */
209 updateAuditStreamConfiguration(params: WorkLink.Types.UpdateAuditStreamConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.UpdateAuditStreamConfigurationResponse, AWSError>;
210 /**
211 * Updates the audit stream configuration for the fleet.
212 */
213 updateAuditStreamConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.UpdateAuditStreamConfigurationResponse, AWSError>;
214 /**
215 * Updates the company network configuration for the fleet.
216 */
217 updateCompanyNetworkConfiguration(params: WorkLink.Types.UpdateCompanyNetworkConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.UpdateCompanyNetworkConfigurationResponse, AWSError>;
218 /**
219 * Updates the company network configuration for the fleet.
220 */
221 updateCompanyNetworkConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.UpdateCompanyNetworkConfigurationResponse, AWSError>;
222 /**
223 * Updates the device policy configuration for the fleet.
224 */
225 updateDevicePolicyConfiguration(params: WorkLink.Types.UpdateDevicePolicyConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.UpdateDevicePolicyConfigurationResponse, AWSError>;
226 /**
227 * Updates the device policy configuration for the fleet.
228 */
229 updateDevicePolicyConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.UpdateDevicePolicyConfigurationResponse, AWSError>;
230 /**
231 * Updates domain metadata, such as DisplayName.
232 */
233 updateDomainMetadata(params: WorkLink.Types.UpdateDomainMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateDomainMetadataResponse) => void): Request<WorkLink.Types.UpdateDomainMetadataResponse, AWSError>;
234 /**
235 * Updates domain metadata, such as DisplayName.
236 */
237 updateDomainMetadata(callback?: (err: AWSError, data: WorkLink.Types.UpdateDomainMetadataResponse) => void): Request<WorkLink.Types.UpdateDomainMetadataResponse, AWSError>;
238 /**
239 * Updates fleet metadata, such as DisplayName.
240 */
241 updateFleetMetadata(params: WorkLink.Types.UpdateFleetMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateFleetMetadataResponse) => void): Request<WorkLink.Types.UpdateFleetMetadataResponse, AWSError>;
242 /**
243 * Updates fleet metadata, such as DisplayName.
244 */
245 updateFleetMetadata(callback?: (err: AWSError, data: WorkLink.Types.UpdateFleetMetadataResponse) => void): Request<WorkLink.Types.UpdateFleetMetadataResponse, AWSError>;
246 /**
247 * Updates the identity provider configuration for the fleet.
248 */
249 updateIdentityProviderConfiguration(params: WorkLink.Types.UpdateIdentityProviderConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.UpdateIdentityProviderConfigurationResponse, AWSError>;
250 /**
251 * Updates the identity provider configuration for the fleet.
252 */
253 updateIdentityProviderConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.UpdateIdentityProviderConfigurationResponse, AWSError>;
254}
255declare namespace WorkLink {
256 export type AcmCertificateArn = string;
257 export interface AssociateDomainRequest {
258 /**
259 * The Amazon Resource Name (ARN) of the fleet.
260 */
261 FleetArn: FleetArn;
262 /**
263 * The fully qualified domain name (FQDN).
264 */
265 DomainName: DomainName;
266 /**
267 * The name to display.
268 */
269 DisplayName?: DisplayName;
270 /**
271 * The ARN of an issued ACM certificate that is valid for the domain being associated.
272 */
273 AcmCertificateArn: AcmCertificateArn;
274 }
275 export interface AssociateDomainResponse {
276 }
277 export interface AssociateWebsiteAuthorizationProviderRequest {
278 /**
279 * The ARN of the fleet.
280 */
281 FleetArn: FleetArn;
282 /**
283 * The authorization provider type.
284 */
285 AuthorizationProviderType: AuthorizationProviderType;
286 /**
287 * The domain name of the authorization provider. This applies only to SAML-based authorization providers.
288 */
289 DomainName?: DomainName;
290 }
291 export interface AssociateWebsiteAuthorizationProviderResponse {
292 /**
293 * A unique identifier for the authorization provider.
294 */
295 AuthorizationProviderId?: Id;
296 }
297 export interface AssociateWebsiteCertificateAuthorityRequest {
298 /**
299 * The ARN of the fleet.
300 */
301 FleetArn: FleetArn;
302 /**
303 * The root certificate of the CA.
304 */
305 Certificate: Certificate;
306 /**
307 * The certificate name to display.
308 */
309 DisplayName?: DisplayName;
310 }
311 export interface AssociateWebsiteCertificateAuthorityResponse {
312 /**
313 * A unique identifier for the CA.
314 */
315 WebsiteCaId?: Id;
316 }
317 export type AuditStreamArn = string;
318 export type AuthorizationProviderType = "SAML"|string;
319 export type Boolean = boolean;
320 export type Certificate = string;
321 export type CertificateChain = string;
322 export type CompanyCode = string;
323 export interface CreateFleetRequest {
324 /**
325 * A unique name for the fleet.
326 */
327 FleetName: FleetName;
328 /**
329 * The fleet name to display.
330 */
331 DisplayName?: DisplayName;
332 /**
333 * The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
334 */
335 OptimizeForEndUserLocation?: Boolean;
336 }
337 export interface CreateFleetResponse {
338 /**
339 * The ARN of the fleet.
340 */
341 FleetArn?: FleetArn;
342 }
343 export type DateTime = Date;
344 export interface DeleteFleetRequest {
345 /**
346 * The ARN of the fleet.
347 */
348 FleetArn: FleetArn;
349 }
350 export interface DeleteFleetResponse {
351 }
352 export interface DescribeAuditStreamConfigurationRequest {
353 /**
354 * The ARN of the fleet.
355 */
356 FleetArn: FleetArn;
357 }
358 export interface DescribeAuditStreamConfigurationResponse {
359 /**
360 * The ARN of the Amazon Kinesis data stream that will receive the audit events.
361 */
362 AuditStreamArn?: AuditStreamArn;
363 }
364 export interface DescribeCompanyNetworkConfigurationRequest {
365 /**
366 * The ARN of the fleet.
367 */
368 FleetArn: FleetArn;
369 }
370 export interface DescribeCompanyNetworkConfigurationResponse {
371 /**
372 * The VPC with connectivity to associated websites.
373 */
374 VpcId?: VpcId;
375 /**
376 * The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
377 */
378 SubnetIds?: SubnetIds;
379 /**
380 * The security groups associated with access to the provided subnets.
381 */
382 SecurityGroupIds?: SecurityGroupIds;
383 }
384 export interface DescribeDevicePolicyConfigurationRequest {
385 /**
386 * The ARN of the fleet.
387 */
388 FleetArn: FleetArn;
389 }
390 export interface DescribeDevicePolicyConfigurationResponse {
391 /**
392 * The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
393 */
394 DeviceCaCertificate?: Certificate;
395 }
396 export interface DescribeDeviceRequest {
397 /**
398 * The ARN of the fleet.
399 */
400 FleetArn: FleetArn;
401 /**
402 * A unique identifier for a registered user's device.
403 */
404 DeviceId: Id;
405 }
406 export interface DescribeDeviceResponse {
407 /**
408 * The current state of the device.
409 */
410 Status?: DeviceStatus;
411 /**
412 * The model of the device.
413 */
414 Model?: DeviceModel;
415 /**
416 * The manufacturer of the device.
417 */
418 Manufacturer?: DeviceManufacturer;
419 /**
420 * The operating system of the device.
421 */
422 OperatingSystem?: DeviceOperatingSystemName;
423 /**
424 * The operating system version of the device.
425 */
426 OperatingSystemVersion?: DeviceOperatingSystemVersion;
427 /**
428 * The operating system patch level of the device.
429 */
430 PatchLevel?: DevicePatchLevel;
431 /**
432 * The date that the device first signed in to Amazon WorkLink.
433 */
434 FirstAccessedTime?: DateTime;
435 /**
436 * The date that the device last accessed Amazon WorkLink.
437 */
438 LastAccessedTime?: DateTime;
439 /**
440 * The user name associated with the device.
441 */
442 Username?: Username;
443 }
444 export interface DescribeDomainRequest {
445 /**
446 * The ARN of the fleet.
447 */
448 FleetArn: FleetArn;
449 /**
450 * The name of the domain.
451 */
452 DomainName: DomainName;
453 }
454 export interface DescribeDomainResponse {
455 /**
456 * The name of the domain.
457 */
458 DomainName?: DomainName;
459 /**
460 * The name to display.
461 */
462 DisplayName?: DisplayName;
463 /**
464 * The time that the domain was added.
465 */
466 CreatedTime?: DateTime;
467 /**
468 * The current state for the domain.
469 */
470 DomainStatus?: DomainStatus;
471 /**
472 * The ARN of an issued ACM certificate that is valid for the domain being associated.
473 */
474 AcmCertificateArn?: AcmCertificateArn;
475 }
476 export interface DescribeFleetMetadataRequest {
477 /**
478 * The ARN of the fleet.
479 */
480 FleetArn: FleetArn;
481 }
482 export interface DescribeFleetMetadataResponse {
483 /**
484 * The time that the fleet was created.
485 */
486 CreatedTime?: DateTime;
487 /**
488 * The time that the fleet was last updated.
489 */
490 LastUpdatedTime?: DateTime;
491 /**
492 * The name of the fleet.
493 */
494 FleetName?: FleetName;
495 /**
496 * The name to display.
497 */
498 DisplayName?: DisplayName;
499 /**
500 * The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
501 */
502 OptimizeForEndUserLocation?: Boolean;
503 /**
504 * The identifier used by users to sign in to the Amazon WorkLink app.
505 */
506 CompanyCode?: CompanyCode;
507 /**
508 * The current state of the fleet.
509 */
510 FleetStatus?: FleetStatus;
511 }
512 export interface DescribeIdentityProviderConfigurationRequest {
513 /**
514 * The ARN of the fleet.
515 */
516 FleetArn: FleetArn;
517 }
518 export interface DescribeIdentityProviderConfigurationResponse {
519 /**
520 * The type of identity provider.
521 */
522 IdentityProviderType?: IdentityProviderType;
523 /**
524 * The SAML metadata document uploaded to the user’s identity provider.
525 */
526 ServiceProviderSamlMetadata?: SamlMetadata;
527 /**
528 * The SAML metadata document provided by the user’s identity provider.
529 */
530 IdentityProviderSamlMetadata?: SamlMetadata;
531 }
532 export interface DescribeWebsiteCertificateAuthorityRequest {
533 /**
534 * The ARN of the fleet.
535 */
536 FleetArn: FleetArn;
537 /**
538 * A unique identifier for the certificate authority.
539 */
540 WebsiteCaId: Id;
541 }
542 export interface DescribeWebsiteCertificateAuthorityResponse {
543 /**
544 * The root certificate of the certificate authority.
545 */
546 Certificate?: Certificate;
547 /**
548 * The time that the certificate authority was added.
549 */
550 CreatedTime?: DateTime;
551 /**
552 * The certificate name to display.
553 */
554 DisplayName?: DisplayName;
555 }
556 export type DeviceManufacturer = string;
557 export type DeviceModel = string;
558 export type DeviceOperatingSystemName = string;
559 export type DeviceOperatingSystemVersion = string;
560 export type DevicePatchLevel = string;
561 export type DeviceStatus = "ACTIVE"|"SIGNED_OUT"|string;
562 export interface DeviceSummary {
563 /**
564 * The ID of the device.
565 */
566 DeviceId?: Id;
567 /**
568 * The status of the device.
569 */
570 DeviceStatus?: DeviceStatus;
571 }
572 export type DeviceSummaryList = DeviceSummary[];
573 export interface DisassociateDomainRequest {
574 /**
575 * The ARN of the fleet.
576 */
577 FleetArn: FleetArn;
578 /**
579 * The name of the domain.
580 */
581 DomainName: DomainName;
582 }
583 export interface DisassociateDomainResponse {
584 }
585 export interface DisassociateWebsiteAuthorizationProviderRequest {
586 /**
587 * The ARN of the fleet.
588 */
589 FleetArn: FleetArn;
590 /**
591 * A unique identifier for the authorization provider.
592 */
593 AuthorizationProviderId: Id;
594 }
595 export interface DisassociateWebsiteAuthorizationProviderResponse {
596 }
597 export interface DisassociateWebsiteCertificateAuthorityRequest {
598 /**
599 * The ARN of the fleet.
600 */
601 FleetArn: FleetArn;
602 /**
603 * A unique identifier for the CA.
604 */
605 WebsiteCaId: Id;
606 }
607 export interface DisassociateWebsiteCertificateAuthorityResponse {
608 }
609 export type DisplayName = string;
610 export type DomainName = string;
611 export type DomainStatus = "PENDING_VALIDATION"|"ASSOCIATING"|"ACTIVE"|"INACTIVE"|"DISASSOCIATING"|"DISASSOCIATED"|"FAILED_TO_ASSOCIATE"|"FAILED_TO_DISASSOCIATE"|string;
612 export interface DomainSummary {
613 /**
614 * The name of the domain.
615 */
616 DomainName: DomainName;
617 /**
618 * The name to display.
619 */
620 DisplayName?: DisplayName;
621 /**
622 * The time that the domain was created.
623 */
624 CreatedTime: DateTime;
625 /**
626 * The status of the domain.
627 */
628 DomainStatus: DomainStatus;
629 }
630 export type DomainSummaryList = DomainSummary[];
631 export type FleetArn = string;
632 export type FleetName = string;
633 export type FleetStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"FAILED_TO_CREATE"|"FAILED_TO_DELETE"|string;
634 export interface FleetSummary {
635 /**
636 * The ARN of the fleet.
637 */
638 FleetArn?: FleetArn;
639 /**
640 * The time when the fleet was created.
641 */
642 CreatedTime?: DateTime;
643 /**
644 * The time when the fleet was last updated.
645 */
646 LastUpdatedTime?: DateTime;
647 /**
648 * The name of the fleet.
649 */
650 FleetName?: FleetName;
651 /**
652 * The name to display.
653 */
654 DisplayName?: DisplayName;
655 /**
656 * The identifier used by users to sign into the Amazon WorkLink app.
657 */
658 CompanyCode?: CompanyCode;
659 /**
660 * The status of the fleet.
661 */
662 FleetStatus?: FleetStatus;
663 }
664 export type FleetSummaryList = FleetSummary[];
665 export type Id = string;
666 export type IdentityProviderType = "SAML"|string;
667 export interface ListDevicesRequest {
668 /**
669 * The ARN of the fleet.
670 */
671 FleetArn: FleetArn;
672 /**
673 * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
674 */
675 NextToken?: NextToken;
676 /**
677 * The maximum number of results to be included in the next page.
678 */
679 MaxResults?: MaxResults;
680 }
681 export interface ListDevicesResponse {
682 /**
683 * Information about the devices.
684 */
685 Devices?: DeviceSummaryList;
686 /**
687 * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
688 */
689 NextToken?: NextToken;
690 }
691 export interface ListDomainsRequest {
692 /**
693 * The ARN of the fleet.
694 */
695 FleetArn: FleetArn;
696 /**
697 * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
698 */
699 NextToken?: NextToken;
700 /**
701 * The maximum number of results to be included in the next page.
702 */
703 MaxResults?: MaxResults;
704 }
705 export interface ListDomainsResponse {
706 /**
707 * Information about the domains.
708 */
709 Domains?: DomainSummaryList;
710 /**
711 * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
712 */
713 NextToken?: NextToken;
714 }
715 export interface ListFleetsRequest {
716 /**
717 * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
718 */
719 NextToken?: NextToken;
720 /**
721 * The maximum number of results to be included in the next page.
722 */
723 MaxResults?: MaxResults;
724 }
725 export interface ListFleetsResponse {
726 /**
727 * The summary list of the fleets.
728 */
729 FleetSummaryList?: FleetSummaryList;
730 /**
731 * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
732 */
733 NextToken?: NextToken;
734 }
735 export interface ListWebsiteAuthorizationProvidersRequest {
736 /**
737 * The ARN of the fleet.
738 */
739 FleetArn: FleetArn;
740 /**
741 * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
742 */
743 NextToken?: NextToken;
744 /**
745 * The maximum number of results to be included in the next page.
746 */
747 MaxResults?: MaxResults;
748 }
749 export interface ListWebsiteAuthorizationProvidersResponse {
750 /**
751 * The website authorization providers.
752 */
753 WebsiteAuthorizationProviders?: WebsiteAuthorizationProvidersSummaryList;
754 /**
755 * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
756 */
757 NextToken?: NextToken;
758 }
759 export interface ListWebsiteCertificateAuthoritiesRequest {
760 /**
761 * The ARN of the fleet.
762 */
763 FleetArn: FleetArn;
764 /**
765 * The maximum number of results to be included in the next page.
766 */
767 MaxResults?: MaxResults;
768 /**
769 * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
770 */
771 NextToken?: NextToken;
772 }
773 export interface ListWebsiteCertificateAuthoritiesResponse {
774 /**
775 * Information about the certificates.
776 */
777 WebsiteCertificateAuthorities?: WebsiteCaSummaryList;
778 /**
779 * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
780 */
781 NextToken?: NextToken;
782 }
783 export type MaxResults = number;
784 export type NextToken = string;
785 export interface RestoreDomainAccessRequest {
786 /**
787 * The ARN of the fleet.
788 */
789 FleetArn: FleetArn;
790 /**
791 * The name of the domain.
792 */
793 DomainName: DomainName;
794 }
795 export interface RestoreDomainAccessResponse {
796 }
797 export interface RevokeDomainAccessRequest {
798 /**
799 * The ARN of the fleet.
800 */
801 FleetArn: FleetArn;
802 /**
803 * The name of the domain.
804 */
805 DomainName: DomainName;
806 }
807 export interface RevokeDomainAccessResponse {
808 }
809 export type SamlMetadata = string;
810 export type SecurityGroupId = string;
811 export type SecurityGroupIds = SecurityGroupId[];
812 export interface SignOutUserRequest {
813 /**
814 * The ARN of the fleet.
815 */
816 FleetArn: FleetArn;
817 /**
818 * The name of the user.
819 */
820 Username: Username;
821 }
822 export interface SignOutUserResponse {
823 }
824 export type SubnetId = string;
825 export type SubnetIds = SubnetId[];
826 export interface UpdateAuditStreamConfigurationRequest {
827 /**
828 * The ARN of the fleet.
829 */
830 FleetArn: FleetArn;
831 /**
832 * The ARN of the Amazon Kinesis data stream that receives the audit events.
833 */
834 AuditStreamArn?: AuditStreamArn;
835 }
836 export interface UpdateAuditStreamConfigurationResponse {
837 }
838 export interface UpdateCompanyNetworkConfigurationRequest {
839 /**
840 * The ARN of the fleet.
841 */
842 FleetArn: FleetArn;
843 /**
844 * The VPC with connectivity to associated websites.
845 */
846 VpcId: VpcId;
847 /**
848 * The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
849 */
850 SubnetIds: SubnetIds;
851 /**
852 * The security groups associated with access to the provided subnets.
853 */
854 SecurityGroupIds: SecurityGroupIds;
855 }
856 export interface UpdateCompanyNetworkConfigurationResponse {
857 }
858 export interface UpdateDevicePolicyConfigurationRequest {
859 /**
860 * The ARN of the fleet.
861 */
862 FleetArn: FleetArn;
863 /**
864 * The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
865 */
866 DeviceCaCertificate?: CertificateChain;
867 }
868 export interface UpdateDevicePolicyConfigurationResponse {
869 }
870 export interface UpdateDomainMetadataRequest {
871 /**
872 * The ARN of the fleet.
873 */
874 FleetArn: FleetArn;
875 /**
876 * The name of the domain.
877 */
878 DomainName: DomainName;
879 /**
880 * The name to display.
881 */
882 DisplayName?: DisplayName;
883 }
884 export interface UpdateDomainMetadataResponse {
885 }
886 export interface UpdateFleetMetadataRequest {
887 /**
888 * The ARN of the fleet.
889 */
890 FleetArn: FleetArn;
891 /**
892 * The fleet name to display. The existing DisplayName is unset if null is passed.
893 */
894 DisplayName?: DisplayName;
895 /**
896 * The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
897 */
898 OptimizeForEndUserLocation?: Boolean;
899 }
900 export interface UpdateFleetMetadataResponse {
901 }
902 export interface UpdateIdentityProviderConfigurationRequest {
903 /**
904 * The ARN of the fleet.
905 */
906 FleetArn: FleetArn;
907 /**
908 * The type of identity provider.
909 */
910 IdentityProviderType: IdentityProviderType;
911 /**
912 * The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.
913 */
914 IdentityProviderSamlMetadata?: SamlMetadata;
915 }
916 export interface UpdateIdentityProviderConfigurationResponse {
917 }
918 export type Username = string;
919 export type VpcId = string;
920 export interface WebsiteAuthorizationProviderSummary {
921 /**
922 * A unique identifier for the authorization provider.
923 */
924 AuthorizationProviderId?: Id;
925 /**
926 * The authorization provider type.
927 */
928 AuthorizationProviderType: AuthorizationProviderType;
929 /**
930 * The domain name of the authorization provider. This applies only to SAML-based authorization providers.
931 */
932 DomainName?: DomainName;
933 /**
934 * The time of creation.
935 */
936 CreatedTime?: DateTime;
937 }
938 export type WebsiteAuthorizationProvidersSummaryList = WebsiteAuthorizationProviderSummary[];
939 export interface WebsiteCaSummary {
940 /**
941 * A unique identifier for the CA.
942 */
943 WebsiteCaId?: Id;
944 /**
945 * The time when the CA was added.
946 */
947 CreatedTime?: DateTime;
948 /**
949 * The name to display.
950 */
951 DisplayName?: DisplayName;
952 }
953 export type WebsiteCaSummaryList = WebsiteCaSummary[];
954 /**
955 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
956 */
957 export type apiVersion = "2018-09-25"|"latest"|string;
958 export interface ClientApiVersions {
959 /**
960 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
961 */
962 apiVersion?: apiVersion;
963 }
964 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
965 /**
966 * Contains interfaces for use with the WorkLink client.
967 */
968 export import Types = WorkLink;
969}
970export = WorkLink;