worklink.d.ts
38.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
139
140
141
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
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
391
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
454
455
456
457
458
459
460
461
462
463
464
465
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
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
549
550
551
552
553
554
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
598
599
600
601
602
603
604
605
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
635
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
665
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
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class WorkLink extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: WorkLink.Types.ClientConfiguration)
config: Config & WorkLink.Types.ClientConfiguration;
/**
* Specifies a domain to be associated to Amazon WorkLink.
*/
associateDomain(params: WorkLink.Types.AssociateDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateDomainResponse) => void): Request<WorkLink.Types.AssociateDomainResponse, AWSError>;
/**
* Specifies a domain to be associated to Amazon WorkLink.
*/
associateDomain(callback?: (err: AWSError, data: WorkLink.Types.AssociateDomainResponse) => void): Request<WorkLink.Types.AssociateDomainResponse, AWSError>;
/**
* Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
*/
associateWebsiteAuthorizationProvider(params: WorkLink.Types.AssociateWebsiteAuthorizationProviderRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse, AWSError>;
/**
* Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
*/
associateWebsiteAuthorizationProvider(callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.AssociateWebsiteAuthorizationProviderResponse, AWSError>;
/**
* Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
*/
associateWebsiteCertificateAuthority(params: WorkLink.Types.AssociateWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse, AWSError>;
/**
* Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
*/
associateWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse, AWSError>;
/**
* 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.
*/
createFleet(params: WorkLink.Types.CreateFleetRequest, callback?: (err: AWSError, data: WorkLink.Types.CreateFleetResponse) => void): Request<WorkLink.Types.CreateFleetResponse, AWSError>;
/**
* 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.
*/
createFleet(callback?: (err: AWSError, data: WorkLink.Types.CreateFleetResponse) => void): Request<WorkLink.Types.CreateFleetResponse, AWSError>;
/**
* Deletes a fleet. Prevents users from accessing previously associated websites.
*/
deleteFleet(params: WorkLink.Types.DeleteFleetRequest, callback?: (err: AWSError, data: WorkLink.Types.DeleteFleetResponse) => void): Request<WorkLink.Types.DeleteFleetResponse, AWSError>;
/**
* Deletes a fleet. Prevents users from accessing previously associated websites.
*/
deleteFleet(callback?: (err: AWSError, data: WorkLink.Types.DeleteFleetResponse) => void): Request<WorkLink.Types.DeleteFleetResponse, AWSError>;
/**
* Describes the configuration for delivering audit streams to the customer account.
*/
describeAuditStreamConfiguration(params: WorkLink.Types.DescribeAuditStreamConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.DescribeAuditStreamConfigurationResponse, AWSError>;
/**
* Describes the configuration for delivering audit streams to the customer account.
*/
describeAuditStreamConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.DescribeAuditStreamConfigurationResponse, AWSError>;
/**
* Describes the networking configuration to access the internal websites associated with the specified fleet.
*/
describeCompanyNetworkConfiguration(params: WorkLink.Types.DescribeCompanyNetworkConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.DescribeCompanyNetworkConfigurationResponse, AWSError>;
/**
* Describes the networking configuration to access the internal websites associated with the specified fleet.
*/
describeCompanyNetworkConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.DescribeCompanyNetworkConfigurationResponse, AWSError>;
/**
* Provides information about a user's device.
*/
describeDevice(params: WorkLink.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDeviceResponse) => void): Request<WorkLink.Types.DescribeDeviceResponse, AWSError>;
/**
* Provides information about a user's device.
*/
describeDevice(callback?: (err: AWSError, data: WorkLink.Types.DescribeDeviceResponse) => void): Request<WorkLink.Types.DescribeDeviceResponse, AWSError>;
/**
* Describes the device policy configuration for the specified fleet.
*/
describeDevicePolicyConfiguration(params: WorkLink.Types.DescribeDevicePolicyConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.DescribeDevicePolicyConfigurationResponse, AWSError>;
/**
* Describes the device policy configuration for the specified fleet.
*/
describeDevicePolicyConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.DescribeDevicePolicyConfigurationResponse, AWSError>;
/**
* Provides information about the domain.
*/
describeDomain(params: WorkLink.Types.DescribeDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDomainResponse) => void): Request<WorkLink.Types.DescribeDomainResponse, AWSError>;
/**
* Provides information about the domain.
*/
describeDomain(callback?: (err: AWSError, data: WorkLink.Types.DescribeDomainResponse) => void): Request<WorkLink.Types.DescribeDomainResponse, AWSError>;
/**
* Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
*/
describeFleetMetadata(params: WorkLink.Types.DescribeFleetMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeFleetMetadataResponse) => void): Request<WorkLink.Types.DescribeFleetMetadataResponse, AWSError>;
/**
* Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
*/
describeFleetMetadata(callback?: (err: AWSError, data: WorkLink.Types.DescribeFleetMetadataResponse) => void): Request<WorkLink.Types.DescribeFleetMetadataResponse, AWSError>;
/**
* Describes the identity provider configuration of the specified fleet.
*/
describeIdentityProviderConfiguration(params: WorkLink.Types.DescribeIdentityProviderConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.DescribeIdentityProviderConfigurationResponse, AWSError>;
/**
* Describes the identity provider configuration of the specified fleet.
*/
describeIdentityProviderConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.DescribeIdentityProviderConfigurationResponse, AWSError>;
/**
* Provides information about the certificate authority.
*/
describeWebsiteCertificateAuthority(params: WorkLink.Types.DescribeWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse, AWSError>;
/**
* Provides information about the certificate authority.
*/
describeWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse, AWSError>;
/**
* Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
*/
disassociateDomain(params: WorkLink.Types.DisassociateDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateDomainResponse) => void): Request<WorkLink.Types.DisassociateDomainResponse, AWSError>;
/**
* Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
*/
disassociateDomain(callback?: (err: AWSError, data: WorkLink.Types.DisassociateDomainResponse) => void): Request<WorkLink.Types.DisassociateDomainResponse, AWSError>;
/**
* Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.
*/
disassociateWebsiteAuthorizationProvider(params: WorkLink.Types.DisassociateWebsiteAuthorizationProviderRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse, AWSError>;
/**
* Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.
*/
disassociateWebsiteAuthorizationProvider(callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse) => void): Request<WorkLink.Types.DisassociateWebsiteAuthorizationProviderResponse, AWSError>;
/**
* Removes a certificate authority (CA).
*/
disassociateWebsiteCertificateAuthority(params: WorkLink.Types.DisassociateWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse, AWSError>;
/**
* Removes a certificate authority (CA).
*/
disassociateWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse) => void): Request<WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse, AWSError>;
/**
* Retrieves a list of devices registered with the specified fleet.
*/
listDevices(params: WorkLink.Types.ListDevicesRequest, callback?: (err: AWSError, data: WorkLink.Types.ListDevicesResponse) => void): Request<WorkLink.Types.ListDevicesResponse, AWSError>;
/**
* Retrieves a list of devices registered with the specified fleet.
*/
listDevices(callback?: (err: AWSError, data: WorkLink.Types.ListDevicesResponse) => void): Request<WorkLink.Types.ListDevicesResponse, AWSError>;
/**
* Retrieves a list of domains associated to a specified fleet.
*/
listDomains(params: WorkLink.Types.ListDomainsRequest, callback?: (err: AWSError, data: WorkLink.Types.ListDomainsResponse) => void): Request<WorkLink.Types.ListDomainsResponse, AWSError>;
/**
* Retrieves a list of domains associated to a specified fleet.
*/
listDomains(callback?: (err: AWSError, data: WorkLink.Types.ListDomainsResponse) => void): Request<WorkLink.Types.ListDomainsResponse, AWSError>;
/**
* Retrieves a list of fleets for the current account and Region.
*/
listFleets(params: WorkLink.Types.ListFleetsRequest, callback?: (err: AWSError, data: WorkLink.Types.ListFleetsResponse) => void): Request<WorkLink.Types.ListFleetsResponse, AWSError>;
/**
* Retrieves a list of fleets for the current account and Region.
*/
listFleets(callback?: (err: AWSError, data: WorkLink.Types.ListFleetsResponse) => void): Request<WorkLink.Types.ListFleetsResponse, AWSError>;
/**
* Retrieves a list of website authorization providers associated with a specified fleet.
*/
listWebsiteAuthorizationProviders(params: WorkLink.Types.ListWebsiteAuthorizationProvidersRequest, callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteAuthorizationProvidersResponse) => void): Request<WorkLink.Types.ListWebsiteAuthorizationProvidersResponse, AWSError>;
/**
* Retrieves a list of website authorization providers associated with a specified fleet.
*/
listWebsiteAuthorizationProviders(callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteAuthorizationProvidersResponse) => void): Request<WorkLink.Types.ListWebsiteAuthorizationProvidersResponse, AWSError>;
/**
* Retrieves a list of certificate authorities added for the current account and Region.
*/
listWebsiteCertificateAuthorities(params: WorkLink.Types.ListWebsiteCertificateAuthoritiesRequest, callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse) => void): Request<WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse, AWSError>;
/**
* Retrieves a list of certificate authorities added for the current account and Region.
*/
listWebsiteCertificateAuthorities(callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse) => void): Request<WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse, AWSError>;
/**
* Moves a domain to ACTIVE status if it was in the INACTIVE status.
*/
restoreDomainAccess(params: WorkLink.Types.RestoreDomainAccessRequest, callback?: (err: AWSError, data: WorkLink.Types.RestoreDomainAccessResponse) => void): Request<WorkLink.Types.RestoreDomainAccessResponse, AWSError>;
/**
* Moves a domain to ACTIVE status if it was in the INACTIVE status.
*/
restoreDomainAccess(callback?: (err: AWSError, data: WorkLink.Types.RestoreDomainAccessResponse) => void): Request<WorkLink.Types.RestoreDomainAccessResponse, AWSError>;
/**
* Moves a domain to INACTIVE status if it was in the ACTIVE status.
*/
revokeDomainAccess(params: WorkLink.Types.RevokeDomainAccessRequest, callback?: (err: AWSError, data: WorkLink.Types.RevokeDomainAccessResponse) => void): Request<WorkLink.Types.RevokeDomainAccessResponse, AWSError>;
/**
* Moves a domain to INACTIVE status if it was in the ACTIVE status.
*/
revokeDomainAccess(callback?: (err: AWSError, data: WorkLink.Types.RevokeDomainAccessResponse) => void): Request<WorkLink.Types.RevokeDomainAccessResponse, AWSError>;
/**
* Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
*/
signOutUser(params: WorkLink.Types.SignOutUserRequest, callback?: (err: AWSError, data: WorkLink.Types.SignOutUserResponse) => void): Request<WorkLink.Types.SignOutUserResponse, AWSError>;
/**
* Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
*/
signOutUser(callback?: (err: AWSError, data: WorkLink.Types.SignOutUserResponse) => void): Request<WorkLink.Types.SignOutUserResponse, AWSError>;
/**
* Updates the audit stream configuration for the fleet.
*/
updateAuditStreamConfiguration(params: WorkLink.Types.UpdateAuditStreamConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.UpdateAuditStreamConfigurationResponse, AWSError>;
/**
* Updates the audit stream configuration for the fleet.
*/
updateAuditStreamConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateAuditStreamConfigurationResponse) => void): Request<WorkLink.Types.UpdateAuditStreamConfigurationResponse, AWSError>;
/**
* Updates the company network configuration for the fleet.
*/
updateCompanyNetworkConfiguration(params: WorkLink.Types.UpdateCompanyNetworkConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.UpdateCompanyNetworkConfigurationResponse, AWSError>;
/**
* Updates the company network configuration for the fleet.
*/
updateCompanyNetworkConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateCompanyNetworkConfigurationResponse) => void): Request<WorkLink.Types.UpdateCompanyNetworkConfigurationResponse, AWSError>;
/**
* Updates the device policy configuration for the fleet.
*/
updateDevicePolicyConfiguration(params: WorkLink.Types.UpdateDevicePolicyConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.UpdateDevicePolicyConfigurationResponse, AWSError>;
/**
* Updates the device policy configuration for the fleet.
*/
updateDevicePolicyConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateDevicePolicyConfigurationResponse) => void): Request<WorkLink.Types.UpdateDevicePolicyConfigurationResponse, AWSError>;
/**
* Updates domain metadata, such as DisplayName.
*/
updateDomainMetadata(params: WorkLink.Types.UpdateDomainMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateDomainMetadataResponse) => void): Request<WorkLink.Types.UpdateDomainMetadataResponse, AWSError>;
/**
* Updates domain metadata, such as DisplayName.
*/
updateDomainMetadata(callback?: (err: AWSError, data: WorkLink.Types.UpdateDomainMetadataResponse) => void): Request<WorkLink.Types.UpdateDomainMetadataResponse, AWSError>;
/**
* Updates fleet metadata, such as DisplayName.
*/
updateFleetMetadata(params: WorkLink.Types.UpdateFleetMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateFleetMetadataResponse) => void): Request<WorkLink.Types.UpdateFleetMetadataResponse, AWSError>;
/**
* Updates fleet metadata, such as DisplayName.
*/
updateFleetMetadata(callback?: (err: AWSError, data: WorkLink.Types.UpdateFleetMetadataResponse) => void): Request<WorkLink.Types.UpdateFleetMetadataResponse, AWSError>;
/**
* Updates the identity provider configuration for the fleet.
*/
updateIdentityProviderConfiguration(params: WorkLink.Types.UpdateIdentityProviderConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.UpdateIdentityProviderConfigurationResponse, AWSError>;
/**
* Updates the identity provider configuration for the fleet.
*/
updateIdentityProviderConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateIdentityProviderConfigurationResponse) => void): Request<WorkLink.Types.UpdateIdentityProviderConfigurationResponse, AWSError>;
}
declare namespace WorkLink {
export type AcmCertificateArn = string;
export interface AssociateDomainRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
FleetArn: FleetArn;
/**
* The fully qualified domain name (FQDN).
*/
DomainName: DomainName;
/**
* The name to display.
*/
DisplayName?: DisplayName;
/**
* The ARN of an issued ACM certificate that is valid for the domain being associated.
*/
AcmCertificateArn: AcmCertificateArn;
}
export interface AssociateDomainResponse {
}
export interface AssociateWebsiteAuthorizationProviderRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The authorization provider type.
*/
AuthorizationProviderType: AuthorizationProviderType;
/**
* The domain name of the authorization provider. This applies only to SAML-based authorization providers.
*/
DomainName?: DomainName;
}
export interface AssociateWebsiteAuthorizationProviderResponse {
/**
* A unique identifier for the authorization provider.
*/
AuthorizationProviderId?: Id;
}
export interface AssociateWebsiteCertificateAuthorityRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The root certificate of the CA.
*/
Certificate: Certificate;
/**
* The certificate name to display.
*/
DisplayName?: DisplayName;
}
export interface AssociateWebsiteCertificateAuthorityResponse {
/**
* A unique identifier for the CA.
*/
WebsiteCaId?: Id;
}
export type AuditStreamArn = string;
export type AuthorizationProviderType = "SAML"|string;
export type Boolean = boolean;
export type Certificate = string;
export type CertificateChain = string;
export type CompanyCode = string;
export interface CreateFleetRequest {
/**
* A unique name for the fleet.
*/
FleetName: FleetName;
/**
* The fleet name to display.
*/
DisplayName?: DisplayName;
/**
* 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.
*/
OptimizeForEndUserLocation?: Boolean;
}
export interface CreateFleetResponse {
/**
* The ARN of the fleet.
*/
FleetArn?: FleetArn;
}
export type DateTime = Date;
export interface DeleteFleetRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
}
export interface DeleteFleetResponse {
}
export interface DescribeAuditStreamConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
}
export interface DescribeAuditStreamConfigurationResponse {
/**
* The ARN of the Amazon Kinesis data stream that will receive the audit events.
*/
AuditStreamArn?: AuditStreamArn;
}
export interface DescribeCompanyNetworkConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
}
export interface DescribeCompanyNetworkConfigurationResponse {
/**
* The VPC with connectivity to associated websites.
*/
VpcId?: VpcId;
/**
* The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
*/
SubnetIds?: SubnetIds;
/**
* The security groups associated with access to the provided subnets.
*/
SecurityGroupIds?: SecurityGroupIds;
}
export interface DescribeDevicePolicyConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
}
export interface DescribeDevicePolicyConfigurationResponse {
/**
* The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
*/
DeviceCaCertificate?: Certificate;
}
export interface DescribeDeviceRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* A unique identifier for a registered user's device.
*/
DeviceId: Id;
}
export interface DescribeDeviceResponse {
/**
* The current state of the device.
*/
Status?: DeviceStatus;
/**
* The model of the device.
*/
Model?: DeviceModel;
/**
* The manufacturer of the device.
*/
Manufacturer?: DeviceManufacturer;
/**
* The operating system of the device.
*/
OperatingSystem?: DeviceOperatingSystemName;
/**
* The operating system version of the device.
*/
OperatingSystemVersion?: DeviceOperatingSystemVersion;
/**
* The operating system patch level of the device.
*/
PatchLevel?: DevicePatchLevel;
/**
* The date that the device first signed in to Amazon WorkLink.
*/
FirstAccessedTime?: DateTime;
/**
* The date that the device last accessed Amazon WorkLink.
*/
LastAccessedTime?: DateTime;
/**
* The user name associated with the device.
*/
Username?: Username;
}
export interface DescribeDomainRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The name of the domain.
*/
DomainName: DomainName;
}
export interface DescribeDomainResponse {
/**
* The name of the domain.
*/
DomainName?: DomainName;
/**
* The name to display.
*/
DisplayName?: DisplayName;
/**
* The time that the domain was added.
*/
CreatedTime?: DateTime;
/**
* The current state for the domain.
*/
DomainStatus?: DomainStatus;
/**
* The ARN of an issued ACM certificate that is valid for the domain being associated.
*/
AcmCertificateArn?: AcmCertificateArn;
}
export interface DescribeFleetMetadataRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
}
export interface DescribeFleetMetadataResponse {
/**
* The time that the fleet was created.
*/
CreatedTime?: DateTime;
/**
* The time that the fleet was last updated.
*/
LastUpdatedTime?: DateTime;
/**
* The name of the fleet.
*/
FleetName?: FleetName;
/**
* The name to display.
*/
DisplayName?: DisplayName;
/**
* 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.
*/
OptimizeForEndUserLocation?: Boolean;
/**
* The identifier used by users to sign in to the Amazon WorkLink app.
*/
CompanyCode?: CompanyCode;
/**
* The current state of the fleet.
*/
FleetStatus?: FleetStatus;
}
export interface DescribeIdentityProviderConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
}
export interface DescribeIdentityProviderConfigurationResponse {
/**
* The type of identity provider.
*/
IdentityProviderType?: IdentityProviderType;
/**
* The SAML metadata document uploaded to the user’s identity provider.
*/
ServiceProviderSamlMetadata?: SamlMetadata;
/**
* The SAML metadata document provided by the user’s identity provider.
*/
IdentityProviderSamlMetadata?: SamlMetadata;
}
export interface DescribeWebsiteCertificateAuthorityRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* A unique identifier for the certificate authority.
*/
WebsiteCaId: Id;
}
export interface DescribeWebsiteCertificateAuthorityResponse {
/**
* The root certificate of the certificate authority.
*/
Certificate?: Certificate;
/**
* The time that the certificate authority was added.
*/
CreatedTime?: DateTime;
/**
* The certificate name to display.
*/
DisplayName?: DisplayName;
}
export type DeviceManufacturer = string;
export type DeviceModel = string;
export type DeviceOperatingSystemName = string;
export type DeviceOperatingSystemVersion = string;
export type DevicePatchLevel = string;
export type DeviceStatus = "ACTIVE"|"SIGNED_OUT"|string;
export interface DeviceSummary {
/**
* The ID of the device.
*/
DeviceId?: Id;
/**
* The status of the device.
*/
DeviceStatus?: DeviceStatus;
}
export type DeviceSummaryList = DeviceSummary[];
export interface DisassociateDomainRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The name of the domain.
*/
DomainName: DomainName;
}
export interface DisassociateDomainResponse {
}
export interface DisassociateWebsiteAuthorizationProviderRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* A unique identifier for the authorization provider.
*/
AuthorizationProviderId: Id;
}
export interface DisassociateWebsiteAuthorizationProviderResponse {
}
export interface DisassociateWebsiteCertificateAuthorityRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* A unique identifier for the CA.
*/
WebsiteCaId: Id;
}
export interface DisassociateWebsiteCertificateAuthorityResponse {
}
export type DisplayName = string;
export type DomainName = string;
export type DomainStatus = "PENDING_VALIDATION"|"ASSOCIATING"|"ACTIVE"|"INACTIVE"|"DISASSOCIATING"|"DISASSOCIATED"|"FAILED_TO_ASSOCIATE"|"FAILED_TO_DISASSOCIATE"|string;
export interface DomainSummary {
/**
* The name of the domain.
*/
DomainName: DomainName;
/**
* The name to display.
*/
DisplayName?: DisplayName;
/**
* The time that the domain was created.
*/
CreatedTime: DateTime;
/**
* The status of the domain.
*/
DomainStatus: DomainStatus;
}
export type DomainSummaryList = DomainSummary[];
export type FleetArn = string;
export type FleetName = string;
export type FleetStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"FAILED_TO_CREATE"|"FAILED_TO_DELETE"|string;
export interface FleetSummary {
/**
* The ARN of the fleet.
*/
FleetArn?: FleetArn;
/**
* The time when the fleet was created.
*/
CreatedTime?: DateTime;
/**
* The time when the fleet was last updated.
*/
LastUpdatedTime?: DateTime;
/**
* The name of the fleet.
*/
FleetName?: FleetName;
/**
* The name to display.
*/
DisplayName?: DisplayName;
/**
* The identifier used by users to sign into the Amazon WorkLink app.
*/
CompanyCode?: CompanyCode;
/**
* The status of the fleet.
*/
FleetStatus?: FleetStatus;
}
export type FleetSummaryList = FleetSummary[];
export type Id = string;
export type IdentityProviderType = "SAML"|string;
export interface ListDevicesRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be included in the next page.
*/
MaxResults?: MaxResults;
}
export interface ListDevicesResponse {
/**
* Information about the devices.
*/
Devices?: DeviceSummaryList;
/**
* The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: NextToken;
}
export interface ListDomainsRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be included in the next page.
*/
MaxResults?: MaxResults;
}
export interface ListDomainsResponse {
/**
* Information about the domains.
*/
Domains?: DomainSummaryList;
/**
* The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: NextToken;
}
export interface ListFleetsRequest {
/**
* The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be included in the next page.
*/
MaxResults?: MaxResults;
}
export interface ListFleetsResponse {
/**
* The summary list of the fleets.
*/
FleetSummaryList?: FleetSummaryList;
/**
* The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: NextToken;
}
export interface ListWebsiteAuthorizationProvidersRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be included in the next page.
*/
MaxResults?: MaxResults;
}
export interface ListWebsiteAuthorizationProvidersResponse {
/**
* The website authorization providers.
*/
WebsiteAuthorizationProviders?: WebsiteAuthorizationProvidersSummaryList;
/**
* 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.
*/
NextToken?: NextToken;
}
export interface ListWebsiteCertificateAuthoritiesRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The maximum number of results to be included in the next page.
*/
MaxResults?: MaxResults;
/**
* The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
*/
NextToken?: NextToken;
}
export interface ListWebsiteCertificateAuthoritiesResponse {
/**
* Information about the certificates.
*/
WebsiteCertificateAuthorities?: WebsiteCaSummaryList;
/**
* The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.
*/
NextToken?: NextToken;
}
export type MaxResults = number;
export type NextToken = string;
export interface RestoreDomainAccessRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The name of the domain.
*/
DomainName: DomainName;
}
export interface RestoreDomainAccessResponse {
}
export interface RevokeDomainAccessRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The name of the domain.
*/
DomainName: DomainName;
}
export interface RevokeDomainAccessResponse {
}
export type SamlMetadata = string;
export type SecurityGroupId = string;
export type SecurityGroupIds = SecurityGroupId[];
export interface SignOutUserRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The name of the user.
*/
Username: Username;
}
export interface SignOutUserResponse {
}
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export interface UpdateAuditStreamConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The ARN of the Amazon Kinesis data stream that receives the audit events.
*/
AuditStreamArn?: AuditStreamArn;
}
export interface UpdateAuditStreamConfigurationResponse {
}
export interface UpdateCompanyNetworkConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The VPC with connectivity to associated websites.
*/
VpcId: VpcId;
/**
* The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
*/
SubnetIds: SubnetIds;
/**
* The security groups associated with access to the provided subnets.
*/
SecurityGroupIds: SecurityGroupIds;
}
export interface UpdateCompanyNetworkConfigurationResponse {
}
export interface UpdateDevicePolicyConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
*/
DeviceCaCertificate?: CertificateChain;
}
export interface UpdateDevicePolicyConfigurationResponse {
}
export interface UpdateDomainMetadataRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The name of the domain.
*/
DomainName: DomainName;
/**
* The name to display.
*/
DisplayName?: DisplayName;
}
export interface UpdateDomainMetadataResponse {
}
export interface UpdateFleetMetadataRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The fleet name to display. The existing DisplayName is unset if null is passed.
*/
DisplayName?: DisplayName;
/**
* 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.
*/
OptimizeForEndUserLocation?: Boolean;
}
export interface UpdateFleetMetadataResponse {
}
export interface UpdateIdentityProviderConfigurationRequest {
/**
* The ARN of the fleet.
*/
FleetArn: FleetArn;
/**
* The type of identity provider.
*/
IdentityProviderType: IdentityProviderType;
/**
* The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.
*/
IdentityProviderSamlMetadata?: SamlMetadata;
}
export interface UpdateIdentityProviderConfigurationResponse {
}
export type Username = string;
export type VpcId = string;
export interface WebsiteAuthorizationProviderSummary {
/**
* A unique identifier for the authorization provider.
*/
AuthorizationProviderId?: Id;
/**
* The authorization provider type.
*/
AuthorizationProviderType: AuthorizationProviderType;
/**
* The domain name of the authorization provider. This applies only to SAML-based authorization providers.
*/
DomainName?: DomainName;
/**
* The time of creation.
*/
CreatedTime?: DateTime;
}
export type WebsiteAuthorizationProvidersSummaryList = WebsiteAuthorizationProviderSummary[];
export interface WebsiteCaSummary {
/**
* A unique identifier for the CA.
*/
WebsiteCaId?: Id;
/**
* The time when the CA was added.
*/
CreatedTime?: DateTime;
/**
* The name to display.
*/
DisplayName?: DisplayName;
}
export type WebsiteCaSummaryList = WebsiteCaSummary[];
/**
* 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.
*/
export type apiVersion = "2018-09-25"|"latest"|string;
export interface ClientApiVersions {
/**
* 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.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the WorkLink client.
*/
export import Types = WorkLink;
}
export = WorkLink;