@aws-sdk/client-qbusiness 3.637.0 → 3.645.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/dist-cjs/index.js CHANGED
@@ -31,6 +31,7 @@ __export(src_exports, {
31
31
  AttachmentsControlMode: () => AttachmentsControlMode,
32
32
  AttributeType: () => AttributeType,
33
33
  AttributeValueOperator: () => AttributeValueOperator,
34
+ AutoSubscriptionStatus: () => AutoSubscriptionStatus,
34
35
  BatchDeleteDocumentCommand: () => BatchDeleteDocumentCommand,
35
36
  BatchPutDocumentCommand: () => BatchPutDocumentCommand,
36
37
  ChatCommand: () => ChatCommand,
@@ -89,6 +90,8 @@ __export(src_exports, {
89
90
  GetUserCommand: () => GetUserCommand,
90
91
  GetWebExperienceCommand: () => GetWebExperienceCommand,
91
92
  GroupStatus: () => GroupStatus,
93
+ IdentityProviderConfiguration: () => IdentityProviderConfiguration,
94
+ IdentityType: () => IdentityType,
92
95
  IndexStatus: () => IndexStatus,
93
96
  IndexType: () => IndexType,
94
97
  InternalServerException: () => InternalServerException,
@@ -136,6 +139,7 @@ __export(src_exports, {
136
139
  Status: () => Status,
137
140
  StopDataSourceSyncJobCommand: () => StopDataSourceSyncJobCommand,
138
141
  StringAttributeValueBoostingLevel: () => StringAttributeValueBoostingLevel,
142
+ SubscriptionType: () => SubscriptionType,
139
143
  TagResourceCommand: () => TagResourceCommand,
140
144
  ThrottlingException: () => ThrottlingException,
141
145
  UntagResourceCommand: () => UntagResourceCommand,
@@ -405,6 +409,11 @@ var APISchema;
405
409
  var APISchemaType = {
406
410
  OPEN_API_V3: "OPEN_API_V3"
407
411
  };
412
+ var IdentityType = {
413
+ AWS_IAM_IDC: "AWS_IAM_IDC",
414
+ AWS_IAM_IDP_OIDC: "AWS_IAM_IDP_OIDC",
415
+ AWS_IAM_IDP_SAML: "AWS_IAM_IDP_SAML"
416
+ };
408
417
  var ApplicationStatus = {
409
418
  ACTIVE: "ACTIVE",
410
419
  CREATING: "CREATING",
@@ -539,6 +548,14 @@ var _ValidationException = class _ValidationException extends QBusinessServiceEx
539
548
  };
540
549
  __name(_ValidationException, "ValidationException");
541
550
  var ValidationException = _ValidationException;
551
+ var AutoSubscriptionStatus = {
552
+ DISABLED: "DISABLED",
553
+ ENABLED: "ENABLED"
554
+ };
555
+ var SubscriptionType = {
556
+ Q_BUSINESS: "Q_BUSINESS",
557
+ Q_LITE: "Q_LITE"
558
+ };
542
559
  var ErrorCode = {
543
560
  INTERNAL_ERROR: "InternalError",
544
561
  INVALID_REQUEST: "InvalidRequest",
@@ -682,6 +699,16 @@ var RetrieverStatus = {
682
699
  CREATING: "CREATING",
683
700
  FAILED: "FAILED"
684
701
  };
702
+ var IdentityProviderConfiguration;
703
+ ((IdentityProviderConfiguration3) => {
704
+ IdentityProviderConfiguration3.visit = /* @__PURE__ */ __name((value, visitor) => {
705
+ if (value.samlConfiguration !== void 0)
706
+ return visitor.samlConfiguration(value.samlConfiguration);
707
+ if (value.openIDConnectConfiguration !== void 0)
708
+ return visitor.openIDConnectConfiguration(value.openIDConnectConfiguration);
709
+ return visitor._(value.$unknown[0], value.$unknown[1]);
710
+ }, "visit");
711
+ })(IdentityProviderConfiguration || (IdentityProviderConfiguration = {}));
685
712
  var WebExperienceSamplePromptsControlMode = {
686
713
  DISABLED: "DISABLED",
687
714
  ENABLED: "ENABLED"
@@ -1050,11 +1077,14 @@ var se_CreateApplicationCommand = /* @__PURE__ */ __name(async (input, context)
1050
1077
  body = JSON.stringify(
1051
1078
  (0, import_smithy_client.take)(input, {
1052
1079
  attachmentsConfiguration: (_) => (0, import_smithy_client._json)(_),
1080
+ clientIdsForOIDC: (_) => (0, import_smithy_client._json)(_),
1053
1081
  clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
1054
1082
  description: [],
1055
1083
  displayName: [],
1056
1084
  encryptionConfiguration: (_) => (0, import_smithy_client._json)(_),
1085
+ iamIdentityProviderArn: [],
1057
1086
  identityCenterInstanceArn: [],
1087
+ identityType: [],
1058
1088
  personalizationConfiguration: (_) => (0, import_smithy_client._json)(_),
1059
1089
  qAppsConfiguration: (_) => (0, import_smithy_client._json)(_),
1060
1090
  roleArn: [],
@@ -1182,6 +1212,7 @@ var se_CreateWebExperienceCommand = /* @__PURE__ */ __name(async (input, context
1182
1212
  body = JSON.stringify(
1183
1213
  (0, import_smithy_client.take)(input, {
1184
1214
  clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
1215
+ identityProviderConfiguration: (_) => (0, import_smithy_client._json)(_),
1185
1216
  roleArn: [],
1186
1217
  samplePromptsControlMode: [],
1187
1218
  subtitle: [],
@@ -1670,6 +1701,7 @@ var se_UpdateApplicationCommand = /* @__PURE__ */ __name(async (input, context)
1670
1701
  body = JSON.stringify(
1671
1702
  (0, import_smithy_client.take)(input, {
1672
1703
  attachmentsConfiguration: (_) => (0, import_smithy_client._json)(_),
1704
+ autoSubscriptionConfiguration: (_) => (0, import_smithy_client._json)(_),
1673
1705
  description: [],
1674
1706
  displayName: [],
1675
1707
  identityCenterInstanceArn: [],
@@ -1816,6 +1848,7 @@ var se_UpdateWebExperienceCommand = /* @__PURE__ */ __name(async (input, context
1816
1848
  body = JSON.stringify(
1817
1849
  (0, import_smithy_client.take)(input, {
1818
1850
  authenticationConfiguration: (_) => (0, import_smithy_client._json)(_),
1851
+ identityProviderConfiguration: (_) => (0, import_smithy_client._json)(_),
1819
1852
  roleArn: [],
1820
1853
  samplePromptsControlMode: [],
1821
1854
  subtitle: [],
@@ -2099,12 +2132,16 @@ var de_GetApplicationCommand = /* @__PURE__ */ __name(async (output, context) =>
2099
2132
  applicationArn: import_smithy_client.expectString,
2100
2133
  applicationId: import_smithy_client.expectString,
2101
2134
  attachmentsConfiguration: import_smithy_client._json,
2135
+ autoSubscriptionConfiguration: import_smithy_client._json,
2136
+ clientIdsForOIDC: import_smithy_client._json,
2102
2137
  createdAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
2103
2138
  description: import_smithy_client.expectString,
2104
2139
  displayName: import_smithy_client.expectString,
2105
2140
  encryptionConfiguration: import_smithy_client._json,
2106
2141
  error: import_smithy_client._json,
2142
+ iamIdentityProviderArn: import_smithy_client.expectString,
2107
2143
  identityCenterApplicationArn: import_smithy_client.expectString,
2144
+ identityType: import_smithy_client.expectString,
2108
2145
  personalizationConfiguration: import_smithy_client._json,
2109
2146
  qAppsConfiguration: import_smithy_client._json,
2110
2147
  roleArn: import_smithy_client.expectString,
@@ -2278,6 +2315,7 @@ var de_GetWebExperienceCommand = /* @__PURE__ */ __name(async (output, context)
2278
2315
  createdAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
2279
2316
  defaultEndpoint: import_smithy_client.expectString,
2280
2317
  error: import_smithy_client._json,
2318
+ identityProviderConfiguration: (_) => (0, import_smithy_client._json)((0, import_core2.awsExpectUnion)(_)),
2281
2319
  roleArn: import_smithy_client.expectString,
2282
2320
  samplePromptsControlMode: import_smithy_client.expectString,
2283
2321
  status: import_smithy_client.expectString,
@@ -3166,6 +3204,7 @@ var de_Application = /* @__PURE__ */ __name((output, context) => {
3166
3204
  applicationId: import_smithy_client.expectString,
3167
3205
  createdAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
3168
3206
  displayName: import_smithy_client.expectString,
3207
+ identityType: import_smithy_client.expectString,
3169
3208
  status: import_smithy_client.expectString,
3170
3209
  updatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_)))
3171
3210
  });
@@ -4531,6 +4570,7 @@ var paginateListWebExperiences = (0, import_core.createPaginator)(QBusinessClien
4531
4570
  PluginType,
4532
4571
  APISchema,
4533
4572
  APISchemaType,
4573
+ IdentityType,
4534
4574
  ApplicationStatus,
4535
4575
  ConflictException,
4536
4576
  AttachmentsControlMode,
@@ -4542,6 +4582,8 @@ var paginateListWebExperiences = (0, import_core.createPaginator)(QBusinessClien
4542
4582
  ThrottlingException,
4543
4583
  ValidationExceptionReason,
4544
4584
  ValidationException,
4585
+ AutoSubscriptionStatus,
4586
+ SubscriptionType,
4545
4587
  ErrorCode,
4546
4588
  IndexType,
4547
4589
  DocumentEnrichmentConditionOperator,
@@ -4562,6 +4604,7 @@ var paginateListWebExperiences = (0, import_core.createPaginator)(QBusinessClien
4562
4604
  RetrieverConfiguration,
4563
4605
  RetrieverType,
4564
4606
  RetrieverStatus,
4607
+ IdentityProviderConfiguration,
4565
4608
  WebExperienceSamplePromptsControlMode,
4566
4609
  WebExperienceAuthConfiguration,
4567
4610
  WebExperienceStatus,
@@ -60,6 +60,11 @@ export var APISchema;
60
60
  export const APISchemaType = {
61
61
  OPEN_API_V3: "OPEN_API_V3",
62
62
  };
63
+ export const IdentityType = {
64
+ AWS_IAM_IDC: "AWS_IAM_IDC",
65
+ AWS_IAM_IDP_OIDC: "AWS_IAM_IDP_OIDC",
66
+ AWS_IAM_IDP_SAML: "AWS_IAM_IDP_SAML",
67
+ };
63
68
  export const ApplicationStatus = {
64
69
  ACTIVE: "ACTIVE",
65
70
  CREATING: "CREATING",
@@ -164,6 +169,14 @@ export class ValidationException extends __BaseException {
164
169
  this.fields = opts.fields;
165
170
  }
166
171
  }
172
+ export const AutoSubscriptionStatus = {
173
+ DISABLED: "DISABLED",
174
+ ENABLED: "ENABLED",
175
+ };
176
+ export const SubscriptionType = {
177
+ Q_BUSINESS: "Q_BUSINESS",
178
+ Q_LITE: "Q_LITE",
179
+ };
167
180
  export const ErrorCode = {
168
181
  INTERNAL_ERROR: "InternalError",
169
182
  INVALID_REQUEST: "InvalidRequest",
@@ -307,6 +320,16 @@ export const RetrieverStatus = {
307
320
  CREATING: "CREATING",
308
321
  FAILED: "FAILED",
309
322
  };
323
+ export var IdentityProviderConfiguration;
324
+ (function (IdentityProviderConfiguration) {
325
+ IdentityProviderConfiguration.visit = (value, visitor) => {
326
+ if (value.samlConfiguration !== undefined)
327
+ return visitor.samlConfiguration(value.samlConfiguration);
328
+ if (value.openIDConnectConfiguration !== undefined)
329
+ return visitor.openIDConnectConfiguration(value.openIDConnectConfiguration);
330
+ return visitor._(value.$unknown[0], value.$unknown[1]);
331
+ };
332
+ })(IdentityProviderConfiguration || (IdentityProviderConfiguration = {}));
310
333
  export const WebExperienceSamplePromptsControlMode = {
311
334
  DISABLED: "DISABLED",
312
335
  ENABLED: "ENABLED",
@@ -95,11 +95,14 @@ export const se_CreateApplicationCommand = async (input, context) => {
95
95
  let body;
96
96
  body = JSON.stringify(take(input, {
97
97
  attachmentsConfiguration: (_) => _json(_),
98
+ clientIdsForOIDC: (_) => _json(_),
98
99
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
99
100
  description: [],
100
101
  displayName: [],
101
102
  encryptionConfiguration: (_) => _json(_),
103
+ iamIdentityProviderArn: [],
102
104
  identityCenterInstanceArn: [],
105
+ identityType: [],
103
106
  personalizationConfiguration: (_) => _json(_),
104
107
  qAppsConfiguration: (_) => _json(_),
105
108
  roleArn: [],
@@ -215,6 +218,7 @@ export const se_CreateWebExperienceCommand = async (input, context) => {
215
218
  let body;
216
219
  body = JSON.stringify(take(input, {
217
220
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
221
+ identityProviderConfiguration: (_) => _json(_),
218
222
  roleArn: [],
219
223
  samplePromptsControlMode: [],
220
224
  subtitle: [],
@@ -695,6 +699,7 @@ export const se_UpdateApplicationCommand = async (input, context) => {
695
699
  let body;
696
700
  body = JSON.stringify(take(input, {
697
701
  attachmentsConfiguration: (_) => _json(_),
702
+ autoSubscriptionConfiguration: (_) => _json(_),
698
703
  description: [],
699
704
  displayName: [],
700
705
  identityCenterInstanceArn: [],
@@ -827,6 +832,7 @@ export const se_UpdateWebExperienceCommand = async (input, context) => {
827
832
  let body;
828
833
  body = JSON.stringify(take(input, {
829
834
  authenticationConfiguration: (_) => _json(_),
835
+ identityProviderConfiguration: (_) => _json(_),
830
836
  roleArn: [],
831
837
  samplePromptsControlMode: [],
832
838
  subtitle: [],
@@ -1109,12 +1115,16 @@ export const de_GetApplicationCommand = async (output, context) => {
1109
1115
  applicationArn: __expectString,
1110
1116
  applicationId: __expectString,
1111
1117
  attachmentsConfiguration: _json,
1118
+ autoSubscriptionConfiguration: _json,
1119
+ clientIdsForOIDC: _json,
1112
1120
  createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1113
1121
  description: __expectString,
1114
1122
  displayName: __expectString,
1115
1123
  encryptionConfiguration: _json,
1116
1124
  error: _json,
1125
+ iamIdentityProviderArn: __expectString,
1117
1126
  identityCenterApplicationArn: __expectString,
1127
+ identityType: __expectString,
1118
1128
  personalizationConfiguration: _json,
1119
1129
  qAppsConfiguration: _json,
1120
1130
  roleArn: __expectString,
@@ -1288,6 +1298,7 @@ export const de_GetWebExperienceCommand = async (output, context) => {
1288
1298
  createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1289
1299
  defaultEndpoint: __expectString,
1290
1300
  error: _json,
1301
+ identityProviderConfiguration: (_) => _json(__expectUnion(_)),
1291
1302
  roleArn: __expectString,
1292
1303
  samplePromptsControlMode: __expectString,
1293
1304
  status: __expectString,
@@ -2182,6 +2193,7 @@ const de_Application = (output, context) => {
2182
2193
  applicationId: __expectString,
2183
2194
  createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
2184
2195
  displayName: __expectString,
2196
+ identityType: __expectString,
2185
2197
  status: __expectString,
2186
2198
  updatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
2187
2199
  });
@@ -43,7 +43,12 @@ declare const CreateApplicationCommand_base: {
43
43
  * const input = { // CreateApplicationRequest
44
44
  * displayName: "STRING_VALUE", // required
45
45
  * roleArn: "STRING_VALUE",
46
+ * identityType: "AWS_IAM_IDP_SAML" || "AWS_IAM_IDP_OIDC" || "AWS_IAM_IDC",
47
+ * iamIdentityProviderArn: "STRING_VALUE",
46
48
  * identityCenterInstanceArn: "STRING_VALUE",
49
+ * clientIdsForOIDC: [ // ClientIdsForOIDC
50
+ * "STRING_VALUE",
51
+ * ],
47
52
  * description: "STRING_VALUE",
48
53
  * encryptionConfiguration: { // EncryptionConfiguration
49
54
  * kmsKeyId: "STRING_VALUE",
@@ -48,6 +48,15 @@ declare const CreateWebExperienceCommand_base: {
48
48
  * },
49
49
  * ],
50
50
  * clientToken: "STRING_VALUE",
51
+ * identityProviderConfiguration: { // IdentityProviderConfiguration Union: only one key present
52
+ * samlConfiguration: { // SamlProviderConfiguration
53
+ * authenticationUrl: "STRING_VALUE", // required
54
+ * },
55
+ * openIDConnectConfiguration: { // OpenIDConnectProviderConfiguration
56
+ * secretsArn: "STRING_VALUE", // required
57
+ * secretsRole: "STRING_VALUE", // required
58
+ * },
59
+ * },
51
60
  * };
52
61
  * const command = new CreateWebExperienceCommand(input);
53
62
  * const response = await client.send(command);
@@ -43,6 +43,8 @@ declare const GetApplicationCommand_base: {
43
43
  * // displayName: "STRING_VALUE",
44
44
  * // applicationId: "STRING_VALUE",
45
45
  * // applicationArn: "STRING_VALUE",
46
+ * // identityType: "AWS_IAM_IDP_SAML" || "AWS_IAM_IDP_OIDC" || "AWS_IAM_IDC",
47
+ * // iamIdentityProviderArn: "STRING_VALUE",
46
48
  * // identityCenterApplicationArn: "STRING_VALUE",
47
49
  * // roleArn: "STRING_VALUE",
48
50
  * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
@@ -65,6 +67,13 @@ declare const GetApplicationCommand_base: {
65
67
  * // personalizationConfiguration: { // PersonalizationConfiguration
66
68
  * // personalizationControlMode: "ENABLED" || "DISABLED", // required
67
69
  * // },
70
+ * // autoSubscriptionConfiguration: { // AutoSubscriptionConfiguration
71
+ * // autoSubscribe: "ENABLED" || "DISABLED", // required
72
+ * // defaultSubscriptionType: "Q_LITE" || "Q_BUSINESS",
73
+ * // },
74
+ * // clientIdsForOIDC: [ // ClientIdsForOIDC
75
+ * // "STRING_VALUE",
76
+ * // ],
68
77
  * // };
69
78
  *
70
79
  * ```
@@ -53,6 +53,15 @@ declare const GetWebExperienceCommand_base: {
53
53
  * // welcomeMessage: "STRING_VALUE",
54
54
  * // samplePromptsControlMode: "ENABLED" || "DISABLED",
55
55
  * // roleArn: "STRING_VALUE",
56
+ * // identityProviderConfiguration: { // IdentityProviderConfiguration Union: only one key present
57
+ * // samlConfiguration: { // SamlProviderConfiguration
58
+ * // authenticationUrl: "STRING_VALUE", // required
59
+ * // },
60
+ * // openIDConnectConfiguration: { // OpenIDConnectProviderConfiguration
61
+ * // secretsArn: "STRING_VALUE", // required
62
+ * // secretsRole: "STRING_VALUE", // required
63
+ * // },
64
+ * // },
56
65
  * // authenticationConfiguration: { // WebExperienceAuthConfiguration Union: only one key present
57
66
  * // samlConfiguration: { // SamlConfiguration
58
67
  * // metadataXML: "STRING_VALUE", // required
@@ -49,6 +49,7 @@ declare const ListApplicationsCommand_base: {
49
49
  * // createdAt: new Date("TIMESTAMP"),
50
50
  * // updatedAt: new Date("TIMESTAMP"),
51
51
  * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
52
+ * // identityType: "AWS_IAM_IDP_SAML" || "AWS_IAM_IDP_OIDC" || "AWS_IAM_IDC",
52
53
  * // },
53
54
  * // ],
54
55
  * // };
@@ -49,6 +49,10 @@ declare const UpdateApplicationCommand_base: {
49
49
  * personalizationConfiguration: { // PersonalizationConfiguration
50
50
  * personalizationControlMode: "ENABLED" || "DISABLED", // required
51
51
  * },
52
+ * autoSubscriptionConfiguration: { // AutoSubscriptionConfiguration
53
+ * autoSubscribe: "ENABLED" || "DISABLED", // required
54
+ * defaultSubscriptionType: "Q_LITE" || "Q_BUSINESS",
55
+ * },
52
56
  * };
53
57
  * const command = new UpdateApplicationCommand(input);
54
58
  * const response = await client.send(command);
@@ -50,6 +50,15 @@ declare const UpdateWebExperienceCommand_base: {
50
50
  * subtitle: "STRING_VALUE",
51
51
  * welcomeMessage: "STRING_VALUE",
52
52
  * samplePromptsControlMode: "ENABLED" || "DISABLED",
53
+ * identityProviderConfiguration: { // IdentityProviderConfiguration Union: only one key present
54
+ * samlConfiguration: { // SamlProviderConfiguration
55
+ * authenticationUrl: "STRING_VALUE", // required
56
+ * },
57
+ * openIDConnectConfiguration: { // OpenIDConnectProviderConfiguration
58
+ * secretsArn: "STRING_VALUE", // required
59
+ * secretsRole: "STRING_VALUE", // required
60
+ * },
61
+ * },
53
62
  * };
54
63
  * const command = new UpdateWebExperienceCommand(input);
55
64
  * const response = await client.send(command);
@@ -481,6 +481,19 @@ export declare const APISchemaType: {
481
481
  * @public
482
482
  */
483
483
  export type APISchemaType = (typeof APISchemaType)[keyof typeof APISchemaType];
484
+ /**
485
+ * @public
486
+ * @enum
487
+ */
488
+ export declare const IdentityType: {
489
+ readonly AWS_IAM_IDC: "AWS_IAM_IDC";
490
+ readonly AWS_IAM_IDP_OIDC: "AWS_IAM_IDP_OIDC";
491
+ readonly AWS_IAM_IDP_SAML: "AWS_IAM_IDP_SAML";
492
+ };
493
+ /**
494
+ * @public
495
+ */
496
+ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
484
497
  /**
485
498
  * @public
486
499
  * @enum
@@ -527,6 +540,11 @@ export interface Application {
527
540
  * @public
528
541
  */
529
542
  status?: ApplicationStatus;
543
+ /**
544
+ * <p>The authentication type being used by a Amazon Q Business application.</p>
545
+ * @public
546
+ */
547
+ identityType?: IdentityType;
530
548
  }
531
549
  /**
532
550
  * <p>You are trying to perform an action that conflicts with the current status of your
@@ -672,12 +690,27 @@ export interface CreateApplicationRequest {
672
690
  * @public
673
691
  */
674
692
  roleArn?: string;
693
+ /**
694
+ * <p>The authentication type being used by a Amazon Q Business application.</p>
695
+ * @public
696
+ */
697
+ identityType?: IdentityType;
698
+ /**
699
+ * <p>The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.</p>
700
+ * @public
701
+ */
702
+ iamIdentityProviderArn?: string;
675
703
  /**
676
704
  * <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
677
705
  * creating for—or connecting to—your Amazon Q Business application.</p>
678
706
  * @public
679
707
  */
680
708
  identityCenterInstanceArn?: string;
709
+ /**
710
+ * <p>The OIDC client ID for a Amazon Q Business application.</p>
711
+ * @public
712
+ */
713
+ clientIdsForOIDC?: string[];
681
714
  /**
682
715
  * <p>A description for the Amazon Q Business application. </p>
683
716
  * @public
@@ -899,6 +932,51 @@ export interface AppliedAttachmentsConfiguration {
899
932
  */
900
933
  attachmentsControlMode?: AttachmentsControlMode;
901
934
  }
935
+ /**
936
+ * @public
937
+ * @enum
938
+ */
939
+ export declare const AutoSubscriptionStatus: {
940
+ readonly DISABLED: "DISABLED";
941
+ readonly ENABLED: "ENABLED";
942
+ };
943
+ /**
944
+ * @public
945
+ */
946
+ export type AutoSubscriptionStatus = (typeof AutoSubscriptionStatus)[keyof typeof AutoSubscriptionStatus];
947
+ /**
948
+ * @public
949
+ * @enum
950
+ */
951
+ export declare const SubscriptionType: {
952
+ readonly Q_BUSINESS: "Q_BUSINESS";
953
+ readonly Q_LITE: "Q_LITE";
954
+ };
955
+ /**
956
+ * @public
957
+ */
958
+ export type SubscriptionType = (typeof SubscriptionType)[keyof typeof SubscriptionType];
959
+ /**
960
+ * <p>Subscription configuration information for an Amazon Q Business application
961
+ * using IAM identity federation for user management. </p>
962
+ * @public
963
+ */
964
+ export interface AutoSubscriptionConfiguration {
965
+ /**
966
+ * <p>Describes whether automatic subscriptions are enabled for an Amazon Q Business
967
+ * application using IAM identity federation for user management.</p>
968
+ * @public
969
+ */
970
+ autoSubscribe: AutoSubscriptionStatus | undefined;
971
+ /**
972
+ * <p>Describes the default subscription type assigned to an Amazon Q Business
973
+ * application using IAM identity federation for user management. If the
974
+ * value for <code>autoSubscribe</code> is set to <code>ENABLED</code> you must select a
975
+ * value for this field.</p>
976
+ * @public
977
+ */
978
+ defaultSubscriptionType?: SubscriptionType;
979
+ }
902
980
  /**
903
981
  * @public
904
982
  * @enum
@@ -948,6 +1026,16 @@ export interface GetApplicationResponse {
948
1026
  * @public
949
1027
  */
950
1028
  applicationArn?: string;
1029
+ /**
1030
+ * <p>The authentication type being used by a Amazon Q Business application.</p>
1031
+ * @public
1032
+ */
1033
+ identityType?: IdentityType;
1034
+ /**
1035
+ * <p>The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.</p>
1036
+ * @public
1037
+ */
1038
+ iamIdentityProviderArn?: string;
951
1039
  /**
952
1040
  * <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to
953
1041
  * your Amazon Q Business application.</p>
@@ -1011,6 +1099,17 @@ export interface GetApplicationResponse {
1011
1099
  * @public
1012
1100
  */
1013
1101
  personalizationConfiguration?: PersonalizationConfiguration;
1102
+ /**
1103
+ * <p>Settings for auto-subscription behavior for this application. This is only applicable
1104
+ * to SAML and OIDC applications.</p>
1105
+ * @public
1106
+ */
1107
+ autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
1108
+ /**
1109
+ * <p>The OIDC client ID for a Amazon Q Business application.</p>
1110
+ * @public
1111
+ */
1112
+ clientIdsForOIDC?: string[];
1014
1113
  }
1015
1114
  /**
1016
1115
  * <p>Provides information about index capacity configuration.</p>
@@ -1489,9 +1588,36 @@ export interface CreateDataSourceRequest {
1489
1588
  */
1490
1589
  displayName: string | undefined;
1491
1590
  /**
1492
- * <p>Configuration information to connect to your data source repository. For configuration
1493
- * templates for your specific data source, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html">Supported
1494
- * connectors</a>.</p>
1591
+ * <p>Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration
1592
+ * information specific to your data source connector.</p>
1593
+ * <p>Each data source has a JSON schema provided by Amazon Q Business that you must
1594
+ * use. For example, the Amazon S3 and Web Crawler connectors require the following
1595
+ * JSON schemas:</p>
1596
+ * <ul>
1597
+ * <li>
1598
+ * <p>
1599
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html">Amazon S3 JSON schema</a>
1600
+ * </p>
1601
+ * </li>
1602
+ * <li>
1603
+ * <p>
1604
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html">Web Crawler JSON schema</a>
1605
+ * </p>
1606
+ * </li>
1607
+ * </ul>
1608
+ * <p>You can find configuration templates for your specific data source using the following
1609
+ * steps:</p>
1610
+ * <ol>
1611
+ * <li>
1612
+ * <p>Navigate to the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html">Supported
1613
+ * connectors</a> page in the Amazon Q Business User Guide, and
1614
+ * select the data source of your choice.</p>
1615
+ * </li>
1616
+ * <li>
1617
+ * <p>Then, from your specific data source connector page, select <b>Using the API</b>. You will find the JSON schema for your
1618
+ * data source, including parameter descriptions, in this section.</p>
1619
+ * </li>
1620
+ * </ol>
1495
1621
  * @public
1496
1622
  */
1497
1623
  configuration: __DocumentType | undefined;
@@ -3288,12 +3414,95 @@ export interface UpdateApplicationRequest {
3288
3414
  * @public
3289
3415
  */
3290
3416
  personalizationConfiguration?: PersonalizationConfiguration;
3417
+ /**
3418
+ * <p>An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user
3419
+ * management.</p>
3420
+ * @public
3421
+ */
3422
+ autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
3291
3423
  }
3292
3424
  /**
3293
3425
  * @public
3294
3426
  */
3295
3427
  export interface UpdateApplicationResponse {
3296
3428
  }
3429
+ /**
3430
+ * <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end
3431
+ * users of an Amazon Q Business web experience.</p>
3432
+ * @public
3433
+ */
3434
+ export interface OpenIDConnectProviderConfiguration {
3435
+ /**
3436
+ * <p>The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC
3437
+ * client secret.</p>
3438
+ * @public
3439
+ */
3440
+ secretsArn: string | undefined;
3441
+ /**
3442
+ * <p>An IAM role with permissions to access KMS to decrypt
3443
+ * the Secrets Manager secret containing your OIDC client secret.</p>
3444
+ * @public
3445
+ */
3446
+ secretsRole: string | undefined;
3447
+ }
3448
+ /**
3449
+ * <p>Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate
3450
+ * end users of an Amazon Q Business web experience.</p>
3451
+ * @public
3452
+ */
3453
+ export interface SamlProviderConfiguration {
3454
+ /**
3455
+ * <p>The URL where Amazon Q Business end users will be redirected for authentication.
3456
+ * </p>
3457
+ * @public
3458
+ */
3459
+ authenticationUrl: string | undefined;
3460
+ }
3461
+ /**
3462
+ * <p>Provides information about the identity provider (IdP) used to authenticate end users
3463
+ * of an Amazon Q Business web experience.</p>
3464
+ * @public
3465
+ */
3466
+ export type IdentityProviderConfiguration = IdentityProviderConfiguration.OpenIDConnectConfigurationMember | IdentityProviderConfiguration.SamlConfigurationMember | IdentityProviderConfiguration.$UnknownMember;
3467
+ /**
3468
+ * @public
3469
+ */
3470
+ export declare namespace IdentityProviderConfiguration {
3471
+ /**
3472
+ * <p>Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate
3473
+ * end users of an Amazon Q Business web experience.</p>
3474
+ * @public
3475
+ */
3476
+ interface SamlConfigurationMember {
3477
+ samlConfiguration: SamlProviderConfiguration;
3478
+ openIDConnectConfiguration?: never;
3479
+ $unknown?: never;
3480
+ }
3481
+ /**
3482
+ * <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end
3483
+ * users of an Amazon Q Business web experience.</p>
3484
+ * @public
3485
+ */
3486
+ interface OpenIDConnectConfigurationMember {
3487
+ samlConfiguration?: never;
3488
+ openIDConnectConfiguration: OpenIDConnectProviderConfiguration;
3489
+ $unknown?: never;
3490
+ }
3491
+ /**
3492
+ * @public
3493
+ */
3494
+ interface $UnknownMember {
3495
+ samlConfiguration?: never;
3496
+ openIDConnectConfiguration?: never;
3497
+ $unknown: [string, any];
3498
+ }
3499
+ interface Visitor<T> {
3500
+ samlConfiguration: (value: SamlProviderConfiguration) => T;
3501
+ openIDConnectConfiguration: (value: OpenIDConnectProviderConfiguration) => T;
3502
+ _: (name: string, value: any) => T;
3503
+ }
3504
+ const visit: <T>(value: IdentityProviderConfiguration, visitor: Visitor<T>) => T;
3505
+ }
3297
3506
  /**
3298
3507
  * @public
3299
3508
  * @enum
@@ -3340,6 +3549,11 @@ export interface CreateWebExperienceRequest {
3340
3549
  /**
3341
3550
  * <p>The Amazon Resource Name (ARN) of the service role attached to your web
3342
3551
  * experience.</p>
3552
+ * <note>
3553
+ * <p>You must provide this value if you're using IAM Identity Center to manage end user
3554
+ * access to your application. If you're using legacy identity management to manage
3555
+ * user access, you don't need to provide this value.</p>
3556
+ * </note>
3343
3557
  * @public
3344
3558
  */
3345
3559
  roleArn?: string;
@@ -3357,6 +3571,12 @@ export interface CreateWebExperienceRequest {
3357
3571
  * @public
3358
3572
  */
3359
3573
  clientToken?: string;
3574
+ /**
3575
+ * <p>Information about the identity provider (IdP) used to authenticate end users of an
3576
+ * Amazon Q Business web experience.</p>
3577
+ * @public
3578
+ */
3579
+ identityProviderConfiguration?: IdentityProviderConfiguration;
3360
3580
  }
3361
3581
  /**
3362
3582
  * @public
@@ -3555,6 +3775,12 @@ export interface GetWebExperienceResponse {
3555
3775
  * @public
3556
3776
  */
3557
3777
  roleArn?: string;
3778
+ /**
3779
+ * <p>Information about the identity provider (IdP) used to authenticate end users of an
3780
+ * Amazon Q Business web experience.</p>
3781
+ * @public
3782
+ */
3783
+ identityProviderConfiguration?: IdentityProviderConfiguration;
3558
3784
  /**
3559
3785
  * @deprecated
3560
3786
  *
@@ -3691,6 +3917,12 @@ export interface UpdateWebExperienceRequest {
3691
3917
  * @public
3692
3918
  */
3693
3919
  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
3920
+ /**
3921
+ * <p>Information about the identity provider (IdP) used to authenticate end users of an
3922
+ * Amazon Q Business web experience.</p>
3923
+ * @public
3924
+ */
3925
+ identityProviderConfiguration?: IdentityProviderConfiguration;
3694
3926
  }
3695
3927
  /**
3696
3928
  * @public
@@ -5729,10 +5961,6 @@ export interface PutGroupRequest {
5729
5961
  * <p>The list that contains your users or sub groups that belong the same group. For
5730
5962
  * example, the group "Company" includes the user "CEO" and the sub groups "Research",
5731
5963
  * "Engineering", and "Sales and Marketing".</p>
5732
- * <p>If you have more than 1000 users and/or sub groups for a single group, you need to
5733
- * provide the path to the S3 file that lists your users and sub groups for a group. Your
5734
- * sub groups can contain more than 1000 users, but the list of sub groups that belong to a
5735
- * group (and/or users) must be no more than 1000.</p>
5736
5964
  * @public
5737
5965
  */
5738
5966
  groupName: string | undefined;
@@ -164,6 +164,12 @@ export declare const APISchemaType: {
164
164
  readonly OPEN_API_V3: "OPEN_API_V3";
165
165
  };
166
166
  export type APISchemaType = (typeof APISchemaType)[keyof typeof APISchemaType];
167
+ export declare const IdentityType: {
168
+ readonly AWS_IAM_IDC: "AWS_IAM_IDC";
169
+ readonly AWS_IAM_IDP_OIDC: "AWS_IAM_IDP_OIDC";
170
+ readonly AWS_IAM_IDP_SAML: "AWS_IAM_IDP_SAML";
171
+ };
172
+ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
167
173
  export declare const ApplicationStatus: {
168
174
  readonly ACTIVE: "ACTIVE";
169
175
  readonly CREATING: "CREATING";
@@ -179,6 +185,7 @@ export interface Application {
179
185
  createdAt?: Date;
180
186
  updatedAt?: Date;
181
187
  status?: ApplicationStatus;
188
+ identityType?: IdentityType;
182
189
  }
183
190
  export declare class ConflictException extends __BaseException {
184
191
  readonly name: "ConflictException";
@@ -224,7 +231,10 @@ export interface Tag {
224
231
  export interface CreateApplicationRequest {
225
232
  displayName: string | undefined;
226
233
  roleArn?: string;
234
+ identityType?: IdentityType;
235
+ iamIdentityProviderArn?: string;
227
236
  identityCenterInstanceArn?: string;
237
+ clientIdsForOIDC?: string[];
228
238
  description?: string;
229
239
  encryptionConfiguration?: EncryptionConfiguration;
230
240
  tags?: Tag[];
@@ -299,6 +309,22 @@ export interface GetApplicationRequest {
299
309
  export interface AppliedAttachmentsConfiguration {
300
310
  attachmentsControlMode?: AttachmentsControlMode;
301
311
  }
312
+ export declare const AutoSubscriptionStatus: {
313
+ readonly DISABLED: "DISABLED";
314
+ readonly ENABLED: "ENABLED";
315
+ };
316
+ export type AutoSubscriptionStatus =
317
+ (typeof AutoSubscriptionStatus)[keyof typeof AutoSubscriptionStatus];
318
+ export declare const SubscriptionType: {
319
+ readonly Q_BUSINESS: "Q_BUSINESS";
320
+ readonly Q_LITE: "Q_LITE";
321
+ };
322
+ export type SubscriptionType =
323
+ (typeof SubscriptionType)[keyof typeof SubscriptionType];
324
+ export interface AutoSubscriptionConfiguration {
325
+ autoSubscribe: AutoSubscriptionStatus | undefined;
326
+ defaultSubscriptionType?: SubscriptionType;
327
+ }
302
328
  export declare const ErrorCode: {
303
329
  readonly INTERNAL_ERROR: "InternalError";
304
330
  readonly INVALID_REQUEST: "InvalidRequest";
@@ -314,6 +340,8 @@ export interface GetApplicationResponse {
314
340
  displayName?: string;
315
341
  applicationId?: string;
316
342
  applicationArn?: string;
343
+ identityType?: IdentityType;
344
+ iamIdentityProviderArn?: string;
317
345
  identityCenterApplicationArn?: string;
318
346
  roleArn?: string;
319
347
  status?: ApplicationStatus;
@@ -325,6 +353,8 @@ export interface GetApplicationResponse {
325
353
  attachmentsConfiguration?: AppliedAttachmentsConfiguration;
326
354
  qAppsConfiguration?: QAppsConfiguration;
327
355
  personalizationConfiguration?: PersonalizationConfiguration;
356
+ autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
357
+ clientIdsForOIDC?: string[];
328
358
  }
329
359
  export interface IndexCapacityConfiguration {
330
360
  units?: number;
@@ -973,8 +1003,48 @@ export interface UpdateApplicationRequest {
973
1003
  attachmentsConfiguration?: AttachmentsConfiguration;
974
1004
  qAppsConfiguration?: QAppsConfiguration;
975
1005
  personalizationConfiguration?: PersonalizationConfiguration;
1006
+ autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
976
1007
  }
977
1008
  export interface UpdateApplicationResponse {}
1009
+ export interface OpenIDConnectProviderConfiguration {
1010
+ secretsArn: string | undefined;
1011
+ secretsRole: string | undefined;
1012
+ }
1013
+ export interface SamlProviderConfiguration {
1014
+ authenticationUrl: string | undefined;
1015
+ }
1016
+ export type IdentityProviderConfiguration =
1017
+ | IdentityProviderConfiguration.OpenIDConnectConfigurationMember
1018
+ | IdentityProviderConfiguration.SamlConfigurationMember
1019
+ | IdentityProviderConfiguration.$UnknownMember;
1020
+ export declare namespace IdentityProviderConfiguration {
1021
+ interface SamlConfigurationMember {
1022
+ samlConfiguration: SamlProviderConfiguration;
1023
+ openIDConnectConfiguration?: never;
1024
+ $unknown?: never;
1025
+ }
1026
+ interface OpenIDConnectConfigurationMember {
1027
+ samlConfiguration?: never;
1028
+ openIDConnectConfiguration: OpenIDConnectProviderConfiguration;
1029
+ $unknown?: never;
1030
+ }
1031
+ interface $UnknownMember {
1032
+ samlConfiguration?: never;
1033
+ openIDConnectConfiguration?: never;
1034
+ $unknown: [string, any];
1035
+ }
1036
+ interface Visitor<T> {
1037
+ samlConfiguration: (value: SamlProviderConfiguration) => T;
1038
+ openIDConnectConfiguration: (
1039
+ value: OpenIDConnectProviderConfiguration
1040
+ ) => T;
1041
+ _: (name: string, value: any) => T;
1042
+ }
1043
+ const visit: <T>(
1044
+ value: IdentityProviderConfiguration,
1045
+ visitor: Visitor<T>
1046
+ ) => T;
1047
+ }
978
1048
  export declare const WebExperienceSamplePromptsControlMode: {
979
1049
  readonly DISABLED: "DISABLED";
980
1050
  readonly ENABLED: "ENABLED";
@@ -990,6 +1060,7 @@ export interface CreateWebExperienceRequest {
990
1060
  roleArn?: string;
991
1061
  tags?: Tag[];
992
1062
  clientToken?: string;
1063
+ identityProviderConfiguration?: IdentityProviderConfiguration;
993
1064
  }
994
1065
  export interface CreateWebExperienceResponse {
995
1066
  webExperienceId?: string;
@@ -1053,6 +1124,7 @@ export interface GetWebExperienceResponse {
1053
1124
  welcomeMessage?: string;
1054
1125
  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
1055
1126
  roleArn?: string;
1127
+ identityProviderConfiguration?: IdentityProviderConfiguration;
1056
1128
  authenticationConfiguration?: WebExperienceAuthConfiguration;
1057
1129
  error?: ErrorDetail;
1058
1130
  }
@@ -1081,6 +1153,7 @@ export interface UpdateWebExperienceRequest {
1081
1153
  subtitle?: string;
1082
1154
  welcomeMessage?: string;
1083
1155
  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
1156
+ identityProviderConfiguration?: IdentityProviderConfiguration;
1084
1157
  }
1085
1158
  export interface UpdateWebExperienceResponse {}
1086
1159
  export declare const CreatorModeControl: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-qbusiness",
3
3
  "description": "AWS SDK for JavaScript Qbusiness Client for Node.js, Browser and React Native",
4
- "version": "3.637.0",
4
+ "version": "3.645.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-qbusiness",
@@ -20,19 +20,19 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.637.0",
24
- "@aws-sdk/client-sts": "3.637.0",
23
+ "@aws-sdk/client-sso-oidc": "3.645.0",
24
+ "@aws-sdk/client-sts": "3.645.0",
25
25
  "@aws-sdk/core": "3.635.0",
26
- "@aws-sdk/credential-provider-node": "3.637.0",
26
+ "@aws-sdk/credential-provider-node": "3.645.0",
27
27
  "@aws-sdk/eventstream-handler-node": "3.620.0",
28
28
  "@aws-sdk/middleware-eventstream": "3.620.0",
29
29
  "@aws-sdk/middleware-host-header": "3.620.0",
30
30
  "@aws-sdk/middleware-logger": "3.609.0",
31
31
  "@aws-sdk/middleware-recursion-detection": "3.620.0",
32
- "@aws-sdk/middleware-user-agent": "3.637.0",
32
+ "@aws-sdk/middleware-user-agent": "3.645.0",
33
33
  "@aws-sdk/region-config-resolver": "3.614.0",
34
34
  "@aws-sdk/types": "3.609.0",
35
- "@aws-sdk/util-endpoints": "3.637.0",
35
+ "@aws-sdk/util-endpoints": "3.645.0",
36
36
  "@aws-sdk/util-user-agent-browser": "3.609.0",
37
37
  "@aws-sdk/util-user-agent-node": "3.614.0",
38
38
  "@smithy/config-resolver": "^3.0.5",