@aws-sdk/client-workspaces-web 3.948.0 → 3.952.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.
- package/README.md +1 -7
- package/dist-cjs/index.js +185 -35
- package/dist-es/models/enums.js +22 -0
- package/dist-es/schemas/schemas_0.js +160 -35
- package/dist-types/WorkSpacesWeb.d.ts +1 -7
- package/dist-types/WorkSpacesWebClient.d.ts +1 -7
- package/dist-types/commands/CreateBrowserSettingsCommand.d.ts +1 -3
- package/dist-types/commands/CreateNetworkSettingsCommand.d.ts +1 -3
- package/dist-types/commands/CreateTrustStoreCommand.d.ts +1 -5
- package/dist-types/commands/CreateUserAccessLoggingSettingsCommand.d.ts +1 -2
- package/dist-types/commands/CreateUserSettingsCommand.d.ts +32 -3
- package/dist-types/commands/GetUserSettingsCommand.d.ts +31 -0
- package/dist-types/commands/ListUserSettingsCommand.d.ts +31 -0
- package/dist-types/commands/UpdateUserSettingsCommand.d.ts +59 -0
- package/dist-types/index.d.ts +1 -7
- package/dist-types/models/enums.d.ts +46 -0
- package/dist-types/models/models_0.d.ts +398 -849
- package/dist-types/schemas/schemas_0.d.ts +11 -0
- package/dist-types/ts3.4/models/enums.d.ts +25 -0
- package/dist-types/ts3.4/models/models_0.d.ts +104 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { _InstanceType, AuthenticationType, BrowserType, Category, EnabledType, Event, FolderStructure, IdentityProviderType, LogFileFormat, MaxDisplayResolution, PortalStatus, RedactionPlaceHolderType, RendererType, SessionSortBy, SessionStatus, ToolbarItem, ToolbarType, VisualMode } from "./enums";
|
|
1
|
+
import { _InstanceType, AuthenticationType, BrowserType, Category, ColorTheme, EnabledType, Event, FolderStructure, IdentityProviderType, Locale, LogFileFormat, MaxDisplayResolution, MimeType, PortalStatus, RedactionPlaceHolderType, RendererType, SessionSortBy, SessionStatus, ToolbarItem, ToolbarType, VisualMode } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* @public
|
|
4
4
|
*/
|
|
@@ -312,18 +312,12 @@ export interface CreateBrowserSettingsRequest {
|
|
|
312
312
|
*/
|
|
313
313
|
additionalEncryptionContext?: Record<string, string> | undefined;
|
|
314
314
|
/**
|
|
315
|
-
* <p>A JSON string containing Chrome Enterprise policies that will be applied to all
|
|
316
|
-
* streaming sessions.</p>
|
|
315
|
+
* <p>A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.</p>
|
|
317
316
|
* @public
|
|
318
317
|
*/
|
|
319
318
|
browserPolicy?: string | undefined;
|
|
320
319
|
/**
|
|
321
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
322
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
323
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
324
|
-
* client token returns the result from the original successful request.</p>
|
|
325
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
|
|
326
|
-
* </p>
|
|
320
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.</p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK. </p>
|
|
327
321
|
* @public
|
|
328
322
|
*/
|
|
329
323
|
clientToken?: string | undefined;
|
|
@@ -369,9 +363,7 @@ export interface GetBrowserSettingsRequest {
|
|
|
369
363
|
browserSettingsArn: string | undefined;
|
|
370
364
|
}
|
|
371
365
|
/**
|
|
372
|
-
* <p>The browser settings resource that can be associated with a web portal. Once associated
|
|
373
|
-
* with a web portal, browser settings control how the browser will behave once a user starts
|
|
374
|
-
* a streaming session for the web portal. </p>
|
|
366
|
+
* <p>The browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal. </p>
|
|
375
367
|
* @public
|
|
376
368
|
*/
|
|
377
369
|
export interface BrowserSettings {
|
|
@@ -386,14 +378,12 @@ export interface BrowserSettings {
|
|
|
386
378
|
*/
|
|
387
379
|
associatedPortalArns?: string[] | undefined;
|
|
388
380
|
/**
|
|
389
|
-
* <p>A JSON string containing Chrome Enterprise policies that will be applied to all
|
|
390
|
-
* streaming sessions.</p>
|
|
381
|
+
* <p>A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.</p>
|
|
391
382
|
* @public
|
|
392
383
|
*/
|
|
393
384
|
browserPolicy?: string | undefined;
|
|
394
385
|
/**
|
|
395
|
-
* <p>The customer managed key used to encrypt sensitive information in the browser
|
|
396
|
-
* settings.</p>
|
|
386
|
+
* <p>The customer managed key used to encrypt sensitive information in the browser settings.</p>
|
|
397
387
|
* @public
|
|
398
388
|
*/
|
|
399
389
|
customerManagedKey?: string | undefined;
|
|
@@ -423,8 +413,7 @@ export interface GetBrowserSettingsResponse {
|
|
|
423
413
|
*/
|
|
424
414
|
export interface ListBrowserSettingsRequest {
|
|
425
415
|
/**
|
|
426
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
427
|
-
* operation.</p>
|
|
416
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
428
417
|
* @public
|
|
429
418
|
*/
|
|
430
419
|
nextToken?: string | undefined;
|
|
@@ -455,8 +444,7 @@ export interface ListBrowserSettingsResponse {
|
|
|
455
444
|
*/
|
|
456
445
|
browserSettings?: BrowserSettingsSummary[] | undefined;
|
|
457
446
|
/**
|
|
458
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
459
|
-
* operation.</p>
|
|
447
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
460
448
|
* @public
|
|
461
449
|
*/
|
|
462
450
|
nextToken?: string | undefined;
|
|
@@ -471,18 +459,12 @@ export interface UpdateBrowserSettingsRequest {
|
|
|
471
459
|
*/
|
|
472
460
|
browserSettingsArn: string | undefined;
|
|
473
461
|
/**
|
|
474
|
-
* <p>A JSON string containing Chrome Enterprise policies that will be applied to all
|
|
475
|
-
* streaming sessions. </p>
|
|
462
|
+
* <p>A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. </p>
|
|
476
463
|
* @public
|
|
477
464
|
*/
|
|
478
465
|
browserPolicy?: string | undefined;
|
|
479
466
|
/**
|
|
480
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
481
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
482
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
483
|
-
* client token return the result from the original successful request. </p>
|
|
484
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
485
|
-
* SDK.</p>
|
|
467
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
486
468
|
* @public
|
|
487
469
|
*/
|
|
488
470
|
clientToken?: string | undefined;
|
|
@@ -575,13 +557,7 @@ export interface InlineRedactionPattern {
|
|
|
575
557
|
*/
|
|
576
558
|
exemptUrls?: string[] | undefined;
|
|
577
559
|
/**
|
|
578
|
-
* <p>The confidence level for inline redaction pattern. This indicates the certainty of data
|
|
579
|
-
* type matches in the redaction process. Confidence level 3 means high confidence, and
|
|
580
|
-
* requires a formatted text pattern match in order for content to be redacted. Confidence
|
|
581
|
-
* level 2 means medium confidence, and redaction considers both formatted and unformatted
|
|
582
|
-
* text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and
|
|
583
|
-
* redaction is enforced for both formatted pattern + unformatted pattern without keyword.
|
|
584
|
-
* This overrides the global confidence level.</p>
|
|
560
|
+
* <p>The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.</p>
|
|
585
561
|
* @public
|
|
586
562
|
*/
|
|
587
563
|
confidenceLevel?: number | undefined;
|
|
@@ -607,14 +583,7 @@ export interface InlineRedactionConfiguration {
|
|
|
607
583
|
*/
|
|
608
584
|
globalExemptUrls?: string[] | undefined;
|
|
609
585
|
/**
|
|
610
|
-
* <p>The global confidence level for the inline redaction configuration. This indicates the
|
|
611
|
-
* certainty of data type matches in the redaction process. Confidence level 3 means high
|
|
612
|
-
* confidence, and requires a formatted text pattern match in order for content to be
|
|
613
|
-
* redacted. Confidence level 2 means medium confidence, and redaction considers both
|
|
614
|
-
* formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1
|
|
615
|
-
* means low confidence, and redaction is enforced for both formatted pattern + unformatted
|
|
616
|
-
* pattern without keyword. This is applied to patterns that do not have a pattern-level
|
|
617
|
-
* confidence level. Defaults to confidence level 2.</p>
|
|
586
|
+
* <p>The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.</p>
|
|
618
587
|
* @public
|
|
619
588
|
*/
|
|
620
589
|
globalConfidenceLevel?: number | undefined;
|
|
@@ -654,12 +623,7 @@ export interface CreateDataProtectionSettingsRequest {
|
|
|
654
623
|
*/
|
|
655
624
|
inlineRedactionConfiguration?: InlineRedactionConfiguration | undefined;
|
|
656
625
|
/**
|
|
657
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
658
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
659
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
660
|
-
* client token returns the result from the original successful request. </p>
|
|
661
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
662
|
-
* SDK.</p>
|
|
626
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
663
627
|
* @public
|
|
664
628
|
*/
|
|
665
629
|
clientToken?: string | undefined;
|
|
@@ -715,8 +679,7 @@ export interface DataProtectionSettings {
|
|
|
715
679
|
*/
|
|
716
680
|
inlineRedactionConfiguration?: InlineRedactionConfiguration | undefined;
|
|
717
681
|
/**
|
|
718
|
-
* <p>A list of web portal ARNs that this data protection settings resource is associated
|
|
719
|
-
* with.</p>
|
|
682
|
+
* <p>A list of web portal ARNs that this data protection settings resource is associated with.</p>
|
|
720
683
|
* @public
|
|
721
684
|
*/
|
|
722
685
|
associatedPortalArns?: string[] | undefined;
|
|
@@ -736,8 +699,7 @@ export interface DataProtectionSettings {
|
|
|
736
699
|
*/
|
|
737
700
|
creationDate?: Date | undefined;
|
|
738
701
|
/**
|
|
739
|
-
* <p>The customer managed key used to encrypt sensitive information in the data protection
|
|
740
|
-
* settings.</p>
|
|
702
|
+
* <p>The customer managed key used to encrypt sensitive information in the data protection settings.</p>
|
|
741
703
|
* @public
|
|
742
704
|
*/
|
|
743
705
|
customerManagedKey?: string | undefined;
|
|
@@ -762,8 +724,7 @@ export interface GetDataProtectionSettingsResponse {
|
|
|
762
724
|
*/
|
|
763
725
|
export interface ListDataProtectionSettingsRequest {
|
|
764
726
|
/**
|
|
765
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
766
|
-
* operation.</p>
|
|
727
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
767
728
|
* @public
|
|
768
729
|
*/
|
|
769
730
|
nextToken?: string | undefined;
|
|
@@ -809,8 +770,7 @@ export interface ListDataProtectionSettingsResponse {
|
|
|
809
770
|
*/
|
|
810
771
|
dataProtectionSettings?: DataProtectionSettingsSummary[] | undefined;
|
|
811
772
|
/**
|
|
812
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
813
|
-
* operation.</p>
|
|
773
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
814
774
|
* @public
|
|
815
775
|
*/
|
|
816
776
|
nextToken?: string | undefined;
|
|
@@ -840,12 +800,7 @@ export interface UpdateDataProtectionSettingsRequest {
|
|
|
840
800
|
*/
|
|
841
801
|
description?: string | undefined;
|
|
842
802
|
/**
|
|
843
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
844
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
845
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
846
|
-
* client token return the result from the original successful request. </p>
|
|
847
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
848
|
-
* SDK.</p>
|
|
803
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
849
804
|
* @public
|
|
850
805
|
*/
|
|
851
806
|
clientToken?: string | undefined;
|
|
@@ -966,184 +921,12 @@ export interface CreateIdentityProviderRequest {
|
|
|
966
921
|
*/
|
|
967
922
|
identityProviderType: IdentityProviderType | undefined;
|
|
968
923
|
/**
|
|
969
|
-
* <p>The identity provider details. The following list describes the provider detail keys for
|
|
970
|
-
* each identity provider type. </p>
|
|
971
|
-
* <ul>
|
|
972
|
-
* <li>
|
|
973
|
-
* <p>For Google and Login with Amazon:</p>
|
|
974
|
-
* <ul>
|
|
975
|
-
* <li>
|
|
976
|
-
* <p>
|
|
977
|
-
* <code>client_id</code>
|
|
978
|
-
* </p>
|
|
979
|
-
* </li>
|
|
980
|
-
* <li>
|
|
981
|
-
* <p>
|
|
982
|
-
* <code>client_secret</code>
|
|
983
|
-
* </p>
|
|
984
|
-
* </li>
|
|
985
|
-
* <li>
|
|
986
|
-
* <p>
|
|
987
|
-
* <code>authorize_scopes</code>
|
|
988
|
-
* </p>
|
|
989
|
-
* </li>
|
|
990
|
-
* </ul>
|
|
991
|
-
* </li>
|
|
992
|
-
* <li>
|
|
993
|
-
* <p>For Facebook:</p>
|
|
994
|
-
* <ul>
|
|
995
|
-
* <li>
|
|
996
|
-
* <p>
|
|
997
|
-
* <code>client_id</code>
|
|
998
|
-
* </p>
|
|
999
|
-
* </li>
|
|
1000
|
-
* <li>
|
|
1001
|
-
* <p>
|
|
1002
|
-
* <code>client_secret</code>
|
|
1003
|
-
* </p>
|
|
1004
|
-
* </li>
|
|
1005
|
-
* <li>
|
|
1006
|
-
* <p>
|
|
1007
|
-
* <code>authorize_scopes</code>
|
|
1008
|
-
* </p>
|
|
1009
|
-
* </li>
|
|
1010
|
-
* <li>
|
|
1011
|
-
* <p>
|
|
1012
|
-
* <code>api_version</code>
|
|
1013
|
-
* </p>
|
|
1014
|
-
* </li>
|
|
1015
|
-
* </ul>
|
|
1016
|
-
* </li>
|
|
1017
|
-
* <li>
|
|
1018
|
-
* <p>For Sign in with Apple:</p>
|
|
1019
|
-
* <ul>
|
|
1020
|
-
* <li>
|
|
1021
|
-
* <p>
|
|
1022
|
-
* <code>client_id</code>
|
|
1023
|
-
* </p>
|
|
1024
|
-
* </li>
|
|
1025
|
-
* <li>
|
|
1026
|
-
* <p>
|
|
1027
|
-
* <code>team_id</code>
|
|
1028
|
-
* </p>
|
|
1029
|
-
* </li>
|
|
1030
|
-
* <li>
|
|
1031
|
-
* <p>
|
|
1032
|
-
* <code>key_id</code>
|
|
1033
|
-
* </p>
|
|
1034
|
-
* </li>
|
|
1035
|
-
* <li>
|
|
1036
|
-
* <p>
|
|
1037
|
-
* <code>private_key</code>
|
|
1038
|
-
* </p>
|
|
1039
|
-
* </li>
|
|
1040
|
-
* <li>
|
|
1041
|
-
* <p>
|
|
1042
|
-
* <code>authorize_scopes</code>
|
|
1043
|
-
* </p>
|
|
1044
|
-
* </li>
|
|
1045
|
-
* </ul>
|
|
1046
|
-
* </li>
|
|
1047
|
-
* <li>
|
|
1048
|
-
* <p>For OIDC providers:</p>
|
|
1049
|
-
* <ul>
|
|
1050
|
-
* <li>
|
|
1051
|
-
* <p>
|
|
1052
|
-
* <code>client_id</code>
|
|
1053
|
-
* </p>
|
|
1054
|
-
* </li>
|
|
1055
|
-
* <li>
|
|
1056
|
-
* <p>
|
|
1057
|
-
* <code>client_secret</code>
|
|
1058
|
-
* </p>
|
|
1059
|
-
* </li>
|
|
1060
|
-
* <li>
|
|
1061
|
-
* <p>
|
|
1062
|
-
* <code>attributes_request_method</code>
|
|
1063
|
-
* </p>
|
|
1064
|
-
* </li>
|
|
1065
|
-
* <li>
|
|
1066
|
-
* <p>
|
|
1067
|
-
* <code>oidc_issuer</code>
|
|
1068
|
-
* </p>
|
|
1069
|
-
* </li>
|
|
1070
|
-
* <li>
|
|
1071
|
-
* <p>
|
|
1072
|
-
* <code>authorize_scopes</code>
|
|
1073
|
-
* </p>
|
|
1074
|
-
* </li>
|
|
1075
|
-
* <li>
|
|
1076
|
-
* <p>
|
|
1077
|
-
* <code>authorize_url</code>
|
|
1078
|
-
* <i>if not available from discovery URL specified by
|
|
1079
|
-
* <code>oidc_issuer</code> key</i>
|
|
1080
|
-
* </p>
|
|
1081
|
-
* </li>
|
|
1082
|
-
* <li>
|
|
1083
|
-
* <p>
|
|
1084
|
-
* <code>token_url</code>
|
|
1085
|
-
* <i>if not available from discovery URL specified by
|
|
1086
|
-
* <code>oidc_issuer</code> key</i>
|
|
1087
|
-
* </p>
|
|
1088
|
-
* </li>
|
|
1089
|
-
* <li>
|
|
1090
|
-
* <p>
|
|
1091
|
-
* <code>attributes_url</code>
|
|
1092
|
-
* <i>if not available from discovery URL specified by
|
|
1093
|
-
* <code>oidc_issuer</code> key</i>
|
|
1094
|
-
* </p>
|
|
1095
|
-
* </li>
|
|
1096
|
-
* <li>
|
|
1097
|
-
* <p>
|
|
1098
|
-
* <code>jwks_uri</code>
|
|
1099
|
-
* <i>if not available from discovery URL specified by
|
|
1100
|
-
* <code>oidc_issuer</code> key</i>
|
|
1101
|
-
* </p>
|
|
1102
|
-
* </li>
|
|
1103
|
-
* </ul>
|
|
1104
|
-
* </li>
|
|
1105
|
-
* <li>
|
|
1106
|
-
* <p>For SAML providers:</p>
|
|
1107
|
-
* <ul>
|
|
1108
|
-
* <li>
|
|
1109
|
-
* <p>
|
|
1110
|
-
* <code>MetadataFile</code> OR <code>MetadataURL</code>
|
|
1111
|
-
* </p>
|
|
1112
|
-
* </li>
|
|
1113
|
-
* <li>
|
|
1114
|
-
* <p>
|
|
1115
|
-
* <code>IDPSignout</code> (boolean) <i>optional</i>
|
|
1116
|
-
* </p>
|
|
1117
|
-
* </li>
|
|
1118
|
-
* <li>
|
|
1119
|
-
* <p>
|
|
1120
|
-
* <code>IDPInit</code> (boolean) <i>optional</i>
|
|
1121
|
-
* </p>
|
|
1122
|
-
* </li>
|
|
1123
|
-
* <li>
|
|
1124
|
-
* <p>
|
|
1125
|
-
* <code>RequestSigningAlgorithm</code> (string) <i>optional</i>
|
|
1126
|
-
* - Only accepts <code>rsa-sha256</code>
|
|
1127
|
-
* </p>
|
|
1128
|
-
* </li>
|
|
1129
|
-
* <li>
|
|
1130
|
-
* <p>
|
|
1131
|
-
* <code>EncryptedResponses</code> (boolean) <i>optional</i>
|
|
1132
|
-
* </p>
|
|
1133
|
-
* </li>
|
|
1134
|
-
* </ul>
|
|
1135
|
-
* </li>
|
|
1136
|
-
* </ul>
|
|
924
|
+
* <p>The identity provider details. The following list describes the provider detail keys for each identity provider type. </p> <ul> <li> <p>For Google and Login with Amazon:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For Facebook:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>api_version</code> </p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>team_id</code> </p> </li> <li> <p> <code>key_id</code> </p> </li> <li> <p> <code>private_key</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For OIDC providers:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>attributes_request_method</code> </p> </li> <li> <p> <code>oidc_issuer</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>authorize_url</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> <li> <p> <code>token_url</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> <li> <p> <code>attributes_url</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> <li> <p> <code>jwks_uri</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p> <code>MetadataFile</code> OR <code>MetadataURL</code> </p> </li> <li> <p> <code>IDPSignout</code> (boolean) <i>optional</i> </p> </li> <li> <p> <code>IDPInit</code> (boolean) <i>optional</i> </p> </li> <li> <p> <code>RequestSigningAlgorithm</code> (string) <i>optional</i> - Only accepts <code>rsa-sha256</code> </p> </li> <li> <p> <code>EncryptedResponses</code> (boolean) <i>optional</i> </p> </li> </ul> </li> </ul>
|
|
1137
925
|
* @public
|
|
1138
926
|
*/
|
|
1139
927
|
identityProviderDetails: Record<string, string> | undefined;
|
|
1140
928
|
/**
|
|
1141
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1142
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
1143
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
1144
|
-
* client token returns the result from the original successful request.</p>
|
|
1145
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
1146
|
-
* SDK.</p>
|
|
929
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.</p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
1147
930
|
* @public
|
|
1148
931
|
*/
|
|
1149
932
|
clientToken?: string | undefined;
|
|
@@ -1209,174 +992,7 @@ export interface IdentityProvider {
|
|
|
1209
992
|
*/
|
|
1210
993
|
identityProviderType?: IdentityProviderType | undefined;
|
|
1211
994
|
/**
|
|
1212
|
-
* <p>The identity provider details. The following list describes the provider detail keys for
|
|
1213
|
-
* each identity provider type. </p>
|
|
1214
|
-
* <ul>
|
|
1215
|
-
* <li>
|
|
1216
|
-
* <p>For Google and Login with Amazon:</p>
|
|
1217
|
-
* <ul>
|
|
1218
|
-
* <li>
|
|
1219
|
-
* <p>
|
|
1220
|
-
* <code>client_id</code>
|
|
1221
|
-
* </p>
|
|
1222
|
-
* </li>
|
|
1223
|
-
* <li>
|
|
1224
|
-
* <p>
|
|
1225
|
-
* <code>client_secret</code>
|
|
1226
|
-
* </p>
|
|
1227
|
-
* </li>
|
|
1228
|
-
* <li>
|
|
1229
|
-
* <p>
|
|
1230
|
-
* <code>authorize_scopes</code>
|
|
1231
|
-
* </p>
|
|
1232
|
-
* </li>
|
|
1233
|
-
* </ul>
|
|
1234
|
-
* </li>
|
|
1235
|
-
* <li>
|
|
1236
|
-
* <p>For Facebook:</p>
|
|
1237
|
-
* <ul>
|
|
1238
|
-
* <li>
|
|
1239
|
-
* <p>
|
|
1240
|
-
* <code>client_id</code>
|
|
1241
|
-
* </p>
|
|
1242
|
-
* </li>
|
|
1243
|
-
* <li>
|
|
1244
|
-
* <p>
|
|
1245
|
-
* <code>client_secret</code>
|
|
1246
|
-
* </p>
|
|
1247
|
-
* </li>
|
|
1248
|
-
* <li>
|
|
1249
|
-
* <p>
|
|
1250
|
-
* <code>authorize_scopes</code>
|
|
1251
|
-
* </p>
|
|
1252
|
-
* </li>
|
|
1253
|
-
* <li>
|
|
1254
|
-
* <p>
|
|
1255
|
-
* <code>api_version</code>
|
|
1256
|
-
* </p>
|
|
1257
|
-
* </li>
|
|
1258
|
-
* </ul>
|
|
1259
|
-
* </li>
|
|
1260
|
-
* <li>
|
|
1261
|
-
* <p>For Sign in with Apple:</p>
|
|
1262
|
-
* <ul>
|
|
1263
|
-
* <li>
|
|
1264
|
-
* <p>
|
|
1265
|
-
* <code>client_id</code>
|
|
1266
|
-
* </p>
|
|
1267
|
-
* </li>
|
|
1268
|
-
* <li>
|
|
1269
|
-
* <p>
|
|
1270
|
-
* <code>team_id</code>
|
|
1271
|
-
* </p>
|
|
1272
|
-
* </li>
|
|
1273
|
-
* <li>
|
|
1274
|
-
* <p>
|
|
1275
|
-
* <code>key_id</code>
|
|
1276
|
-
* </p>
|
|
1277
|
-
* </li>
|
|
1278
|
-
* <li>
|
|
1279
|
-
* <p>
|
|
1280
|
-
* <code>private_key</code>
|
|
1281
|
-
* </p>
|
|
1282
|
-
* </li>
|
|
1283
|
-
* <li>
|
|
1284
|
-
* <p>
|
|
1285
|
-
* <code>authorize_scopes</code>
|
|
1286
|
-
* </p>
|
|
1287
|
-
* </li>
|
|
1288
|
-
* </ul>
|
|
1289
|
-
* </li>
|
|
1290
|
-
* <li>
|
|
1291
|
-
* <p>For OIDC providers:</p>
|
|
1292
|
-
* <ul>
|
|
1293
|
-
* <li>
|
|
1294
|
-
* <p>
|
|
1295
|
-
* <code>client_id</code>
|
|
1296
|
-
* </p>
|
|
1297
|
-
* </li>
|
|
1298
|
-
* <li>
|
|
1299
|
-
* <p>
|
|
1300
|
-
* <code>client_secret</code>
|
|
1301
|
-
* </p>
|
|
1302
|
-
* </li>
|
|
1303
|
-
* <li>
|
|
1304
|
-
* <p>
|
|
1305
|
-
* <code>attributes_request_method</code>
|
|
1306
|
-
* </p>
|
|
1307
|
-
* </li>
|
|
1308
|
-
* <li>
|
|
1309
|
-
* <p>
|
|
1310
|
-
* <code>oidc_issuer</code>
|
|
1311
|
-
* </p>
|
|
1312
|
-
* </li>
|
|
1313
|
-
* <li>
|
|
1314
|
-
* <p>
|
|
1315
|
-
* <code>authorize_scopes</code>
|
|
1316
|
-
* </p>
|
|
1317
|
-
* </li>
|
|
1318
|
-
* <li>
|
|
1319
|
-
* <p>
|
|
1320
|
-
* <code>authorize_url</code>
|
|
1321
|
-
* <i>if not available from discovery URL specified by oidc_issuer
|
|
1322
|
-
* key</i>
|
|
1323
|
-
* </p>
|
|
1324
|
-
* </li>
|
|
1325
|
-
* <li>
|
|
1326
|
-
* <p>
|
|
1327
|
-
* <code>token_url</code>
|
|
1328
|
-
* <i>if not available from discovery URL specified by oidc_issuer
|
|
1329
|
-
* key</i>
|
|
1330
|
-
* </p>
|
|
1331
|
-
* </li>
|
|
1332
|
-
* <li>
|
|
1333
|
-
* <p>
|
|
1334
|
-
* <code>attributes_url</code>
|
|
1335
|
-
* <i>if not available from discovery URL specified by oidc_issuer
|
|
1336
|
-
* key</i>
|
|
1337
|
-
* </p>
|
|
1338
|
-
* </li>
|
|
1339
|
-
* <li>
|
|
1340
|
-
* <p>
|
|
1341
|
-
* <code>jwks_uri</code>
|
|
1342
|
-
* <i>if not available from discovery URL specified by oidc_issuer
|
|
1343
|
-
* key</i>
|
|
1344
|
-
* </p>
|
|
1345
|
-
* </li>
|
|
1346
|
-
* </ul>
|
|
1347
|
-
* </li>
|
|
1348
|
-
* <li>
|
|
1349
|
-
* <p>For SAML providers:</p>
|
|
1350
|
-
* <ul>
|
|
1351
|
-
* <li>
|
|
1352
|
-
* <p>
|
|
1353
|
-
* <code>MetadataFile</code> OR <code>MetadataURL</code>
|
|
1354
|
-
* </p>
|
|
1355
|
-
* </li>
|
|
1356
|
-
* <li>
|
|
1357
|
-
* <p>
|
|
1358
|
-
* <code>IDPSignout</code> (boolean) <i>optional</i>
|
|
1359
|
-
* </p>
|
|
1360
|
-
* </li>
|
|
1361
|
-
* <li>
|
|
1362
|
-
* <p>
|
|
1363
|
-
* <code>IDPInit</code> (boolean) <i>optional</i>
|
|
1364
|
-
* </p>
|
|
1365
|
-
* </li>
|
|
1366
|
-
* <li>
|
|
1367
|
-
* <p>
|
|
1368
|
-
* <code>RequestSigningAlgorithm</code> (string) <i>optional</i>
|
|
1369
|
-
* - Only accepts <code>rsa-sha256</code>
|
|
1370
|
-
* </p>
|
|
1371
|
-
* </li>
|
|
1372
|
-
* <li>
|
|
1373
|
-
* <p>
|
|
1374
|
-
* <code>EncryptedResponses</code> (boolean) <i>optional</i>
|
|
1375
|
-
* </p>
|
|
1376
|
-
* </li>
|
|
1377
|
-
* </ul>
|
|
1378
|
-
* </li>
|
|
1379
|
-
* </ul>
|
|
995
|
+
* <p>The identity provider details. The following list describes the provider detail keys for each identity provider type. </p> <ul> <li> <p>For Google and Login with Amazon:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For Facebook:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>api_version</code> </p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>team_id</code> </p> </li> <li> <p> <code>key_id</code> </p> </li> <li> <p> <code>private_key</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For OIDC providers:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>attributes_request_method</code> </p> </li> <li> <p> <code>oidc_issuer</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>authorize_url</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p> <code>token_url</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p> <code>attributes_url</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p> <code>jwks_uri</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p> <code>MetadataFile</code> OR <code>MetadataURL</code> </p> </li> <li> <p> <code>IDPSignout</code> (boolean) <i>optional</i> </p> </li> <li> <p> <code>IDPInit</code> (boolean) <i>optional</i> </p> </li> <li> <p> <code>RequestSigningAlgorithm</code> (string) <i>optional</i> - Only accepts <code>rsa-sha256</code> </p> </li> <li> <p> <code>EncryptedResponses</code> (boolean) <i>optional</i> </p> </li> </ul> </li> </ul>
|
|
1380
996
|
* @public
|
|
1381
997
|
*/
|
|
1382
998
|
identityProviderDetails?: Record<string, string> | undefined;
|
|
@@ -1396,8 +1012,7 @@ export interface GetIdentityProviderResponse {
|
|
|
1396
1012
|
*/
|
|
1397
1013
|
export interface ListIdentityProvidersRequest {
|
|
1398
1014
|
/**
|
|
1399
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
1400
|
-
* operation.</p>
|
|
1015
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
1401
1016
|
* @public
|
|
1402
1017
|
*/
|
|
1403
1018
|
nextToken?: string | undefined;
|
|
@@ -1438,8 +1053,7 @@ export interface IdentityProviderSummary {
|
|
|
1438
1053
|
*/
|
|
1439
1054
|
export interface ListIdentityProvidersResponse {
|
|
1440
1055
|
/**
|
|
1441
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
1442
|
-
* operation.</p>
|
|
1056
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
1443
1057
|
* @public
|
|
1444
1058
|
*/
|
|
1445
1059
|
nextToken?: string | undefined;
|
|
@@ -1469,184 +1083,12 @@ export interface UpdateIdentityProviderRequest {
|
|
|
1469
1083
|
*/
|
|
1470
1084
|
identityProviderType?: IdentityProviderType | undefined;
|
|
1471
1085
|
/**
|
|
1472
|
-
* <p>The details of the identity provider. The following list describes the provider detail
|
|
1473
|
-
* keys for each identity provider type. </p>
|
|
1474
|
-
* <ul>
|
|
1475
|
-
* <li>
|
|
1476
|
-
* <p>For Google and Login with Amazon:</p>
|
|
1477
|
-
* <ul>
|
|
1478
|
-
* <li>
|
|
1479
|
-
* <p>
|
|
1480
|
-
* <code>client_id</code>
|
|
1481
|
-
* </p>
|
|
1482
|
-
* </li>
|
|
1483
|
-
* <li>
|
|
1484
|
-
* <p>
|
|
1485
|
-
* <code>client_secret</code>
|
|
1486
|
-
* </p>
|
|
1487
|
-
* </li>
|
|
1488
|
-
* <li>
|
|
1489
|
-
* <p>
|
|
1490
|
-
* <code>authorize_scopes</code>
|
|
1491
|
-
* </p>
|
|
1492
|
-
* </li>
|
|
1493
|
-
* </ul>
|
|
1494
|
-
* </li>
|
|
1495
|
-
* <li>
|
|
1496
|
-
* <p>For Facebook:</p>
|
|
1497
|
-
* <ul>
|
|
1498
|
-
* <li>
|
|
1499
|
-
* <p>
|
|
1500
|
-
* <code>client_id</code>
|
|
1501
|
-
* </p>
|
|
1502
|
-
* </li>
|
|
1503
|
-
* <li>
|
|
1504
|
-
* <p>
|
|
1505
|
-
* <code>client_secret</code>
|
|
1506
|
-
* </p>
|
|
1507
|
-
* </li>
|
|
1508
|
-
* <li>
|
|
1509
|
-
* <p>
|
|
1510
|
-
* <code>authorize_scopes</code>
|
|
1511
|
-
* </p>
|
|
1512
|
-
* </li>
|
|
1513
|
-
* <li>
|
|
1514
|
-
* <p>
|
|
1515
|
-
* <code>api_version</code>
|
|
1516
|
-
* </p>
|
|
1517
|
-
* </li>
|
|
1518
|
-
* </ul>
|
|
1519
|
-
* </li>
|
|
1520
|
-
* <li>
|
|
1521
|
-
* <p>For Sign in with Apple:</p>
|
|
1522
|
-
* <ul>
|
|
1523
|
-
* <li>
|
|
1524
|
-
* <p>
|
|
1525
|
-
* <code>client_id</code>
|
|
1526
|
-
* </p>
|
|
1527
|
-
* </li>
|
|
1528
|
-
* <li>
|
|
1529
|
-
* <p>
|
|
1530
|
-
* <code>team_id</code>
|
|
1531
|
-
* </p>
|
|
1532
|
-
* </li>
|
|
1533
|
-
* <li>
|
|
1534
|
-
* <p>
|
|
1535
|
-
* <code>key_id</code>
|
|
1536
|
-
* </p>
|
|
1537
|
-
* </li>
|
|
1538
|
-
* <li>
|
|
1539
|
-
* <p>
|
|
1540
|
-
* <code>private_key</code>
|
|
1541
|
-
* </p>
|
|
1542
|
-
* </li>
|
|
1543
|
-
* <li>
|
|
1544
|
-
* <p>
|
|
1545
|
-
* <code>authorize_scopes</code>
|
|
1546
|
-
* </p>
|
|
1547
|
-
* </li>
|
|
1548
|
-
* </ul>
|
|
1549
|
-
* </li>
|
|
1550
|
-
* <li>
|
|
1551
|
-
* <p>For OIDC providers:</p>
|
|
1552
|
-
* <ul>
|
|
1553
|
-
* <li>
|
|
1554
|
-
* <p>
|
|
1555
|
-
* <code>client_id</code>
|
|
1556
|
-
* </p>
|
|
1557
|
-
* </li>
|
|
1558
|
-
* <li>
|
|
1559
|
-
* <p>
|
|
1560
|
-
* <code>client_secret</code>
|
|
1561
|
-
* </p>
|
|
1562
|
-
* </li>
|
|
1563
|
-
* <li>
|
|
1564
|
-
* <p>
|
|
1565
|
-
* <code>attributes_request_method</code>
|
|
1566
|
-
* </p>
|
|
1567
|
-
* </li>
|
|
1568
|
-
* <li>
|
|
1569
|
-
* <p>
|
|
1570
|
-
* <code>oidc_issuer</code>
|
|
1571
|
-
* </p>
|
|
1572
|
-
* </li>
|
|
1573
|
-
* <li>
|
|
1574
|
-
* <p>
|
|
1575
|
-
* <code>authorize_scopes</code>
|
|
1576
|
-
* </p>
|
|
1577
|
-
* </li>
|
|
1578
|
-
* <li>
|
|
1579
|
-
* <p>
|
|
1580
|
-
* <code>authorize_url</code>
|
|
1581
|
-
* <i>if not available from discovery URL specified by
|
|
1582
|
-
* <code>oidc_issuer</code> key</i>
|
|
1583
|
-
* </p>
|
|
1584
|
-
* </li>
|
|
1585
|
-
* <li>
|
|
1586
|
-
* <p>
|
|
1587
|
-
* <code>token_url</code>
|
|
1588
|
-
* <i>if not available from discovery URL specified by
|
|
1589
|
-
* <code>oidc_issuer</code> key</i>
|
|
1590
|
-
* </p>
|
|
1591
|
-
* </li>
|
|
1592
|
-
* <li>
|
|
1593
|
-
* <p>
|
|
1594
|
-
* <code>attributes_url</code>
|
|
1595
|
-
* <i>if not available from discovery URL specified by
|
|
1596
|
-
* <code>oidc_issuer</code> key</i>
|
|
1597
|
-
* </p>
|
|
1598
|
-
* </li>
|
|
1599
|
-
* <li>
|
|
1600
|
-
* <p>
|
|
1601
|
-
* <code>jwks_uri</code>
|
|
1602
|
-
* <i>if not available from discovery URL specified by
|
|
1603
|
-
* <code>oidc_issuer</code> key</i>
|
|
1604
|
-
* </p>
|
|
1605
|
-
* </li>
|
|
1606
|
-
* </ul>
|
|
1607
|
-
* </li>
|
|
1608
|
-
* <li>
|
|
1609
|
-
* <p>For SAML providers:</p>
|
|
1610
|
-
* <ul>
|
|
1611
|
-
* <li>
|
|
1612
|
-
* <p>
|
|
1613
|
-
* <code>MetadataFile</code> OR <code>MetadataURL</code>
|
|
1614
|
-
* </p>
|
|
1615
|
-
* </li>
|
|
1616
|
-
* <li>
|
|
1617
|
-
* <p>
|
|
1618
|
-
* <code>IDPSignout</code> (boolean) <i>optional</i>
|
|
1619
|
-
* </p>
|
|
1620
|
-
* </li>
|
|
1621
|
-
* <li>
|
|
1622
|
-
* <p>
|
|
1623
|
-
* <code>IDPInit</code> (boolean) <i>optional</i>
|
|
1624
|
-
* </p>
|
|
1625
|
-
* </li>
|
|
1626
|
-
* <li>
|
|
1627
|
-
* <p>
|
|
1628
|
-
* <code>RequestSigningAlgorithm</code> (string) <i>optional</i>
|
|
1629
|
-
* - Only accepts <code>rsa-sha256</code>
|
|
1630
|
-
* </p>
|
|
1631
|
-
* </li>
|
|
1632
|
-
* <li>
|
|
1633
|
-
* <p>
|
|
1634
|
-
* <code>EncryptedResponses</code> (boolean) <i>optional</i>
|
|
1635
|
-
* </p>
|
|
1636
|
-
* </li>
|
|
1637
|
-
* </ul>
|
|
1638
|
-
* </li>
|
|
1639
|
-
* </ul>
|
|
1086
|
+
* <p>The details of the identity provider. The following list describes the provider detail keys for each identity provider type. </p> <ul> <li> <p>For Google and Login with Amazon:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For Facebook:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>api_version</code> </p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>team_id</code> </p> </li> <li> <p> <code>key_id</code> </p> </li> <li> <p> <code>private_key</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For OIDC providers:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>attributes_request_method</code> </p> </li> <li> <p> <code>oidc_issuer</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>authorize_url</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> <li> <p> <code>token_url</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> <li> <p> <code>attributes_url</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> <li> <p> <code>jwks_uri</code> <i>if not available from discovery URL specified by <code>oidc_issuer</code> key</i> </p> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p> <code>MetadataFile</code> OR <code>MetadataURL</code> </p> </li> <li> <p> <code>IDPSignout</code> (boolean) <i>optional</i> </p> </li> <li> <p> <code>IDPInit</code> (boolean) <i>optional</i> </p> </li> <li> <p> <code>RequestSigningAlgorithm</code> (string) <i>optional</i> - Only accepts <code>rsa-sha256</code> </p> </li> <li> <p> <code>EncryptedResponses</code> (boolean) <i>optional</i> </p> </li> </ul> </li> </ul>
|
|
1640
1087
|
* @public
|
|
1641
1088
|
*/
|
|
1642
1089
|
identityProviderDetails?: Record<string, string> | undefined;
|
|
1643
1090
|
/**
|
|
1644
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1645
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
1646
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
1647
|
-
* client token return the result from the original successful request. </p>
|
|
1648
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
1649
|
-
* SDK.</p>
|
|
1091
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
1650
1092
|
* @public
|
|
1651
1093
|
*/
|
|
1652
1094
|
clientToken?: string | undefined;
|
|
@@ -1712,12 +1154,7 @@ export interface CreateIpAccessSettingsRequest {
|
|
|
1712
1154
|
*/
|
|
1713
1155
|
ipRules: IpRule[] | undefined;
|
|
1714
1156
|
/**
|
|
1715
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1716
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
1717
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
1718
|
-
* client token returns the result from the original successful request. </p>
|
|
1719
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
1720
|
-
* SDK.</p>
|
|
1157
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
1721
1158
|
* @public
|
|
1722
1159
|
*/
|
|
1723
1160
|
clientToken?: string | undefined;
|
|
@@ -1768,8 +1205,7 @@ export interface IpAccessSettings {
|
|
|
1768
1205
|
*/
|
|
1769
1206
|
ipAccessSettingsArn: string | undefined;
|
|
1770
1207
|
/**
|
|
1771
|
-
* <p>A list of web portal ARNs that this IP access settings resource is associated
|
|
1772
|
-
* with.</p>
|
|
1208
|
+
* <p>A list of web portal ARNs that this IP access settings resource is associated with.</p>
|
|
1773
1209
|
* @public
|
|
1774
1210
|
*/
|
|
1775
1211
|
associatedPortalArns?: string[] | undefined;
|
|
@@ -1794,8 +1230,7 @@ export interface IpAccessSettings {
|
|
|
1794
1230
|
*/
|
|
1795
1231
|
creationDate?: Date | undefined;
|
|
1796
1232
|
/**
|
|
1797
|
-
* <p>The customer managed key used to encrypt sensitive information in the IP access
|
|
1798
|
-
* settings.</p>
|
|
1233
|
+
* <p>The customer managed key used to encrypt sensitive information in the IP access settings.</p>
|
|
1799
1234
|
* @public
|
|
1800
1235
|
*/
|
|
1801
1236
|
customerManagedKey?: string | undefined;
|
|
@@ -1820,8 +1255,7 @@ export interface GetIpAccessSettingsResponse {
|
|
|
1820
1255
|
*/
|
|
1821
1256
|
export interface ListIpAccessSettingsRequest {
|
|
1822
1257
|
/**
|
|
1823
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
1824
|
-
* operation.</p>
|
|
1258
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
1825
1259
|
* @public
|
|
1826
1260
|
*/
|
|
1827
1261
|
nextToken?: string | undefined;
|
|
@@ -1867,8 +1301,7 @@ export interface ListIpAccessSettingsResponse {
|
|
|
1867
1301
|
*/
|
|
1868
1302
|
ipAccessSettings?: IpAccessSettingsSummary[] | undefined;
|
|
1869
1303
|
/**
|
|
1870
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
1871
|
-
* operation.</p>
|
|
1304
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
1872
1305
|
* @public
|
|
1873
1306
|
*/
|
|
1874
1307
|
nextToken?: string | undefined;
|
|
@@ -1898,12 +1331,7 @@ export interface UpdateIpAccessSettingsRequest {
|
|
|
1898
1331
|
*/
|
|
1899
1332
|
ipRules?: IpRule[] | undefined;
|
|
1900
1333
|
/**
|
|
1901
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1902
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
1903
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
1904
|
-
* client token return the result from the original successful request. </p>
|
|
1905
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
1906
|
-
* SDK.</p>
|
|
1334
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
1907
1335
|
* @public
|
|
1908
1336
|
*/
|
|
1909
1337
|
clientToken?: string | undefined;
|
|
@@ -1953,8 +1381,7 @@ export interface ListSessionsRequest {
|
|
|
1953
1381
|
*/
|
|
1954
1382
|
maxResults?: number | undefined;
|
|
1955
1383
|
/**
|
|
1956
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
1957
|
-
* operation.</p>
|
|
1384
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
1958
1385
|
* @public
|
|
1959
1386
|
*/
|
|
1960
1387
|
nextToken?: string | undefined;
|
|
@@ -2005,8 +1432,7 @@ export interface ListSessionsResponse {
|
|
|
2005
1432
|
*/
|
|
2006
1433
|
sessions: SessionSummary[] | undefined;
|
|
2007
1434
|
/**
|
|
2008
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
2009
|
-
* operation.</p>
|
|
1435
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
2010
1436
|
* @public
|
|
2011
1437
|
*/
|
|
2012
1438
|
nextToken?: string | undefined;
|
|
@@ -2041,14 +1467,12 @@ export interface CreateNetworkSettingsRequest {
|
|
|
2041
1467
|
*/
|
|
2042
1468
|
vpcId: string | undefined;
|
|
2043
1469
|
/**
|
|
2044
|
-
* <p>The subnets in which network interfaces are created to connect streaming instances to
|
|
2045
|
-
* your VPC. At least two of these subnets must be in different availability zones.</p>
|
|
1470
|
+
* <p>The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.</p>
|
|
2046
1471
|
* @public
|
|
2047
1472
|
*/
|
|
2048
1473
|
subnetIds: string[] | undefined;
|
|
2049
1474
|
/**
|
|
2050
|
-
* <p>One or more security groups used to control access from streaming instances to your
|
|
2051
|
-
* VPC.</p>
|
|
1475
|
+
* <p>One or more security groups used to control access from streaming instances to your VPC.</p>
|
|
2052
1476
|
* @public
|
|
2053
1477
|
*/
|
|
2054
1478
|
securityGroupIds: string[] | undefined;
|
|
@@ -2058,12 +1482,7 @@ export interface CreateNetworkSettingsRequest {
|
|
|
2058
1482
|
*/
|
|
2059
1483
|
tags?: Tag[] | undefined;
|
|
2060
1484
|
/**
|
|
2061
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2062
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
2063
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
2064
|
-
* client token returns the result from the original successful request. </p>
|
|
2065
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
2066
|
-
* SDK.</p>
|
|
1485
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
2067
1486
|
* @public
|
|
2068
1487
|
*/
|
|
2069
1488
|
clientToken?: string | undefined;
|
|
@@ -2104,9 +1523,7 @@ export interface GetNetworkSettingsRequest {
|
|
|
2104
1523
|
networkSettingsArn: string | undefined;
|
|
2105
1524
|
}
|
|
2106
1525
|
/**
|
|
2107
|
-
* <p>A network settings resource that can be associated with a web portal. Once associated
|
|
2108
|
-
* with a web portal, network settings define how streaming instances will connect with your
|
|
2109
|
-
* specified VPC. </p>
|
|
1526
|
+
* <p>A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC. </p>
|
|
2110
1527
|
* @public
|
|
2111
1528
|
*/
|
|
2112
1529
|
export interface NetworkSettings {
|
|
@@ -2126,14 +1543,12 @@ export interface NetworkSettings {
|
|
|
2126
1543
|
*/
|
|
2127
1544
|
vpcId?: string | undefined;
|
|
2128
1545
|
/**
|
|
2129
|
-
* <p>The subnets in which network interfaces are created to connect streaming instances to
|
|
2130
|
-
* your VPC. At least two of these subnets must be in different availability zones.</p>
|
|
1546
|
+
* <p>The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.</p>
|
|
2131
1547
|
* @public
|
|
2132
1548
|
*/
|
|
2133
1549
|
subnetIds?: string[] | undefined;
|
|
2134
1550
|
/**
|
|
2135
|
-
* <p>One or more security groups used to control access from streaming instances to your VPC.
|
|
2136
|
-
* </p>
|
|
1551
|
+
* <p>One or more security groups used to control access from streaming instances to your VPC. </p>
|
|
2137
1552
|
* @public
|
|
2138
1553
|
*/
|
|
2139
1554
|
securityGroupIds?: string[] | undefined;
|
|
@@ -2153,8 +1568,7 @@ export interface GetNetworkSettingsResponse {
|
|
|
2153
1568
|
*/
|
|
2154
1569
|
export interface ListNetworkSettingsRequest {
|
|
2155
1570
|
/**
|
|
2156
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
2157
|
-
* operation.</p>
|
|
1571
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
2158
1572
|
* @public
|
|
2159
1573
|
*/
|
|
2160
1574
|
nextToken?: string | undefined;
|
|
@@ -2190,8 +1604,7 @@ export interface ListNetworkSettingsResponse {
|
|
|
2190
1604
|
*/
|
|
2191
1605
|
networkSettings?: NetworkSettingsSummary[] | undefined;
|
|
2192
1606
|
/**
|
|
2193
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
2194
|
-
* operation.</p>
|
|
1607
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
2195
1608
|
* @public
|
|
2196
1609
|
*/
|
|
2197
1610
|
nextToken?: string | undefined;
|
|
@@ -2211,24 +1624,17 @@ export interface UpdateNetworkSettingsRequest {
|
|
|
2211
1624
|
*/
|
|
2212
1625
|
vpcId?: string | undefined;
|
|
2213
1626
|
/**
|
|
2214
|
-
* <p>The subnets in which network interfaces are created to connect streaming instances to
|
|
2215
|
-
* your VPC. At least two of these subnets must be in different availability zones.</p>
|
|
1627
|
+
* <p>The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.</p>
|
|
2216
1628
|
* @public
|
|
2217
1629
|
*/
|
|
2218
1630
|
subnetIds?: string[] | undefined;
|
|
2219
1631
|
/**
|
|
2220
|
-
* <p>One or more security groups used to control access from streaming instances to your
|
|
2221
|
-
* VPC.</p>
|
|
1632
|
+
* <p>One or more security groups used to control access from streaming instances to your VPC.</p>
|
|
2222
1633
|
* @public
|
|
2223
1634
|
*/
|
|
2224
1635
|
securityGroupIds?: string[] | undefined;
|
|
2225
1636
|
/**
|
|
2226
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2227
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
2228
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
2229
|
-
* client token return the result from the original successful request. </p>
|
|
2230
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
2231
|
-
* SDK.</p>
|
|
1637
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
2232
1638
|
* @public
|
|
2233
1639
|
*/
|
|
2234
1640
|
clientToken?: string | undefined;
|
|
@@ -2248,8 +1654,7 @@ export interface UpdateNetworkSettingsResponse {
|
|
|
2248
1654
|
*/
|
|
2249
1655
|
export interface CreatePortalRequest {
|
|
2250
1656
|
/**
|
|
2251
|
-
* <p>The name of the web portal. This is not visible to users who log into the web
|
|
2252
|
-
* portal.</p>
|
|
1657
|
+
* <p>The name of the web portal. This is not visible to users who log into the web portal.</p>
|
|
2253
1658
|
* @public
|
|
2254
1659
|
*/
|
|
2255
1660
|
displayName?: string | undefined;
|
|
@@ -2269,27 +1674,12 @@ export interface CreatePortalRequest {
|
|
|
2269
1674
|
*/
|
|
2270
1675
|
additionalEncryptionContext?: Record<string, string> | undefined;
|
|
2271
1676
|
/**
|
|
2272
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2273
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
2274
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
2275
|
-
* client token returns the result from the original successful request. </p>
|
|
2276
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
2277
|
-
* SDK.</p>
|
|
1677
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
2278
1678
|
* @public
|
|
2279
1679
|
*/
|
|
2280
1680
|
clientToken?: string | undefined;
|
|
2281
1681
|
/**
|
|
2282
|
-
* <p>The type of authentication integration points used when signing into the web portal.
|
|
2283
|
-
* Defaults to <code>Standard</code>.</p>
|
|
2284
|
-
* <p>
|
|
2285
|
-
* <code>Standard</code> web portals are authenticated directly through your identity
|
|
2286
|
-
* provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity
|
|
2287
|
-
* provider with your web portal. User and group access to your web portal is controlled
|
|
2288
|
-
* through your identity provider.</p>
|
|
2289
|
-
* <p>
|
|
2290
|
-
* <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources
|
|
2291
|
-
* (including external identity provider integration), plus user and group access to your web
|
|
2292
|
-
* portal, can be configured in the IAM Identity Center.</p>
|
|
1682
|
+
* <p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.</p>
|
|
2293
1683
|
* @public
|
|
2294
1684
|
*/
|
|
2295
1685
|
authenticationType?: AuthenticationType | undefined;
|
|
@@ -2314,8 +1704,7 @@ export interface CreatePortalResponse {
|
|
|
2314
1704
|
*/
|
|
2315
1705
|
portalArn: string | undefined;
|
|
2316
1706
|
/**
|
|
2317
|
-
* <p>The endpoint URL of the web portal that users access in order to start streaming
|
|
2318
|
-
* sessions.</p>
|
|
1707
|
+
* <p>The endpoint URL of the web portal that users access in order to start streaming sessions.</p>
|
|
2319
1708
|
* @public
|
|
2320
1709
|
*/
|
|
2321
1710
|
portalEndpoint: string | undefined;
|
|
@@ -2491,8 +1880,7 @@ export interface Portal {
|
|
|
2491
1880
|
*/
|
|
2492
1881
|
portalStatus?: PortalStatus | undefined;
|
|
2493
1882
|
/**
|
|
2494
|
-
* <p>The endpoint URL of the web portal that users access in order to start streaming
|
|
2495
|
-
* sessions.</p>
|
|
1883
|
+
* <p>The endpoint URL of the web portal that users access in order to start streaming sessions.</p>
|
|
2496
1884
|
* @public
|
|
2497
1885
|
*/
|
|
2498
1886
|
portalEndpoint?: string | undefined;
|
|
@@ -2542,23 +1930,12 @@ export interface Portal {
|
|
|
2542
1930
|
*/
|
|
2543
1931
|
statusReason?: string | undefined;
|
|
2544
1932
|
/**
|
|
2545
|
-
* <p>The ARN of the user access logging settings that is associated with the web
|
|
2546
|
-
* portal.</p>
|
|
1933
|
+
* <p>The ARN of the user access logging settings that is associated with the web portal.</p>
|
|
2547
1934
|
* @public
|
|
2548
1935
|
*/
|
|
2549
1936
|
userAccessLoggingSettingsArn?: string | undefined;
|
|
2550
1937
|
/**
|
|
2551
|
-
* <p>The type of authentication integration points used when signing into the web portal.
|
|
2552
|
-
* Defaults to <code>Standard</code>.</p>
|
|
2553
|
-
* <p>
|
|
2554
|
-
* <code>Standard</code> web portals are authenticated directly through your identity
|
|
2555
|
-
* provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity
|
|
2556
|
-
* provider with your web portal. User and group access to your web portal is controlled
|
|
2557
|
-
* through your identity provider.</p>
|
|
2558
|
-
* <p>
|
|
2559
|
-
* <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources
|
|
2560
|
-
* (including external identity provider integration), plus user and group access to your web
|
|
2561
|
-
* portal, can be configured in the IAM Identity Center.</p>
|
|
1938
|
+
* <p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.</p>
|
|
2562
1939
|
* @public
|
|
2563
1940
|
*/
|
|
2564
1941
|
authenticationType?: AuthenticationType | undefined;
|
|
@@ -2628,8 +2005,7 @@ export interface GetPortalServiceProviderMetadataResponse {
|
|
|
2628
2005
|
*/
|
|
2629
2006
|
export interface ListPortalsRequest {
|
|
2630
2007
|
/**
|
|
2631
|
-
* <p>The pagination token used to retrieve the next page of results for this operation.
|
|
2632
|
-
* </p>
|
|
2008
|
+
* <p>The pagination token used to retrieve the next page of results for this operation. </p>
|
|
2633
2009
|
* @public
|
|
2634
2010
|
*/
|
|
2635
2011
|
nextToken?: string | undefined;
|
|
@@ -2665,8 +2041,7 @@ export interface PortalSummary {
|
|
|
2665
2041
|
*/
|
|
2666
2042
|
portalStatus?: PortalStatus | undefined;
|
|
2667
2043
|
/**
|
|
2668
|
-
* <p>The endpoint URL of the web portal that users access in order to start streaming
|
|
2669
|
-
* sessions.</p>
|
|
2044
|
+
* <p>The endpoint URL of the web portal that users access in order to start streaming sessions.</p>
|
|
2670
2045
|
* @public
|
|
2671
2046
|
*/
|
|
2672
2047
|
portalEndpoint?: string | undefined;
|
|
@@ -2711,23 +2086,12 @@ export interface PortalSummary {
|
|
|
2711
2086
|
*/
|
|
2712
2087
|
trustStoreArn?: string | undefined;
|
|
2713
2088
|
/**
|
|
2714
|
-
* <p>The ARN of the user access logging settings that is associated with the web
|
|
2715
|
-
* portal.</p>
|
|
2089
|
+
* <p>The ARN of the user access logging settings that is associated with the web portal.</p>
|
|
2716
2090
|
* @public
|
|
2717
2091
|
*/
|
|
2718
2092
|
userAccessLoggingSettingsArn?: string | undefined;
|
|
2719
2093
|
/**
|
|
2720
|
-
* <p>The type of authentication integration points used when signing into the web portal.
|
|
2721
|
-
* Defaults to <code>Standard</code>.</p>
|
|
2722
|
-
* <p>
|
|
2723
|
-
* <code>Standard</code> web portals are authenticated directly through your identity
|
|
2724
|
-
* provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity
|
|
2725
|
-
* provider with your web portal. User and group access to your web portal is controlled
|
|
2726
|
-
* through your identity provider.</p>
|
|
2727
|
-
* <p>
|
|
2728
|
-
* <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources
|
|
2729
|
-
* (including external identity provider integration), plus user and group access to your web
|
|
2730
|
-
* portal, can be configured in the IAM Identity Center.</p>
|
|
2094
|
+
* <p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.</p>
|
|
2731
2095
|
* @public
|
|
2732
2096
|
*/
|
|
2733
2097
|
authenticationType?: AuthenticationType | undefined;
|
|
@@ -2757,8 +2121,7 @@ export interface ListPortalsResponse {
|
|
|
2757
2121
|
*/
|
|
2758
2122
|
portals?: PortalSummary[] | undefined;
|
|
2759
2123
|
/**
|
|
2760
|
-
* <p>The pagination token used to retrieve the next page of results for this operation.
|
|
2761
|
-
* </p>
|
|
2124
|
+
* <p>The pagination token used to retrieve the next page of results for this operation. </p>
|
|
2762
2125
|
* @public
|
|
2763
2126
|
*/
|
|
2764
2127
|
nextToken?: string | undefined;
|
|
@@ -2773,23 +2136,12 @@ export interface UpdatePortalRequest {
|
|
|
2773
2136
|
*/
|
|
2774
2137
|
portalArn: string | undefined;
|
|
2775
2138
|
/**
|
|
2776
|
-
* <p>The name of the web portal. This is not visible to users who log into the web
|
|
2777
|
-
* portal.</p>
|
|
2139
|
+
* <p>The name of the web portal. This is not visible to users who log into the web portal.</p>
|
|
2778
2140
|
* @public
|
|
2779
2141
|
*/
|
|
2780
2142
|
displayName?: string | undefined;
|
|
2781
2143
|
/**
|
|
2782
|
-
* <p>The type of authentication integration points used when signing into the web portal.
|
|
2783
|
-
* Defaults to <code>Standard</code>.</p>
|
|
2784
|
-
* <p>
|
|
2785
|
-
* <code>Standard</code> web portals are authenticated directly through your identity
|
|
2786
|
-
* provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity
|
|
2787
|
-
* provider with your web portal. User and group access to your web portal is controlled
|
|
2788
|
-
* through your identity provider.</p>
|
|
2789
|
-
* <p>
|
|
2790
|
-
* <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources
|
|
2791
|
-
* (including external identity provider integration), plus user and group access to your web
|
|
2792
|
-
* portal, can be configured in the IAM Identity Center.</p>
|
|
2144
|
+
* <p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.</p>
|
|
2793
2145
|
* @public
|
|
2794
2146
|
*/
|
|
2795
2147
|
authenticationType?: AuthenticationType | undefined;
|
|
@@ -3143,12 +2495,7 @@ export interface TagResourceRequest {
|
|
|
3143
2495
|
*/
|
|
3144
2496
|
tags: Tag[] | undefined;
|
|
3145
2497
|
/**
|
|
3146
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3147
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
3148
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
3149
|
-
* client token returns the result from the original successful request. </p>
|
|
3150
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
3151
|
-
* SDK.</p>
|
|
2498
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
3152
2499
|
* @public
|
|
3153
2500
|
*/
|
|
3154
2501
|
clientToken?: string | undefined;
|
|
@@ -3204,12 +2551,7 @@ export interface CreateTrustStoreRequest {
|
|
|
3204
2551
|
*/
|
|
3205
2552
|
tags?: Tag[] | undefined;
|
|
3206
2553
|
/**
|
|
3207
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3208
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
3209
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
3210
|
-
* client token returns the result from the original successful request. </p>
|
|
3211
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
3212
|
-
* SDK.</p>
|
|
2554
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
3213
2555
|
* @public
|
|
3214
2556
|
*/
|
|
3215
2557
|
clientToken?: string | undefined;
|
|
@@ -3250,11 +2592,7 @@ export interface GetTrustStoreRequest {
|
|
|
3250
2592
|
trustStoreArn: string | undefined;
|
|
3251
2593
|
}
|
|
3252
2594
|
/**
|
|
3253
|
-
* <p>A trust store that can be associated with a web portal. A trust store contains
|
|
3254
|
-
* certificate authority (CA) certificates. Once associated with a web portal, the browser in
|
|
3255
|
-
* a streaming session will recognize certificates that have been issued using any of the CAs
|
|
3256
|
-
* in the trust store. If your organization has internal websites that use certificates issued
|
|
3257
|
-
* by private CAs, you should add the private CA certificate to the trust store. </p>
|
|
2595
|
+
* <p>A trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store. </p>
|
|
3258
2596
|
* @public
|
|
3259
2597
|
*/
|
|
3260
2598
|
export interface TrustStore {
|
|
@@ -3355,8 +2693,7 @@ export interface ListTrustStoreCertificatesRequest {
|
|
|
3355
2693
|
*/
|
|
3356
2694
|
trustStoreArn: string | undefined;
|
|
3357
2695
|
/**
|
|
3358
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
3359
|
-
* operation.</p>
|
|
2696
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
3360
2697
|
* @public
|
|
3361
2698
|
*/
|
|
3362
2699
|
nextToken?: string | undefined;
|
|
@@ -3381,8 +2718,7 @@ export interface ListTrustStoreCertificatesResponse {
|
|
|
3381
2718
|
*/
|
|
3382
2719
|
trustStoreArn: string | undefined;
|
|
3383
2720
|
/**
|
|
3384
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
3385
|
-
* operation.></p>
|
|
2721
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.></p>
|
|
3386
2722
|
* @public
|
|
3387
2723
|
*/
|
|
3388
2724
|
nextToken?: string | undefined;
|
|
@@ -3392,8 +2728,7 @@ export interface ListTrustStoreCertificatesResponse {
|
|
|
3392
2728
|
*/
|
|
3393
2729
|
export interface ListTrustStoresRequest {
|
|
3394
2730
|
/**
|
|
3395
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
3396
|
-
* operation.</p>
|
|
2731
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
3397
2732
|
* @public
|
|
3398
2733
|
*/
|
|
3399
2734
|
nextToken?: string | undefined;
|
|
@@ -3424,8 +2759,7 @@ export interface ListTrustStoresResponse {
|
|
|
3424
2759
|
*/
|
|
3425
2760
|
trustStores?: TrustStoreSummary[] | undefined;
|
|
3426
2761
|
/**
|
|
3427
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
3428
|
-
* operation.</p>
|
|
2762
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
3429
2763
|
* @public
|
|
3430
2764
|
*/
|
|
3431
2765
|
nextToken?: string | undefined;
|
|
@@ -3450,12 +2784,7 @@ export interface UpdateTrustStoreRequest {
|
|
|
3450
2784
|
*/
|
|
3451
2785
|
certificatesToDelete?: string[] | undefined;
|
|
3452
2786
|
/**
|
|
3453
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3454
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
3455
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
3456
|
-
* client token return the result from the original successful request. </p>
|
|
3457
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
3458
|
-
* SDK.</p>
|
|
2787
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
3459
2788
|
* @public
|
|
3460
2789
|
*/
|
|
3461
2790
|
clientToken?: string | undefined;
|
|
@@ -3505,12 +2834,7 @@ export interface CreateUserAccessLoggingSettingsRequest {
|
|
|
3505
2834
|
*/
|
|
3506
2835
|
tags?: Tag[] | undefined;
|
|
3507
2836
|
/**
|
|
3508
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3509
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
3510
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
3511
|
-
* client token returns the result from the original successful request. </p>
|
|
3512
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
3513
|
-
* SDK.</p>
|
|
2837
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
3514
2838
|
* @public
|
|
3515
2839
|
*/
|
|
3516
2840
|
clientToken?: string | undefined;
|
|
@@ -3561,8 +2885,7 @@ export interface UserAccessLoggingSettings {
|
|
|
3561
2885
|
*/
|
|
3562
2886
|
userAccessLoggingSettingsArn: string | undefined;
|
|
3563
2887
|
/**
|
|
3564
|
-
* <p>A list of web portal ARNs that this user access logging settings is associated
|
|
3565
|
-
* with.</p>
|
|
2888
|
+
* <p>A list of web portal ARNs that this user access logging settings is associated with.</p>
|
|
3566
2889
|
* @public
|
|
3567
2890
|
*/
|
|
3568
2891
|
associatedPortalArns?: string[] | undefined;
|
|
@@ -3587,8 +2910,7 @@ export interface GetUserAccessLoggingSettingsResponse {
|
|
|
3587
2910
|
*/
|
|
3588
2911
|
export interface ListUserAccessLoggingSettingsRequest {
|
|
3589
2912
|
/**
|
|
3590
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
3591
|
-
* operation.</p>
|
|
2913
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
3592
2914
|
* @public
|
|
3593
2915
|
*/
|
|
3594
2916
|
nextToken?: string | undefined;
|
|
@@ -3624,8 +2946,7 @@ export interface ListUserAccessLoggingSettingsResponse {
|
|
|
3624
2946
|
*/
|
|
3625
2947
|
userAccessLoggingSettings?: UserAccessLoggingSettingsSummary[] | undefined;
|
|
3626
2948
|
/**
|
|
3627
|
-
* <p>The pagination token used to retrieve the next page of results for this
|
|
3628
|
-
* operation.</p>
|
|
2949
|
+
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
3629
2950
|
* @public
|
|
3630
2951
|
*/
|
|
3631
2952
|
nextToken?: string | undefined;
|
|
@@ -3645,12 +2966,7 @@ export interface UpdateUserAccessLoggingSettingsRequest {
|
|
|
3645
2966
|
*/
|
|
3646
2967
|
kinesisStreamArn?: string | undefined;
|
|
3647
2968
|
/**
|
|
3648
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3649
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
3650
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
3651
|
-
* client token return the result from the original successful request. </p>
|
|
3652
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
3653
|
-
* SDK.</p>
|
|
2969
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
3654
2970
|
* @public
|
|
3655
2971
|
*/
|
|
3656
2972
|
clientToken?: string | undefined;
|
|
@@ -3665,6 +2981,109 @@ export interface UpdateUserAccessLoggingSettingsResponse {
|
|
|
3665
2981
|
*/
|
|
3666
2982
|
userAccessLoggingSettings: UserAccessLoggingSettings | undefined;
|
|
3667
2983
|
}
|
|
2984
|
+
/**
|
|
2985
|
+
* <p>Metadata information about an uploaded image file.</p>
|
|
2986
|
+
* @public
|
|
2987
|
+
*/
|
|
2988
|
+
export interface ImageMetadata {
|
|
2989
|
+
/**
|
|
2990
|
+
* <p>The MIME type of the image.</p>
|
|
2991
|
+
* @public
|
|
2992
|
+
*/
|
|
2993
|
+
mimeType: MimeType | undefined;
|
|
2994
|
+
/**
|
|
2995
|
+
* <p>The file extension of the image.</p>
|
|
2996
|
+
* @public
|
|
2997
|
+
*/
|
|
2998
|
+
fileExtension: string | undefined;
|
|
2999
|
+
/**
|
|
3000
|
+
* <p>The timestamp when the image was last uploaded.</p>
|
|
3001
|
+
* @public
|
|
3002
|
+
*/
|
|
3003
|
+
lastUploadTimestamp: Date | undefined;
|
|
3004
|
+
}
|
|
3005
|
+
/**
|
|
3006
|
+
* <p>Localized text strings for a specific language that customize the web portal.</p>
|
|
3007
|
+
* @public
|
|
3008
|
+
*/
|
|
3009
|
+
export interface LocalizedBrandingStrings {
|
|
3010
|
+
/**
|
|
3011
|
+
* <p>The text displayed in the browser tab title.</p>
|
|
3012
|
+
* @public
|
|
3013
|
+
*/
|
|
3014
|
+
browserTabTitle: string | undefined;
|
|
3015
|
+
/**
|
|
3016
|
+
* <p>The welcome text displayed on the sign-in page.</p>
|
|
3017
|
+
* @public
|
|
3018
|
+
*/
|
|
3019
|
+
welcomeText: string | undefined;
|
|
3020
|
+
/**
|
|
3021
|
+
* <p>The title text for the login section. This field is optional and defaults to "Sign In".</p>
|
|
3022
|
+
* @public
|
|
3023
|
+
*/
|
|
3024
|
+
loginTitle?: string | undefined;
|
|
3025
|
+
/**
|
|
3026
|
+
* <p>The description text for the login section. This field is optional and defaults to "Sign in to your session".</p>
|
|
3027
|
+
* @public
|
|
3028
|
+
*/
|
|
3029
|
+
loginDescription?: string | undefined;
|
|
3030
|
+
/**
|
|
3031
|
+
* <p>The text displayed on the login button. This field is optional and defaults to "Sign In".</p>
|
|
3032
|
+
* @public
|
|
3033
|
+
*/
|
|
3034
|
+
loginButtonText?: string | undefined;
|
|
3035
|
+
/**
|
|
3036
|
+
* <p>A contact link URL. The URL must start with <code>https://</code> or <code>mailto:</code>. If not provided, the contact button will be hidden from the web portal screen.</p>
|
|
3037
|
+
* @public
|
|
3038
|
+
*/
|
|
3039
|
+
contactLink?: string | undefined;
|
|
3040
|
+
/**
|
|
3041
|
+
* <p>The text displayed on the contact button. This field is optional and defaults to "Contact us".</p>
|
|
3042
|
+
* @public
|
|
3043
|
+
*/
|
|
3044
|
+
contactButtonText?: string | undefined;
|
|
3045
|
+
/**
|
|
3046
|
+
* <p>The text displayed during session loading. This field is optional and defaults to "Loading your session".</p>
|
|
3047
|
+
* @public
|
|
3048
|
+
*/
|
|
3049
|
+
loadingText?: string | undefined;
|
|
3050
|
+
}
|
|
3051
|
+
/**
|
|
3052
|
+
* <p>The branding configuration output including custom images metadata, localized strings, color theme, and terms of service.</p>
|
|
3053
|
+
* @public
|
|
3054
|
+
*/
|
|
3055
|
+
export interface BrandingConfiguration {
|
|
3056
|
+
/**
|
|
3057
|
+
* <p>Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.</p>
|
|
3058
|
+
* @public
|
|
3059
|
+
*/
|
|
3060
|
+
logo: ImageMetadata | undefined;
|
|
3061
|
+
/**
|
|
3062
|
+
* <p>Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.</p>
|
|
3063
|
+
* @public
|
|
3064
|
+
*/
|
|
3065
|
+
wallpaper: ImageMetadata | undefined;
|
|
3066
|
+
/**
|
|
3067
|
+
* <p>Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.</p>
|
|
3068
|
+
* @public
|
|
3069
|
+
*/
|
|
3070
|
+
favicon: ImageMetadata | undefined;
|
|
3071
|
+
/**
|
|
3072
|
+
* <p>A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.</p>
|
|
3073
|
+
* @public
|
|
3074
|
+
*/
|
|
3075
|
+
localizedStrings: Partial<Record<Locale, LocalizedBrandingStrings>> | undefined;
|
|
3076
|
+
/**
|
|
3077
|
+
* <p>The color theme for components on the web portal.</p>
|
|
3078
|
+
* @public
|
|
3079
|
+
*/
|
|
3080
|
+
colorTheme: ColorTheme | undefined;
|
|
3081
|
+
/**
|
|
3082
|
+
* <p>The terms of service text in Markdown format that users must accept before accessing the portal.</p>
|
|
3083
|
+
* @public
|
|
3084
|
+
*/
|
|
3085
|
+
termsOfService?: string | undefined;
|
|
3086
|
+
}
|
|
3668
3087
|
/**
|
|
3669
3088
|
* <p>Specifies a single cookie or set of cookies in an end user's browser.</p>
|
|
3670
3089
|
* @public
|
|
@@ -3687,24 +3106,147 @@ export interface CookieSpecification {
|
|
|
3687
3106
|
path?: string | undefined;
|
|
3688
3107
|
}
|
|
3689
3108
|
/**
|
|
3690
|
-
* <p>The configuration that specifies which cookies should be synchronized from the end
|
|
3691
|
-
* user's local browser to the remote browser.</p>
|
|
3109
|
+
* <p>The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.</p>
|
|
3692
3110
|
* @public
|
|
3693
3111
|
*/
|
|
3694
3112
|
export interface CookieSynchronizationConfiguration {
|
|
3695
3113
|
/**
|
|
3696
|
-
* <p>The list of cookie specifications that are allowed to be synchronized to the remote
|
|
3697
|
-
* browser.</p>
|
|
3114
|
+
* <p>The list of cookie specifications that are allowed to be synchronized to the remote browser.</p>
|
|
3698
3115
|
* @public
|
|
3699
3116
|
*/
|
|
3700
3117
|
allowlist: CookieSpecification[] | undefined;
|
|
3701
3118
|
/**
|
|
3702
|
-
* <p>The list of cookie specifications that are blocked from being synchronized to the remote
|
|
3703
|
-
* browser.</p>
|
|
3119
|
+
* <p>The list of cookie specifications that are blocked from being synchronized to the remote browser.</p>
|
|
3704
3120
|
* @public
|
|
3705
3121
|
*/
|
|
3706
3122
|
blocklist?: CookieSpecification[] | undefined;
|
|
3707
3123
|
}
|
|
3124
|
+
/**
|
|
3125
|
+
* <p>The input for an icon image (logo or favicon). Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.</p>
|
|
3126
|
+
* @public
|
|
3127
|
+
*/
|
|
3128
|
+
export type IconImageInput = IconImageInput.BlobMember | IconImageInput.S3UriMember | IconImageInput.$UnknownMember;
|
|
3129
|
+
/**
|
|
3130
|
+
* @public
|
|
3131
|
+
*/
|
|
3132
|
+
export declare namespace IconImageInput {
|
|
3133
|
+
/**
|
|
3134
|
+
* <p>The image provided as a binary image file.</p>
|
|
3135
|
+
* @public
|
|
3136
|
+
*/
|
|
3137
|
+
interface BlobMember {
|
|
3138
|
+
blob: Uint8Array;
|
|
3139
|
+
s3Uri?: never;
|
|
3140
|
+
$unknown?: never;
|
|
3141
|
+
}
|
|
3142
|
+
/**
|
|
3143
|
+
* <p>The S3 URI pointing to the image file. The URI must use the format <code>s3://bucket-name/key-name</code>. You must have read access to the S3 object.</p>
|
|
3144
|
+
* @public
|
|
3145
|
+
*/
|
|
3146
|
+
interface S3UriMember {
|
|
3147
|
+
blob?: never;
|
|
3148
|
+
s3Uri: string;
|
|
3149
|
+
$unknown?: never;
|
|
3150
|
+
}
|
|
3151
|
+
/**
|
|
3152
|
+
* @public
|
|
3153
|
+
*/
|
|
3154
|
+
interface $UnknownMember {
|
|
3155
|
+
blob?: never;
|
|
3156
|
+
s3Uri?: never;
|
|
3157
|
+
$unknown: [string, any];
|
|
3158
|
+
}
|
|
3159
|
+
/**
|
|
3160
|
+
* @deprecated unused in schema-serde mode.
|
|
3161
|
+
*
|
|
3162
|
+
*/
|
|
3163
|
+
interface Visitor<T> {
|
|
3164
|
+
blob: (value: Uint8Array) => T;
|
|
3165
|
+
s3Uri: (value: string) => T;
|
|
3166
|
+
_: (name: string, value: any) => T;
|
|
3167
|
+
}
|
|
3168
|
+
}
|
|
3169
|
+
/**
|
|
3170
|
+
* <p>The input for a wallpaper image. Provide the image as either a binary image file or an S3 URI. Maximum 5 MB in JPEG or PNG format.</p>
|
|
3171
|
+
* @public
|
|
3172
|
+
*/
|
|
3173
|
+
export type WallpaperImageInput = WallpaperImageInput.BlobMember | WallpaperImageInput.S3UriMember | WallpaperImageInput.$UnknownMember;
|
|
3174
|
+
/**
|
|
3175
|
+
* @public
|
|
3176
|
+
*/
|
|
3177
|
+
export declare namespace WallpaperImageInput {
|
|
3178
|
+
/**
|
|
3179
|
+
* <p>The image provided as a binary image file.</p>
|
|
3180
|
+
* @public
|
|
3181
|
+
*/
|
|
3182
|
+
interface BlobMember {
|
|
3183
|
+
blob: Uint8Array;
|
|
3184
|
+
s3Uri?: never;
|
|
3185
|
+
$unknown?: never;
|
|
3186
|
+
}
|
|
3187
|
+
/**
|
|
3188
|
+
* <p>The S3 URI pointing to the image file. The URI must use the format <code>s3://bucket-name/key-name</code>. You must have read access to the S3 object.</p>
|
|
3189
|
+
* @public
|
|
3190
|
+
*/
|
|
3191
|
+
interface S3UriMember {
|
|
3192
|
+
blob?: never;
|
|
3193
|
+
s3Uri: string;
|
|
3194
|
+
$unknown?: never;
|
|
3195
|
+
}
|
|
3196
|
+
/**
|
|
3197
|
+
* @public
|
|
3198
|
+
*/
|
|
3199
|
+
interface $UnknownMember {
|
|
3200
|
+
blob?: never;
|
|
3201
|
+
s3Uri?: never;
|
|
3202
|
+
$unknown: [string, any];
|
|
3203
|
+
}
|
|
3204
|
+
/**
|
|
3205
|
+
* @deprecated unused in schema-serde mode.
|
|
3206
|
+
*
|
|
3207
|
+
*/
|
|
3208
|
+
interface Visitor<T> {
|
|
3209
|
+
blob: (value: Uint8Array) => T;
|
|
3210
|
+
s3Uri: (value: string) => T;
|
|
3211
|
+
_: (name: string, value: any) => T;
|
|
3212
|
+
}
|
|
3213
|
+
}
|
|
3214
|
+
/**
|
|
3215
|
+
* <p>The input configuration for creating branding settings.</p>
|
|
3216
|
+
* @public
|
|
3217
|
+
*/
|
|
3218
|
+
export interface BrandingConfigurationCreateInput {
|
|
3219
|
+
/**
|
|
3220
|
+
* <p>The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.</p>
|
|
3221
|
+
* @public
|
|
3222
|
+
*/
|
|
3223
|
+
logo: IconImageInput | undefined;
|
|
3224
|
+
/**
|
|
3225
|
+
* <p>The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.</p>
|
|
3226
|
+
* @public
|
|
3227
|
+
*/
|
|
3228
|
+
wallpaper: WallpaperImageInput | undefined;
|
|
3229
|
+
/**
|
|
3230
|
+
* <p>The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.</p>
|
|
3231
|
+
* @public
|
|
3232
|
+
*/
|
|
3233
|
+
favicon: IconImageInput | undefined;
|
|
3234
|
+
/**
|
|
3235
|
+
* <p>A map of localized text strings for different supported languages. Each locale must provide the required fields <code>browserTabTitle</code> and <code>welcomeText</code>.</p>
|
|
3236
|
+
* @public
|
|
3237
|
+
*/
|
|
3238
|
+
localizedStrings: Partial<Record<Locale, LocalizedBrandingStrings>> | undefined;
|
|
3239
|
+
/**
|
|
3240
|
+
* <p>The color theme for components on the web portal. Choose <code>Light</code> if you upload a dark wallpaper, or <code>Dark</code> for a light wallpaper.</p>
|
|
3241
|
+
* @public
|
|
3242
|
+
*/
|
|
3243
|
+
colorTheme: ColorTheme | undefined;
|
|
3244
|
+
/**
|
|
3245
|
+
* <p>The terms of service text in Markdown format. Users will be presented with the terms of service after successfully signing in.</p>
|
|
3246
|
+
* @public
|
|
3247
|
+
*/
|
|
3248
|
+
termsOfService?: string | undefined;
|
|
3249
|
+
}
|
|
3708
3250
|
/**
|
|
3709
3251
|
* <p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>
|
|
3710
3252
|
* @public
|
|
@@ -3736,26 +3278,22 @@ export interface ToolbarConfiguration {
|
|
|
3736
3278
|
*/
|
|
3737
3279
|
export interface CreateUserSettingsRequest {
|
|
3738
3280
|
/**
|
|
3739
|
-
* <p>Specifies whether the user can copy text from the streaming session to the local
|
|
3740
|
-
* device.</p>
|
|
3281
|
+
* <p>Specifies whether the user can copy text from the streaming session to the local device.</p>
|
|
3741
3282
|
* @public
|
|
3742
3283
|
*/
|
|
3743
3284
|
copyAllowed: EnabledType | undefined;
|
|
3744
3285
|
/**
|
|
3745
|
-
* <p>Specifies whether the user can paste text from the local device to the streaming
|
|
3746
|
-
* session.</p>
|
|
3286
|
+
* <p>Specifies whether the user can paste text from the local device to the streaming session.</p>
|
|
3747
3287
|
* @public
|
|
3748
3288
|
*/
|
|
3749
3289
|
pasteAllowed: EnabledType | undefined;
|
|
3750
3290
|
/**
|
|
3751
|
-
* <p>Specifies whether the user can download files from the streaming session to the local
|
|
3752
|
-
* device.</p>
|
|
3291
|
+
* <p>Specifies whether the user can download files from the streaming session to the local device.</p>
|
|
3753
3292
|
* @public
|
|
3754
3293
|
*/
|
|
3755
3294
|
downloadAllowed: EnabledType | undefined;
|
|
3756
3295
|
/**
|
|
3757
|
-
* <p>Specifies whether the user can upload files from the local device to the streaming
|
|
3758
|
-
* session.</p>
|
|
3296
|
+
* <p>Specifies whether the user can upload files from the local device to the streaming session.</p>
|
|
3759
3297
|
* @public
|
|
3760
3298
|
*/
|
|
3761
3299
|
uploadAllowed: EnabledType | undefined;
|
|
@@ -3770,36 +3308,27 @@ export interface CreateUserSettingsRequest {
|
|
|
3770
3308
|
*/
|
|
3771
3309
|
tags?: Tag[] | undefined;
|
|
3772
3310
|
/**
|
|
3773
|
-
* <p>The amount of time that a streaming session remains active after users
|
|
3774
|
-
* disconnect.</p>
|
|
3311
|
+
* <p>The amount of time that a streaming session remains active after users disconnect.</p>
|
|
3775
3312
|
* @public
|
|
3776
3313
|
*/
|
|
3777
3314
|
disconnectTimeoutInMinutes?: number | undefined;
|
|
3778
3315
|
/**
|
|
3779
|
-
* <p>The amount of time that users can be idle (inactive) before they are disconnected from
|
|
3780
|
-
* their streaming session and the disconnect timeout interval begins.</p>
|
|
3316
|
+
* <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.</p>
|
|
3781
3317
|
* @public
|
|
3782
3318
|
*/
|
|
3783
3319
|
idleDisconnectTimeoutInMinutes?: number | undefined;
|
|
3784
3320
|
/**
|
|
3785
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3786
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
3787
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
3788
|
-
* client token returns the result from the original successful request. </p>
|
|
3789
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
3790
|
-
* SDK.</p>
|
|
3321
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
3791
3322
|
* @public
|
|
3792
3323
|
*/
|
|
3793
3324
|
clientToken?: string | undefined;
|
|
3794
3325
|
/**
|
|
3795
|
-
* <p>The configuration that specifies which cookies should be synchronized from the end
|
|
3796
|
-
* user's local browser to the remote browser.</p>
|
|
3326
|
+
* <p>The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.</p>
|
|
3797
3327
|
* @public
|
|
3798
3328
|
*/
|
|
3799
3329
|
cookieSynchronizationConfiguration?: CookieSynchronizationConfiguration | undefined;
|
|
3800
3330
|
/**
|
|
3801
|
-
* <p>The customer managed key used to encrypt sensitive information in the user
|
|
3802
|
-
* settings.</p>
|
|
3331
|
+
* <p>The customer managed key used to encrypt sensitive information in the user settings.</p>
|
|
3803
3332
|
* @public
|
|
3804
3333
|
*/
|
|
3805
3334
|
customerManagedKey?: string | undefined;
|
|
@@ -3809,8 +3338,7 @@ export interface CreateUserSettingsRequest {
|
|
|
3809
3338
|
*/
|
|
3810
3339
|
additionalEncryptionContext?: Record<string, string> | undefined;
|
|
3811
3340
|
/**
|
|
3812
|
-
* <p>Specifies whether the user can use deep links that open automatically when connecting to
|
|
3813
|
-
* a session.</p>
|
|
3341
|
+
* <p>Specifies whether the user can use deep links that open automatically when connecting to a session.</p>
|
|
3814
3342
|
* @public
|
|
3815
3343
|
*/
|
|
3816
3344
|
deepLinkAllowed?: EnabledType | undefined;
|
|
@@ -3819,6 +3347,11 @@ export interface CreateUserSettingsRequest {
|
|
|
3819
3347
|
* @public
|
|
3820
3348
|
*/
|
|
3821
3349
|
toolbarConfiguration?: ToolbarConfiguration | undefined;
|
|
3350
|
+
/**
|
|
3351
|
+
* <p>The branding configuration input that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service.</p>
|
|
3352
|
+
* @public
|
|
3353
|
+
*/
|
|
3354
|
+
brandingConfigurationInput?: BrandingConfigurationCreateInput | undefined;
|
|
3822
3355
|
}
|
|
3823
3356
|
/**
|
|
3824
3357
|
* @public
|
|
@@ -3856,9 +3389,7 @@ export interface GetUserSettingsRequest {
|
|
|
3856
3389
|
userSettingsArn: string | undefined;
|
|
3857
3390
|
}
|
|
3858
3391
|
/**
|
|
3859
|
-
* <p>A user settings resource that can be associated with a web portal. Once associated with
|
|
3860
|
-
* a web portal, user settings control how users can transfer data between a streaming session
|
|
3861
|
-
* and the their local devices. </p>
|
|
3392
|
+
* <p>A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices. </p>
|
|
3862
3393
|
* @public
|
|
3863
3394
|
*/
|
|
3864
3395
|
export interface UserSettings {
|
|
@@ -3873,26 +3404,22 @@ export interface UserSettings {
|
|
|
3873
3404
|
*/
|
|
3874
3405
|
associatedPortalArns?: string[] | undefined;
|
|
3875
3406
|
/**
|
|
3876
|
-
* <p>Specifies whether the user can copy text from the streaming session to the local
|
|
3877
|
-
* device.</p>
|
|
3407
|
+
* <p>Specifies whether the user can copy text from the streaming session to the local device.</p>
|
|
3878
3408
|
* @public
|
|
3879
3409
|
*/
|
|
3880
3410
|
copyAllowed?: EnabledType | undefined;
|
|
3881
3411
|
/**
|
|
3882
|
-
* <p>Specifies whether the user can paste text from the local device to the streaming
|
|
3883
|
-
* session.</p>
|
|
3412
|
+
* <p>Specifies whether the user can paste text from the local device to the streaming session.</p>
|
|
3884
3413
|
* @public
|
|
3885
3414
|
*/
|
|
3886
3415
|
pasteAllowed?: EnabledType | undefined;
|
|
3887
3416
|
/**
|
|
3888
|
-
* <p>Specifies whether the user can download files from the streaming session to the local
|
|
3889
|
-
* device.</p>
|
|
3417
|
+
* <p>Specifies whether the user can download files from the streaming session to the local device.</p>
|
|
3890
3418
|
* @public
|
|
3891
3419
|
*/
|
|
3892
3420
|
downloadAllowed?: EnabledType | undefined;
|
|
3893
3421
|
/**
|
|
3894
|
-
* <p>Specifies whether the user can upload files from the local device to the streaming
|
|
3895
|
-
* session.</p>
|
|
3422
|
+
* <p>Specifies whether the user can upload files from the local device to the streaming session.</p>
|
|
3896
3423
|
* @public
|
|
3897
3424
|
*/
|
|
3898
3425
|
uploadAllowed?: EnabledType | undefined;
|
|
@@ -3902,26 +3429,22 @@ export interface UserSettings {
|
|
|
3902
3429
|
*/
|
|
3903
3430
|
printAllowed?: EnabledType | undefined;
|
|
3904
3431
|
/**
|
|
3905
|
-
* <p>The amount of time that a streaming session remains active after users
|
|
3906
|
-
* disconnect.</p>
|
|
3432
|
+
* <p>The amount of time that a streaming session remains active after users disconnect.</p>
|
|
3907
3433
|
* @public
|
|
3908
3434
|
*/
|
|
3909
3435
|
disconnectTimeoutInMinutes?: number | undefined;
|
|
3910
3436
|
/**
|
|
3911
|
-
* <p>The amount of time that users can be idle (inactive) before they are disconnected from
|
|
3912
|
-
* their streaming session and the disconnect timeout interval begins.</p>
|
|
3437
|
+
* <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.</p>
|
|
3913
3438
|
* @public
|
|
3914
3439
|
*/
|
|
3915
3440
|
idleDisconnectTimeoutInMinutes?: number | undefined;
|
|
3916
3441
|
/**
|
|
3917
|
-
* <p>The configuration that specifies which cookies should be synchronized from the end
|
|
3918
|
-
* user's local browser to the remote browser.</p>
|
|
3442
|
+
* <p>The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.</p>
|
|
3919
3443
|
* @public
|
|
3920
3444
|
*/
|
|
3921
3445
|
cookieSynchronizationConfiguration?: CookieSynchronizationConfiguration | undefined;
|
|
3922
3446
|
/**
|
|
3923
|
-
* <p>The customer managed key used to encrypt sensitive information in the user
|
|
3924
|
-
* settings.</p>
|
|
3447
|
+
* <p>The customer managed key used to encrypt sensitive information in the user settings.</p>
|
|
3925
3448
|
* @public
|
|
3926
3449
|
*/
|
|
3927
3450
|
customerManagedKey?: string | undefined;
|
|
@@ -3931,8 +3454,7 @@ export interface UserSettings {
|
|
|
3931
3454
|
*/
|
|
3932
3455
|
additionalEncryptionContext?: Record<string, string> | undefined;
|
|
3933
3456
|
/**
|
|
3934
|
-
* <p>Specifies whether the user can use deep links that open automatically when connecting to
|
|
3935
|
-
* a session.</p>
|
|
3457
|
+
* <p>Specifies whether the user can use deep links that open automatically when connecting to a session.</p>
|
|
3936
3458
|
* @public
|
|
3937
3459
|
*/
|
|
3938
3460
|
deepLinkAllowed?: EnabledType | undefined;
|
|
@@ -3941,6 +3463,11 @@ export interface UserSettings {
|
|
|
3941
3463
|
* @public
|
|
3942
3464
|
*/
|
|
3943
3465
|
toolbarConfiguration?: ToolbarConfiguration | undefined;
|
|
3466
|
+
/**
|
|
3467
|
+
* <p>The branding configuration output that customizes the appearance of the web portal for end users.</p>
|
|
3468
|
+
* @public
|
|
3469
|
+
*/
|
|
3470
|
+
brandingConfiguration?: BrandingConfiguration | undefined;
|
|
3944
3471
|
}
|
|
3945
3472
|
/**
|
|
3946
3473
|
* @public
|
|
@@ -3957,8 +3484,7 @@ export interface GetUserSettingsResponse {
|
|
|
3957
3484
|
*/
|
|
3958
3485
|
export interface ListUserSettingsRequest {
|
|
3959
3486
|
/**
|
|
3960
|
-
* <p>The pagination token used to retrieve the next page of results for this operation.
|
|
3961
|
-
* </p>
|
|
3487
|
+
* <p>The pagination token used to retrieve the next page of results for this operation. </p>
|
|
3962
3488
|
* @public
|
|
3963
3489
|
*/
|
|
3964
3490
|
nextToken?: string | undefined;
|
|
@@ -3979,26 +3505,22 @@ export interface UserSettingsSummary {
|
|
|
3979
3505
|
*/
|
|
3980
3506
|
userSettingsArn: string | undefined;
|
|
3981
3507
|
/**
|
|
3982
|
-
* <p>Specifies whether the user can copy text from the streaming session to the local
|
|
3983
|
-
* device.</p>
|
|
3508
|
+
* <p>Specifies whether the user can copy text from the streaming session to the local device.</p>
|
|
3984
3509
|
* @public
|
|
3985
3510
|
*/
|
|
3986
3511
|
copyAllowed?: EnabledType | undefined;
|
|
3987
3512
|
/**
|
|
3988
|
-
* <p>Specifies whether the user can paste text from the local device to the streaming
|
|
3989
|
-
* session.</p>
|
|
3513
|
+
* <p>Specifies whether the user can paste text from the local device to the streaming session.</p>
|
|
3990
3514
|
* @public
|
|
3991
3515
|
*/
|
|
3992
3516
|
pasteAllowed?: EnabledType | undefined;
|
|
3993
3517
|
/**
|
|
3994
|
-
* <p>Specifies whether the user can download files from the streaming session to the local
|
|
3995
|
-
* device.</p>
|
|
3518
|
+
* <p>Specifies whether the user can download files from the streaming session to the local device.</p>
|
|
3996
3519
|
* @public
|
|
3997
3520
|
*/
|
|
3998
3521
|
downloadAllowed?: EnabledType | undefined;
|
|
3999
3522
|
/**
|
|
4000
|
-
* <p>Specifies whether the user can upload files from the local device to the streaming
|
|
4001
|
-
* session.</p>
|
|
3523
|
+
* <p>Specifies whether the user can upload files from the local device to the streaming session.</p>
|
|
4002
3524
|
* @public
|
|
4003
3525
|
*/
|
|
4004
3526
|
uploadAllowed?: EnabledType | undefined;
|
|
@@ -4008,26 +3530,22 @@ export interface UserSettingsSummary {
|
|
|
4008
3530
|
*/
|
|
4009
3531
|
printAllowed?: EnabledType | undefined;
|
|
4010
3532
|
/**
|
|
4011
|
-
* <p>The amount of time that a streaming session remains active after users
|
|
4012
|
-
* disconnect.</p>
|
|
3533
|
+
* <p>The amount of time that a streaming session remains active after users disconnect.</p>
|
|
4013
3534
|
* @public
|
|
4014
3535
|
*/
|
|
4015
3536
|
disconnectTimeoutInMinutes?: number | undefined;
|
|
4016
3537
|
/**
|
|
4017
|
-
* <p>The amount of time that users can be idle (inactive) before they are disconnected from
|
|
4018
|
-
* their streaming session and the disconnect timeout interval begins.</p>
|
|
3538
|
+
* <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.</p>
|
|
4019
3539
|
* @public
|
|
4020
3540
|
*/
|
|
4021
3541
|
idleDisconnectTimeoutInMinutes?: number | undefined;
|
|
4022
3542
|
/**
|
|
4023
|
-
* <p>The configuration that specifies which cookies should be synchronized from the end
|
|
4024
|
-
* user's local browser to the remote browser.</p>
|
|
3543
|
+
* <p>The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.</p>
|
|
4025
3544
|
* @public
|
|
4026
3545
|
*/
|
|
4027
3546
|
cookieSynchronizationConfiguration?: CookieSynchronizationConfiguration | undefined;
|
|
4028
3547
|
/**
|
|
4029
|
-
* <p>Specifies whether the user can use deep links that open automatically when connecting to
|
|
4030
|
-
* a session.</p>
|
|
3548
|
+
* <p>Specifies whether the user can use deep links that open automatically when connecting to a session.</p>
|
|
4031
3549
|
* @public
|
|
4032
3550
|
*/
|
|
4033
3551
|
deepLinkAllowed?: EnabledType | undefined;
|
|
@@ -4036,6 +3554,11 @@ export interface UserSettingsSummary {
|
|
|
4036
3554
|
* @public
|
|
4037
3555
|
*/
|
|
4038
3556
|
toolbarConfiguration?: ToolbarConfiguration | undefined;
|
|
3557
|
+
/**
|
|
3558
|
+
* <p>The branding configuration output that customizes the appearance of the web portal for end users.</p>
|
|
3559
|
+
* @public
|
|
3560
|
+
*/
|
|
3561
|
+
brandingConfiguration?: BrandingConfiguration | undefined;
|
|
4039
3562
|
}
|
|
4040
3563
|
/**
|
|
4041
3564
|
* @public
|
|
@@ -4047,12 +3570,47 @@ export interface ListUserSettingsResponse {
|
|
|
4047
3570
|
*/
|
|
4048
3571
|
userSettings?: UserSettingsSummary[] | undefined;
|
|
4049
3572
|
/**
|
|
4050
|
-
* <p>The pagination token used to retrieve the next page of results for this operation.
|
|
4051
|
-
* </p>
|
|
3573
|
+
* <p>The pagination token used to retrieve the next page of results for this operation. </p>
|
|
4052
3574
|
* @public
|
|
4053
3575
|
*/
|
|
4054
3576
|
nextToken?: string | undefined;
|
|
4055
3577
|
}
|
|
3578
|
+
/**
|
|
3579
|
+
* <p>The input configuration for updating branding settings. All fields are optional when updating existing branding.</p>
|
|
3580
|
+
* @public
|
|
3581
|
+
*/
|
|
3582
|
+
export interface BrandingConfigurationUpdateInput {
|
|
3583
|
+
/**
|
|
3584
|
+
* <p>The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.</p>
|
|
3585
|
+
* @public
|
|
3586
|
+
*/
|
|
3587
|
+
logo?: IconImageInput | undefined;
|
|
3588
|
+
/**
|
|
3589
|
+
* <p>The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.</p>
|
|
3590
|
+
* @public
|
|
3591
|
+
*/
|
|
3592
|
+
wallpaper?: WallpaperImageInput | undefined;
|
|
3593
|
+
/**
|
|
3594
|
+
* <p>The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.</p>
|
|
3595
|
+
* @public
|
|
3596
|
+
*/
|
|
3597
|
+
favicon?: IconImageInput | undefined;
|
|
3598
|
+
/**
|
|
3599
|
+
* <p>A map of localized text strings for different supported languages. Each locale must provide the required fields <code>browserTabTitle</code> and <code>welcomeText</code>.</p>
|
|
3600
|
+
* @public
|
|
3601
|
+
*/
|
|
3602
|
+
localizedStrings?: Partial<Record<Locale, LocalizedBrandingStrings>> | undefined;
|
|
3603
|
+
/**
|
|
3604
|
+
* <p>The color theme for components on the web portal. Choose <code>Light</code> if you upload a dark wallpaper, or <code>Dark</code> for a light wallpaper.</p>
|
|
3605
|
+
* @public
|
|
3606
|
+
*/
|
|
3607
|
+
colorTheme?: ColorTheme | undefined;
|
|
3608
|
+
/**
|
|
3609
|
+
* <p>The terms of service text in Markdown format. To remove existing terms of service, provide an empty string.</p>
|
|
3610
|
+
* @public
|
|
3611
|
+
*/
|
|
3612
|
+
termsOfService?: string | undefined;
|
|
3613
|
+
}
|
|
4056
3614
|
/**
|
|
4057
3615
|
* @public
|
|
4058
3616
|
*/
|
|
@@ -4063,26 +3621,22 @@ export interface UpdateUserSettingsRequest {
|
|
|
4063
3621
|
*/
|
|
4064
3622
|
userSettingsArn: string | undefined;
|
|
4065
3623
|
/**
|
|
4066
|
-
* <p>Specifies whether the user can copy text from the streaming session to the local
|
|
4067
|
-
* device.</p>
|
|
3624
|
+
* <p>Specifies whether the user can copy text from the streaming session to the local device.</p>
|
|
4068
3625
|
* @public
|
|
4069
3626
|
*/
|
|
4070
3627
|
copyAllowed?: EnabledType | undefined;
|
|
4071
3628
|
/**
|
|
4072
|
-
* <p>Specifies whether the user can paste text from the local device to the streaming
|
|
4073
|
-
* session.</p>
|
|
3629
|
+
* <p>Specifies whether the user can paste text from the local device to the streaming session.</p>
|
|
4074
3630
|
* @public
|
|
4075
3631
|
*/
|
|
4076
3632
|
pasteAllowed?: EnabledType | undefined;
|
|
4077
3633
|
/**
|
|
4078
|
-
* <p>Specifies whether the user can download files from the streaming session to the local
|
|
4079
|
-
* device.</p>
|
|
3634
|
+
* <p>Specifies whether the user can download files from the streaming session to the local device.</p>
|
|
4080
3635
|
* @public
|
|
4081
3636
|
*/
|
|
4082
3637
|
downloadAllowed?: EnabledType | undefined;
|
|
4083
3638
|
/**
|
|
4084
|
-
* <p>Specifies whether the user can upload files from the local device to the streaming
|
|
4085
|
-
* session.</p>
|
|
3639
|
+
* <p>Specifies whether the user can upload files from the local device to the streaming session.</p>
|
|
4086
3640
|
* @public
|
|
4087
3641
|
*/
|
|
4088
3642
|
uploadAllowed?: EnabledType | undefined;
|
|
@@ -4092,37 +3646,27 @@ export interface UpdateUserSettingsRequest {
|
|
|
4092
3646
|
*/
|
|
4093
3647
|
printAllowed?: EnabledType | undefined;
|
|
4094
3648
|
/**
|
|
4095
|
-
* <p>The amount of time that a streaming session remains active after users
|
|
4096
|
-
* disconnect.</p>
|
|
3649
|
+
* <p>The amount of time that a streaming session remains active after users disconnect.</p>
|
|
4097
3650
|
* @public
|
|
4098
3651
|
*/
|
|
4099
3652
|
disconnectTimeoutInMinutes?: number | undefined;
|
|
4100
3653
|
/**
|
|
4101
|
-
* <p>The amount of time that users can be idle (inactive) before they are disconnected from
|
|
4102
|
-
* their streaming session and the disconnect timeout interval begins.</p>
|
|
3654
|
+
* <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.</p>
|
|
4103
3655
|
* @public
|
|
4104
3656
|
*/
|
|
4105
3657
|
idleDisconnectTimeoutInMinutes?: number | undefined;
|
|
4106
3658
|
/**
|
|
4107
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
4108
|
-
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
4109
|
-
* request, if the original request completes successfully, subsequent retries with the same
|
|
4110
|
-
* client token return the result from the original successful request. </p>
|
|
4111
|
-
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services
|
|
4112
|
-
* SDK.</p>
|
|
3659
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
4113
3660
|
* @public
|
|
4114
3661
|
*/
|
|
4115
3662
|
clientToken?: string | undefined;
|
|
4116
3663
|
/**
|
|
4117
|
-
* <p>The configuration that specifies which cookies should be synchronized from the end
|
|
4118
|
-
* user's local browser to the remote browser.</p>
|
|
4119
|
-
* <p>If the allowlist and blocklist are empty, the configuration becomes null.</p>
|
|
3664
|
+
* <p>The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.</p> <p>If the allowlist and blocklist are empty, the configuration becomes null.</p>
|
|
4120
3665
|
* @public
|
|
4121
3666
|
*/
|
|
4122
3667
|
cookieSynchronizationConfiguration?: CookieSynchronizationConfiguration | undefined;
|
|
4123
3668
|
/**
|
|
4124
|
-
* <p>Specifies whether the user can use deep links that open automatically when connecting to
|
|
4125
|
-
* a session.</p>
|
|
3669
|
+
* <p>Specifies whether the user can use deep links that open automatically when connecting to a session.</p>
|
|
4126
3670
|
* @public
|
|
4127
3671
|
*/
|
|
4128
3672
|
deepLinkAllowed?: EnabledType | undefined;
|
|
@@ -4131,6 +3675,11 @@ export interface UpdateUserSettingsRequest {
|
|
|
4131
3675
|
* @public
|
|
4132
3676
|
*/
|
|
4133
3677
|
toolbarConfiguration?: ToolbarConfiguration | undefined;
|
|
3678
|
+
/**
|
|
3679
|
+
* <p>The branding configuration that customizes the appearance of the web portal for end users. When updating user settings without an existing branding configuration, all fields (logo, favicon, wallpaper, localized strings, and color theme) are required except for terms of service. When updating user settings with an existing branding configuration, all fields are optional.</p>
|
|
3680
|
+
* @public
|
|
3681
|
+
*/
|
|
3682
|
+
brandingConfigurationInput?: BrandingConfigurationUpdateInput | undefined;
|
|
4134
3683
|
}
|
|
4135
3684
|
/**
|
|
4136
3685
|
* @public
|