aws-sdk-qbusiness 1.11.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 20b03cc5793bf612a9919fbe290251219a49f7dc8ebc40b94124535c3113411d
4
- data.tar.gz: f2663a04eaa616b7af0ca2eba98d16273007bd12ce65fe8c1f1002bace47c780
3
+ metadata.gz: d9c0359f7faf73a13d9a6e28c643a22ae563e60324ed0e464036fbacac9fd4eb
4
+ data.tar.gz: 5826d1e0f94bbc0b257b88b1d6510247b61752c021d79f264a42e6092026590f
5
5
  SHA512:
6
- metadata.gz: 3a05f4d16545722f7910a99a2ba0aa440868f21021c6e2a309c59d766f168662fd1cee9b1a4fbd860b2d60c1a20781bb1534c35bd1942f2c1afccd367da8941a
7
- data.tar.gz: ae8528fad510bda7d01ec1914d4773475b7533c9a6b9122cb71577911af735d1d97b4c2972540bc36b99b5ffae6508c8269b6181251fc934420a34f509e926dd
6
+ metadata.gz: f747cab2c1ac613f635f8e00f9e14863dd31385640c43eaa48394821aac4840c0e79712993806ab3df5a2dec7b96199f231e250b270e6943430af54821221458
7
+ data.tar.gz: 43c89628d1b1ea615b57b849d68ebeb7709407f81e5f463e9f59dd1a546bb9796f07a9f0c8502149cb165d789de673891eddd5cb663ebd0380aea877d796ac6a
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.12.0 (2024-08-23)
5
+ ------------------
6
+
7
+ * Feature - Amazon QBusiness: Enable support for SAML and OIDC federation through AWS IAM Identity Provider integration.
8
+
4
9
  1.11.0 (2024-07-05)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.11.0
1
+ 1.12.0
@@ -580,7 +580,7 @@ module Aws::QBusiness
580
580
  http_response: Seahorse::Client::Http::AsyncResponse.new,
581
581
  config: config)
582
582
  context[:gem_name] = 'aws-sdk-qbusiness'
583
- context[:gem_version] = '1.11.0'
583
+ context[:gem_version] = '1.12.0'
584
584
  Seahorse::Client::Request.new(handlers, context)
585
585
  end
586
586
 
@@ -919,11 +919,21 @@ module Aws::QBusiness
919
919
  # The Amazon Resource Name (ARN) of an IAM role with permissions to
920
920
  # access your Amazon CloudWatch logs and metrics.
921
921
  #
922
+ # @option params [String] :identity_type
923
+ # The authentication type being used by a Amazon Q Business application.
924
+ #
925
+ # @option params [String] :iam_identity_provider_arn
926
+ # The Amazon Resource Name (ARN) of an identity provider being used by
927
+ # an Amazon Q Business application.
928
+ #
922
929
  # @option params [String] :identity_center_instance_arn
923
930
  # The Amazon Resource Name (ARN) of the IAM Identity Center instance you
924
931
  # are either creating for—or connecting to—your Amazon Q Business
925
932
  # application.
926
933
  #
934
+ # @option params [Array<String>] :client_ids_for_oidc
935
+ # The OIDC client ID for a Amazon Q Business application.
936
+ #
927
937
  # @option params [String] :description
928
938
  # A description for the Amazon Q Business application.
929
939
  #
@@ -970,7 +980,10 @@ module Aws::QBusiness
970
980
  # resp = client.create_application({
971
981
  # display_name: "ApplicationName", # required
972
982
  # role_arn: "RoleArn",
983
+ # identity_type: "AWS_IAM_IDP_SAML", # accepts AWS_IAM_IDP_SAML, AWS_IAM_IDP_OIDC, AWS_IAM_IDC
984
+ # iam_identity_provider_arn: "IamIdentityProviderArn",
973
985
  # identity_center_instance_arn: "InstanceArn",
986
+ # client_ids_for_oidc: ["ClientIdForOIDC"],
974
987
  # description: "Description",
975
988
  # encryption_configuration: {
976
989
  # kms_key_id: "KmsKeyId",
@@ -1025,9 +1038,27 @@ module Aws::QBusiness
1025
1038
  # A name for the data source connector.
1026
1039
  #
1027
1040
  # @option params [required, Hash,Array,String,Numeric,Boolean] :configuration
1028
- # Configuration information to connect to your data source repository.
1029
- # For configuration templates for your specific data source, see
1030
- # [Supported connectors][1].
1041
+ # Configuration information to connect your data source repository to
1042
+ # Amazon Q Business. Use this parameter to provide a JSON schema with
1043
+ # configuration information specific to your data source connector.
1044
+ #
1045
+ # Each data source has a JSON schema provided by Amazon Q Business that
1046
+ # you must use. For example, the Amazon S3 and Web Crawler connectors
1047
+ # require the following JSON schemas:
1048
+ #
1049
+ # * [Amazon S3 JSON schema][1]
1050
+ #
1051
+ # * [Web Crawler JSON schema][2]
1052
+ #
1053
+ # You can find configuration templates for your specific data source
1054
+ # using the following steps:
1055
+ #
1056
+ # 1. Navigate to the [Supported connectors][3] page in the Amazon Q
1057
+ # Business User Guide, and select the data source of your choice.
1058
+ #
1059
+ # 2. Then, from your specific data source connector page, select
1060
+ # **Using the API**. You will find the JSON schema for your data
1061
+ # source, including parameter descriptions, in this section.
1031
1062
  #
1032
1063
  # Document type used to carry open content
1033
1064
  # (Hash,Array,String,Numeric,Boolean). A document type value is
@@ -1036,7 +1067,9 @@ module Aws::QBusiness
1036
1067
  #
1037
1068
  #
1038
1069
  #
1039
- # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
1070
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html
1071
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html
1072
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
1040
1073
  #
1041
1074
  # @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
1042
1075
  # Configuration information for an Amazon VPC (Virtual Private Cloud) to
@@ -1537,6 +1570,13 @@ module Aws::QBusiness
1537
1570
  # The Amazon Resource Name (ARN) of the service role attached to your
1538
1571
  # web experience.
1539
1572
  #
1573
+ # <note markdown="1"> You must provide this value if you're using IAM Identity Center to
1574
+ # manage end user access to your application. If you're using legacy
1575
+ # identity management to manage user access, you don't need to provide
1576
+ # this value.
1577
+ #
1578
+ # </note>
1579
+ #
1540
1580
  # @option params [Array<Types::Tag>] :tags
1541
1581
  # A list of key-value pairs that identify or categorize your Amazon Q
1542
1582
  # Business web experience. You can also use tags to help control access
@@ -1551,6 +1591,10 @@ module Aws::QBusiness
1551
1591
  # **A suitable default value is auto-generated.** You should normally
1552
1592
  # not need to pass this option.**
1553
1593
  #
1594
+ # @option params [Types::IdentityProviderConfiguration] :identity_provider_configuration
1595
+ # Information about the identity provider (IdP) used to authenticate end
1596
+ # users of an Amazon Q Business web experience.
1597
+ #
1554
1598
  # @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1555
1599
  #
1556
1600
  # * {Types::CreateWebExperienceResponse#web_experience_id #web_experience_id} => String
@@ -1572,6 +1616,15 @@ module Aws::QBusiness
1572
1616
  # },
1573
1617
  # ],
1574
1618
  # client_token: "ClientToken",
1619
+ # identity_provider_configuration: {
1620
+ # saml_configuration: {
1621
+ # authentication_url: "SamlAuthenticationUrl", # required
1622
+ # },
1623
+ # open_id_connect_configuration: {
1624
+ # secrets_arn: "SecretArn", # required
1625
+ # secrets_role: "RoleArn", # required
1626
+ # },
1627
+ # },
1575
1628
  # })
1576
1629
  #
1577
1630
  # @example Response structure
@@ -1898,6 +1951,8 @@ module Aws::QBusiness
1898
1951
  # * {Types::GetApplicationResponse#display_name #display_name} => String
1899
1952
  # * {Types::GetApplicationResponse#application_id #application_id} => String
1900
1953
  # * {Types::GetApplicationResponse#application_arn #application_arn} => String
1954
+ # * {Types::GetApplicationResponse#identity_type #identity_type} => String
1955
+ # * {Types::GetApplicationResponse#iam_identity_provider_arn #iam_identity_provider_arn} => String
1901
1956
  # * {Types::GetApplicationResponse#identity_center_application_arn #identity_center_application_arn} => String
1902
1957
  # * {Types::GetApplicationResponse#role_arn #role_arn} => String
1903
1958
  # * {Types::GetApplicationResponse#status #status} => String
@@ -1909,6 +1964,8 @@ module Aws::QBusiness
1909
1964
  # * {Types::GetApplicationResponse#attachments_configuration #attachments_configuration} => Types::AppliedAttachmentsConfiguration
1910
1965
  # * {Types::GetApplicationResponse#q_apps_configuration #q_apps_configuration} => Types::QAppsConfiguration
1911
1966
  # * {Types::GetApplicationResponse#personalization_configuration #personalization_configuration} => Types::PersonalizationConfiguration
1967
+ # * {Types::GetApplicationResponse#auto_subscription_configuration #auto_subscription_configuration} => Types::AutoSubscriptionConfiguration
1968
+ # * {Types::GetApplicationResponse#client_ids_for_oidc #client_ids_for_oidc} => Array&lt;String&gt;
1912
1969
  #
1913
1970
  # @example Request syntax with placeholder values
1914
1971
  #
@@ -1921,6 +1978,8 @@ module Aws::QBusiness
1921
1978
  # resp.display_name #=> String
1922
1979
  # resp.application_id #=> String
1923
1980
  # resp.application_arn #=> String
1981
+ # resp.identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC"
1982
+ # resp.iam_identity_provider_arn #=> String
1924
1983
  # resp.identity_center_application_arn #=> String
1925
1984
  # resp.role_arn #=> String
1926
1985
  # resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
@@ -1933,6 +1992,10 @@ module Aws::QBusiness
1933
1992
  # resp.attachments_configuration.attachments_control_mode #=> String, one of "ENABLED", "DISABLED"
1934
1993
  # resp.q_apps_configuration.q_apps_control_mode #=> String, one of "ENABLED", "DISABLED"
1935
1994
  # resp.personalization_configuration.personalization_control_mode #=> String, one of "ENABLED", "DISABLED"
1995
+ # resp.auto_subscription_configuration.auto_subscribe #=> String, one of "ENABLED", "DISABLED"
1996
+ # resp.auto_subscription_configuration.default_subscription_type #=> String, one of "Q_LITE", "Q_BUSINESS"
1997
+ # resp.client_ids_for_oidc #=> Array
1998
+ # resp.client_ids_for_oidc[0] #=> String
1936
1999
  #
1937
2000
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplication AWS API Documentation
1938
2001
  #
@@ -2412,6 +2475,7 @@ module Aws::QBusiness
2412
2475
  # * {Types::GetWebExperienceResponse#welcome_message #welcome_message} => String
2413
2476
  # * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
2414
2477
  # * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
2478
+ # * {Types::GetWebExperienceResponse#identity_provider_configuration #identity_provider_configuration} => Types::IdentityProviderConfiguration
2415
2479
  # * {Types::GetWebExperienceResponse#authentication_configuration #authentication_configuration} => Types::WebExperienceAuthConfiguration
2416
2480
  # * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
2417
2481
  #
@@ -2436,6 +2500,9 @@ module Aws::QBusiness
2436
2500
  # resp.welcome_message #=> String
2437
2501
  # resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
2438
2502
  # resp.role_arn #=> String
2503
+ # resp.identity_provider_configuration.saml_configuration.authentication_url #=> String
2504
+ # resp.identity_provider_configuration.open_id_connect_configuration.secrets_arn #=> String
2505
+ # resp.identity_provider_configuration.open_id_connect_configuration.secrets_role #=> String
2439
2506
  # resp.authentication_configuration.saml_configuration.metadata_xml #=> String
2440
2507
  # resp.authentication_configuration.saml_configuration.role_arn #=> String
2441
2508
  # resp.authentication_configuration.saml_configuration.user_id_attribute #=> String
@@ -2486,6 +2553,7 @@ module Aws::QBusiness
2486
2553
  # resp.applications[0].created_at #=> Time
2487
2554
  # resp.applications[0].updated_at #=> Time
2488
2555
  # resp.applications[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
2556
+ # resp.applications[0].identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC"
2489
2557
  #
2490
2558
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplications AWS API Documentation
2491
2559
  #
@@ -3187,12 +3255,6 @@ module Aws::QBusiness
3187
3255
  # and the sub groups "Research", "Engineering", and "Sales and
3188
3256
  # Marketing".
3189
3257
  #
3190
- # If you have more than 1000 users and/or sub groups for a single group,
3191
- # you need to provide the path to the S3 file that lists your users and
3192
- # sub groups for a group. Your sub groups can contain more than 1000
3193
- # users, but the list of sub groups that belong to a group (and/or
3194
- # users) must be no more than 1000.
3195
- #
3196
3258
  # @option params [String] :data_source_id
3197
3259
  # The identifier of the data source for which you want to map users to
3198
3260
  # their groups. This is useful if a group is tied to multiple data
@@ -3419,6 +3481,11 @@ module Aws::QBusiness
3419
3481
  #
3420
3482
  # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html
3421
3483
  #
3484
+ # @option params [Types::AutoSubscriptionConfiguration] :auto_subscription_configuration
3485
+ # An option to enable updating the default subscription type assigned to
3486
+ # an Amazon Q Business application using IAM identity federation for
3487
+ # user management.
3488
+ #
3422
3489
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3423
3490
  #
3424
3491
  # @example Request syntax with placeholder values
@@ -3438,6 +3505,10 @@ module Aws::QBusiness
3438
3505
  # personalization_configuration: {
3439
3506
  # personalization_control_mode: "ENABLED", # required, accepts ENABLED, DISABLED
3440
3507
  # },
3508
+ # auto_subscription_configuration: {
3509
+ # auto_subscribe: "ENABLED", # required, accepts ENABLED, DISABLED
3510
+ # default_subscription_type: "Q_LITE", # accepts Q_LITE, Q_BUSINESS
3511
+ # },
3441
3512
  # })
3442
3513
  #
3443
3514
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplication AWS API Documentation
@@ -4000,6 +4071,10 @@ module Aws::QBusiness
4000
4071
  # Determines whether sample prompts are enabled in the web experience
4001
4072
  # for an end user.
4002
4073
  #
4074
+ # @option params [Types::IdentityProviderConfiguration] :identity_provider_configuration
4075
+ # Information about the identity provider (IdP) used to authenticate end
4076
+ # users of an Amazon Q Business web experience.
4077
+ #
4003
4078
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4004
4079
  #
4005
4080
  # @example Request syntax with placeholder values
@@ -4020,6 +4095,15 @@ module Aws::QBusiness
4020
4095
  # subtitle: "WebExperienceSubtitle",
4021
4096
  # welcome_message: "WebExperienceWelcomeMessage",
4022
4097
  # sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
4098
+ # identity_provider_configuration: {
4099
+ # saml_configuration: {
4100
+ # authentication_url: "SamlAuthenticationUrl", # required
4101
+ # },
4102
+ # open_id_connect_configuration: {
4103
+ # secrets_arn: "SecretArn", # required
4104
+ # secrets_role: "RoleArn", # required
4105
+ # },
4106
+ # },
4023
4107
  # })
4024
4108
  #
4025
4109
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience AWS API Documentation
@@ -4044,7 +4128,7 @@ module Aws::QBusiness
4044
4128
  params: params,
4045
4129
  config: config)
4046
4130
  context[:gem_name] = 'aws-sdk-qbusiness'
4047
- context[:gem_version] = '1.11.0'
4131
+ context[:gem_version] = '1.12.0'
4048
4132
  Seahorse::Client::Request.new(handlers, context)
4049
4133
  end
4050
4134
 
@@ -62,6 +62,8 @@ module Aws::QBusiness
62
62
  AuthResponseKey = Shapes::StringShape.new(name: 'AuthResponseKey')
63
63
  AuthResponseValue = Shapes::StringShape.new(name: 'AuthResponseValue')
64
64
  AuthorizationResponseMap = Shapes::MapShape.new(name: 'AuthorizationResponseMap')
65
+ AutoSubscriptionConfiguration = Shapes::StructureShape.new(name: 'AutoSubscriptionConfiguration')
66
+ AutoSubscriptionStatus = Shapes::StringShape.new(name: 'AutoSubscriptionStatus')
65
67
  BasicAuthConfiguration = Shapes::StructureShape.new(name: 'BasicAuthConfiguration')
66
68
  BatchDeleteDocumentRequest = Shapes::StructureShape.new(name: 'BatchDeleteDocumentRequest')
67
69
  BatchDeleteDocumentResponse = Shapes::StructureShape.new(name: 'BatchDeleteDocumentResponse')
@@ -82,6 +84,8 @@ module Aws::QBusiness
82
84
  ChatOutputStream = Shapes::StructureShape.new(name: 'ChatOutputStream')
83
85
  ChatSyncInput = Shapes::StructureShape.new(name: 'ChatSyncInput')
84
86
  ChatSyncOutput = Shapes::StructureShape.new(name: 'ChatSyncOutput')
87
+ ClientIdForOIDC = Shapes::StringShape.new(name: 'ClientIdForOIDC')
88
+ ClientIdsForOIDC = Shapes::ListShape.new(name: 'ClientIdsForOIDC')
85
89
  ClientToken = Shapes::StringShape.new(name: 'ClientToken')
86
90
  ConfigurationEvent = Shapes::StructureShape.new(name: 'ConfigurationEvent')
87
91
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
@@ -211,7 +215,10 @@ module Aws::QBusiness
211
215
  GroupSummary = Shapes::StructureShape.new(name: 'GroupSummary')
212
216
  GroupSummaryList = Shapes::ListShape.new(name: 'GroupSummaryList')
213
217
  HookConfiguration = Shapes::StructureShape.new(name: 'HookConfiguration')
218
+ IamIdentityProviderArn = Shapes::StringShape.new(name: 'IamIdentityProviderArn')
214
219
  IdcApplicationArn = Shapes::StringShape.new(name: 'IdcApplicationArn')
220
+ IdentityProviderConfiguration = Shapes::UnionShape.new(name: 'IdentityProviderConfiguration')
221
+ IdentityType = Shapes::StringShape.new(name: 'IdentityType')
215
222
  Index = Shapes::StructureShape.new(name: 'Index')
216
223
  IndexArn = Shapes::StringShape.new(name: 'IndexArn')
217
224
  IndexCapacityConfiguration = Shapes::StructureShape.new(name: 'IndexCapacityConfiguration')
@@ -294,6 +301,7 @@ module Aws::QBusiness
294
301
  NumberAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'NumberAttributeBoostingConfiguration')
295
302
  NumberAttributeBoostingType = Shapes::StringShape.new(name: 'NumberAttributeBoostingType')
296
303
  OAuth2ClientCredentialConfiguration = Shapes::StructureShape.new(name: 'OAuth2ClientCredentialConfiguration')
304
+ OpenIDConnectProviderConfiguration = Shapes::StructureShape.new(name: 'OpenIDConnectProviderConfiguration')
297
305
  Payload = Shapes::StringShape.new(name: 'Payload')
298
306
  PersonalizationConfiguration = Shapes::StructureShape.new(name: 'PersonalizationConfiguration')
299
307
  PersonalizationControlMode = Shapes::StringShape.new(name: 'PersonalizationControlMode')
@@ -337,8 +345,10 @@ module Aws::QBusiness
337
345
  S3BucketName = Shapes::StringShape.new(name: 'S3BucketName')
338
346
  S3ObjectKey = Shapes::StringShape.new(name: 'S3ObjectKey')
339
347
  SamlAttribute = Shapes::StringShape.new(name: 'SamlAttribute')
348
+ SamlAuthenticationUrl = Shapes::StringShape.new(name: 'SamlAuthenticationUrl')
340
349
  SamlConfiguration = Shapes::StructureShape.new(name: 'SamlConfiguration')
341
350
  SamlMetadataXML = Shapes::StringShape.new(name: 'SamlMetadataXML')
351
+ SamlProviderConfiguration = Shapes::StructureShape.new(name: 'SamlProviderConfiguration')
342
352
  SecretArn = Shapes::StringShape.new(name: 'SecretArn')
343
353
  SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
344
354
  SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
@@ -359,6 +369,7 @@ module Aws::QBusiness
359
369
  StringListAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'StringListAttributeBoostingConfiguration')
360
370
  SubnetId = Shapes::StringShape.new(name: 'SubnetId')
361
371
  SubnetIds = Shapes::ListShape.new(name: 'SubnetIds')
372
+ SubscriptionType = Shapes::StringShape.new(name: 'SubscriptionType')
362
373
  SyncSchedule = Shapes::StringShape.new(name: 'SyncSchedule')
363
374
  SystemMessageId = Shapes::StringShape.new(name: 'SystemMessageId')
364
375
  SystemMessageOverride = Shapes::StringShape.new(name: 'SystemMessageOverride')
@@ -498,6 +509,7 @@ module Aws::QBusiness
498
509
  Application.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdAt"))
499
510
  Application.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "updatedAt"))
500
511
  Application.add_member(:status, Shapes::ShapeRef.new(shape: ApplicationStatus, location_name: "status"))
512
+ Application.add_member(:identity_type, Shapes::ShapeRef.new(shape: IdentityType, location_name: "identityType"))
501
513
  Application.struct_class = Types::Application
502
514
 
503
515
  Applications.member = Shapes::ShapeRef.new(shape: Application)
@@ -556,6 +568,10 @@ module Aws::QBusiness
556
568
  AuthorizationResponseMap.key = Shapes::ShapeRef.new(shape: AuthResponseKey)
557
569
  AuthorizationResponseMap.value = Shapes::ShapeRef.new(shape: AuthResponseValue)
558
570
 
571
+ AutoSubscriptionConfiguration.add_member(:auto_subscribe, Shapes::ShapeRef.new(shape: AutoSubscriptionStatus, required: true, location_name: "autoSubscribe"))
572
+ AutoSubscriptionConfiguration.add_member(:default_subscription_type, Shapes::ShapeRef.new(shape: SubscriptionType, location_name: "defaultSubscriptionType"))
573
+ AutoSubscriptionConfiguration.struct_class = Types::AutoSubscriptionConfiguration
574
+
559
575
  BasicAuthConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "secretArn"))
560
576
  BasicAuthConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
561
577
  BasicAuthConfiguration.struct_class = Types::BasicAuthConfiguration
@@ -652,6 +668,8 @@ module Aws::QBusiness
652
668
  ChatSyncOutput.add_member(:failed_attachments, Shapes::ShapeRef.new(shape: AttachmentsOutput, location_name: "failedAttachments"))
653
669
  ChatSyncOutput.struct_class = Types::ChatSyncOutput
654
670
 
671
+ ClientIdsForOIDC.member = Shapes::ShapeRef.new(shape: ClientIdForOIDC)
672
+
655
673
  ConfigurationEvent.add_member(:chat_mode, Shapes::ShapeRef.new(shape: ChatMode, location_name: "chatMode"))
656
674
  ConfigurationEvent.add_member(:chat_mode_configuration, Shapes::ShapeRef.new(shape: ChatModeConfiguration, location_name: "chatModeConfiguration"))
657
675
  ConfigurationEvent.add_member(:attribute_filter, Shapes::ShapeRef.new(shape: AttributeFilter, location_name: "attributeFilter"))
@@ -677,7 +695,10 @@ module Aws::QBusiness
677
695
 
678
696
  CreateApplicationRequest.add_member(:display_name, Shapes::ShapeRef.new(shape: ApplicationName, required: true, location_name: "displayName"))
679
697
  CreateApplicationRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
698
+ CreateApplicationRequest.add_member(:identity_type, Shapes::ShapeRef.new(shape: IdentityType, location_name: "identityType"))
699
+ CreateApplicationRequest.add_member(:iam_identity_provider_arn, Shapes::ShapeRef.new(shape: IamIdentityProviderArn, location_name: "iamIdentityProviderArn"))
680
700
  CreateApplicationRequest.add_member(:identity_center_instance_arn, Shapes::ShapeRef.new(shape: InstanceArn, location_name: "identityCenterInstanceArn"))
701
+ CreateApplicationRequest.add_member(:client_ids_for_oidc, Shapes::ShapeRef.new(shape: ClientIdsForOIDC, location_name: "clientIdsForOIDC"))
681
702
  CreateApplicationRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
682
703
  CreateApplicationRequest.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: EncryptionConfiguration, location_name: "encryptionConfiguration"))
683
704
  CreateApplicationRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
@@ -767,6 +788,7 @@ module Aws::QBusiness
767
788
  CreateWebExperienceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
768
789
  CreateWebExperienceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
769
790
  CreateWebExperienceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
791
+ CreateWebExperienceRequest.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration"))
770
792
  CreateWebExperienceRequest.struct_class = Types::CreateWebExperienceRequest
771
793
 
772
794
  CreateWebExperienceResponse.add_member(:web_experience_id, Shapes::ShapeRef.new(shape: WebExperienceId, location_name: "webExperienceId"))
@@ -1007,6 +1029,8 @@ module Aws::QBusiness
1007
1029
  GetApplicationResponse.add_member(:display_name, Shapes::ShapeRef.new(shape: ApplicationName, location_name: "displayName"))
1008
1030
  GetApplicationResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, location_name: "applicationId"))
1009
1031
  GetApplicationResponse.add_member(:application_arn, Shapes::ShapeRef.new(shape: ApplicationArn, location_name: "applicationArn"))
1032
+ GetApplicationResponse.add_member(:identity_type, Shapes::ShapeRef.new(shape: IdentityType, location_name: "identityType"))
1033
+ GetApplicationResponse.add_member(:iam_identity_provider_arn, Shapes::ShapeRef.new(shape: IamIdentityProviderArn, location_name: "iamIdentityProviderArn"))
1010
1034
  GetApplicationResponse.add_member(:identity_center_application_arn, Shapes::ShapeRef.new(shape: IdcApplicationArn, location_name: "identityCenterApplicationArn"))
1011
1035
  GetApplicationResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
1012
1036
  GetApplicationResponse.add_member(:status, Shapes::ShapeRef.new(shape: ApplicationStatus, location_name: "status"))
@@ -1018,6 +1042,8 @@ module Aws::QBusiness
1018
1042
  GetApplicationResponse.add_member(:attachments_configuration, Shapes::ShapeRef.new(shape: AppliedAttachmentsConfiguration, location_name: "attachmentsConfiguration"))
1019
1043
  GetApplicationResponse.add_member(:q_apps_configuration, Shapes::ShapeRef.new(shape: QAppsConfiguration, location_name: "qAppsConfiguration"))
1020
1044
  GetApplicationResponse.add_member(:personalization_configuration, Shapes::ShapeRef.new(shape: PersonalizationConfiguration, location_name: "personalizationConfiguration"))
1045
+ GetApplicationResponse.add_member(:auto_subscription_configuration, Shapes::ShapeRef.new(shape: AutoSubscriptionConfiguration, location_name: "autoSubscriptionConfiguration"))
1046
+ GetApplicationResponse.add_member(:client_ids_for_oidc, Shapes::ShapeRef.new(shape: ClientIdsForOIDC, location_name: "clientIdsForOIDC"))
1021
1047
  GetApplicationResponse.struct_class = Types::GetApplicationResponse
1022
1048
 
1023
1049
  GetChatControlsConfigurationRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
@@ -1141,6 +1167,7 @@ module Aws::QBusiness
1141
1167
  GetWebExperienceResponse.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage"))
1142
1168
  GetWebExperienceResponse.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode"))
1143
1169
  GetWebExperienceResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
1170
+ GetWebExperienceResponse.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration"))
1144
1171
  GetWebExperienceResponse.add_member(:authentication_configuration, Shapes::ShapeRef.new(shape: WebExperienceAuthConfiguration, deprecated: true, location_name: "authenticationConfiguration", metadata: {"deprecatedMessage"=>"Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."}))
1145
1172
  GetWebExperienceResponse.add_member(:error, Shapes::ShapeRef.new(shape: ErrorDetail, location_name: "error"))
1146
1173
  GetWebExperienceResponse.struct_class = Types::GetWebExperienceResponse
@@ -1167,6 +1194,14 @@ module Aws::QBusiness
1167
1194
  HookConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
1168
1195
  HookConfiguration.struct_class = Types::HookConfiguration
1169
1196
 
1197
+ IdentityProviderConfiguration.add_member(:saml_configuration, Shapes::ShapeRef.new(shape: SamlProviderConfiguration, location_name: "samlConfiguration"))
1198
+ IdentityProviderConfiguration.add_member(:open_id_connect_configuration, Shapes::ShapeRef.new(shape: OpenIDConnectProviderConfiguration, location_name: "openIDConnectConfiguration"))
1199
+ IdentityProviderConfiguration.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
1200
+ IdentityProviderConfiguration.add_member_subclass(:saml_configuration, Types::IdentityProviderConfiguration::SamlConfiguration)
1201
+ IdentityProviderConfiguration.add_member_subclass(:open_id_connect_configuration, Types::IdentityProviderConfiguration::OpenIdConnectConfiguration)
1202
+ IdentityProviderConfiguration.add_member_subclass(:unknown, Types::IdentityProviderConfiguration::Unknown)
1203
+ IdentityProviderConfiguration.struct_class = Types::IdentityProviderConfiguration
1204
+
1170
1205
  Index.add_member(:display_name, Shapes::ShapeRef.new(shape: IndexName, location_name: "displayName"))
1171
1206
  Index.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, location_name: "indexId"))
1172
1207
  Index.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdAt"))
@@ -1367,6 +1402,10 @@ module Aws::QBusiness
1367
1402
  OAuth2ClientCredentialConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
1368
1403
  OAuth2ClientCredentialConfiguration.struct_class = Types::OAuth2ClientCredentialConfiguration
1369
1404
 
1405
+ OpenIDConnectProviderConfiguration.add_member(:secrets_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "secretsArn"))
1406
+ OpenIDConnectProviderConfiguration.add_member(:secrets_role, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "secretsRole"))
1407
+ OpenIDConnectProviderConfiguration.struct_class = Types::OpenIDConnectProviderConfiguration
1408
+
1370
1409
  PersonalizationConfiguration.add_member(:personalization_control_mode, Shapes::ShapeRef.new(shape: PersonalizationControlMode, required: true, location_name: "personalizationControlMode"))
1371
1410
  PersonalizationConfiguration.struct_class = Types::PersonalizationConfiguration
1372
1411
 
@@ -1484,6 +1523,9 @@ module Aws::QBusiness
1484
1523
  SamlConfiguration.add_member(:user_group_attribute, Shapes::ShapeRef.new(shape: SamlAttribute, location_name: "userGroupAttribute"))
1485
1524
  SamlConfiguration.struct_class = Types::SamlConfiguration
1486
1525
 
1526
+ SamlProviderConfiguration.add_member(:authentication_url, Shapes::ShapeRef.new(shape: SamlAuthenticationUrl, required: true, location_name: "authenticationUrl"))
1527
+ SamlProviderConfiguration.struct_class = Types::SamlProviderConfiguration
1528
+
1487
1529
  SecurityGroupIds.member = Shapes::ShapeRef.new(shape: SecurityGroupId)
1488
1530
 
1489
1531
  ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
@@ -1590,6 +1632,7 @@ module Aws::QBusiness
1590
1632
  UpdateApplicationRequest.add_member(:attachments_configuration, Shapes::ShapeRef.new(shape: AttachmentsConfiguration, location_name: "attachmentsConfiguration"))
1591
1633
  UpdateApplicationRequest.add_member(:q_apps_configuration, Shapes::ShapeRef.new(shape: QAppsConfiguration, location_name: "qAppsConfiguration"))
1592
1634
  UpdateApplicationRequest.add_member(:personalization_configuration, Shapes::ShapeRef.new(shape: PersonalizationConfiguration, location_name: "personalizationConfiguration"))
1635
+ UpdateApplicationRequest.add_member(:auto_subscription_configuration, Shapes::ShapeRef.new(shape: AutoSubscriptionConfiguration, location_name: "autoSubscriptionConfiguration"))
1593
1636
  UpdateApplicationRequest.struct_class = Types::UpdateApplicationRequest
1594
1637
 
1595
1638
  UpdateApplicationResponse.struct_class = Types::UpdateApplicationResponse
@@ -1668,6 +1711,7 @@ module Aws::QBusiness
1668
1711
  UpdateWebExperienceRequest.add_member(:subtitle, Shapes::ShapeRef.new(shape: WebExperienceSubtitle, location_name: "subtitle"))
1669
1712
  UpdateWebExperienceRequest.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage"))
1670
1713
  UpdateWebExperienceRequest.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode"))
1714
+ UpdateWebExperienceRequest.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration"))
1671
1715
  UpdateWebExperienceRequest.struct_class = Types::UpdateWebExperienceRequest
1672
1716
 
1673
1717
  UpdateWebExperienceResponse.struct_class = Types::UpdateWebExperienceResponse
@@ -369,6 +369,11 @@ module Aws::QBusiness
369
369
  # ready to use when the status is `ACTIVE`.
370
370
  # @return [String]
371
371
  #
372
+ # @!attribute [rw] identity_type
373
+ # The authentication type being used by a Amazon Q Business
374
+ # application.
375
+ # @return [String]
376
+ #
372
377
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Application AWS API Documentation
373
378
  #
374
379
  class Application < Struct.new(
@@ -376,7 +381,8 @@ module Aws::QBusiness
376
381
  :application_id,
377
382
  :created_at,
378
383
  :updated_at,
379
- :status)
384
+ :status,
385
+ :identity_type)
380
386
  SENSITIVE = []
381
387
  include Aws::Structure
382
388
  end
@@ -668,6 +674,31 @@ module Aws::QBusiness
668
674
  include Aws::Structure
669
675
  end
670
676
 
677
+ # Subscription configuration information for an Amazon Q Business
678
+ # application using IAM identity federation for user management.
679
+ #
680
+ # @!attribute [rw] auto_subscribe
681
+ # Describes whether automatic subscriptions are enabled for an Amazon
682
+ # Q Business application using IAM identity federation for user
683
+ # management.
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] default_subscription_type
687
+ # Describes the default subscription type assigned to an Amazon Q
688
+ # Business application using IAM identity federation for user
689
+ # management. If the value for `autoSubscribe` is set to `ENABLED` you
690
+ # must select a value for this field.
691
+ # @return [String]
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AutoSubscriptionConfiguration AWS API Documentation
694
+ #
695
+ class AutoSubscriptionConfiguration < Struct.new(
696
+ :auto_subscribe,
697
+ :default_subscription_type)
698
+ SENSITIVE = []
699
+ include Aws::Structure
700
+ end
701
+
671
702
  # Information about the basic authentication credentials used to
672
703
  # configure a plugin.
673
704
  #
@@ -1223,12 +1254,26 @@ module Aws::QBusiness
1223
1254
  # access your Amazon CloudWatch logs and metrics.
1224
1255
  # @return [String]
1225
1256
  #
1257
+ # @!attribute [rw] identity_type
1258
+ # The authentication type being used by a Amazon Q Business
1259
+ # application.
1260
+ # @return [String]
1261
+ #
1262
+ # @!attribute [rw] iam_identity_provider_arn
1263
+ # The Amazon Resource Name (ARN) of an identity provider being used by
1264
+ # an Amazon Q Business application.
1265
+ # @return [String]
1266
+ #
1226
1267
  # @!attribute [rw] identity_center_instance_arn
1227
1268
  # The Amazon Resource Name (ARN) of the IAM Identity Center instance
1228
1269
  # you are either creating for—or connecting to—your Amazon Q Business
1229
1270
  # application.
1230
1271
  # @return [String]
1231
1272
  #
1273
+ # @!attribute [rw] client_ids_for_oidc
1274
+ # The OIDC client ID for a Amazon Q Business application.
1275
+ # @return [Array<String>]
1276
+ #
1232
1277
  # @!attribute [rw] description
1233
1278
  # A description for the Amazon Q Business application.
1234
1279
  # @return [String]
@@ -1277,7 +1322,10 @@ module Aws::QBusiness
1277
1322
  class CreateApplicationRequest < Struct.new(
1278
1323
  :display_name,
1279
1324
  :role_arn,
1325
+ :identity_type,
1326
+ :iam_identity_provider_arn,
1280
1327
  :identity_center_instance_arn,
1328
+ :client_ids_for_oidc,
1281
1329
  :description,
1282
1330
  :encryption_configuration,
1283
1331
  :tags,
@@ -1321,13 +1369,33 @@ module Aws::QBusiness
1321
1369
  # @return [String]
1322
1370
  #
1323
1371
  # @!attribute [rw] configuration
1324
- # Configuration information to connect to your data source repository.
1325
- # For configuration templates for your specific data source, see
1326
- # [Supported connectors][1].
1372
+ # Configuration information to connect your data source repository to
1373
+ # Amazon Q Business. Use this parameter to provide a JSON schema with
1374
+ # configuration information specific to your data source connector.
1375
+ #
1376
+ # Each data source has a JSON schema provided by Amazon Q Business
1377
+ # that you must use. For example, the Amazon S3 and Web Crawler
1378
+ # connectors require the following JSON schemas:
1379
+ #
1380
+ # * [Amazon S3 JSON schema][1]
1381
+ #
1382
+ # * [Web Crawler JSON schema][2]
1383
+ #
1384
+ # You can find configuration templates for your specific data source
1385
+ # using the following steps:
1386
+ #
1387
+ # 1. Navigate to the [Supported connectors][3] page in the Amazon Q
1388
+ # Business User Guide, and select the data source of your choice.
1327
1389
  #
1390
+ # 2. Then, from your specific data source connector page, select
1391
+ # **Using the API**. You will find the JSON schema for your data
1392
+ # source, including parameter descriptions, in this section.
1328
1393
  #
1329
1394
  #
1330
- # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
1395
+ #
1396
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html
1397
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html
1398
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
1331
1399
  # @return [Hash,Array,String,Numeric,Boolean]
1332
1400
  #
1333
1401
  # @!attribute [rw] vpc_configuration
@@ -1706,6 +1774,13 @@ module Aws::QBusiness
1706
1774
  # @!attribute [rw] role_arn
1707
1775
  # The Amazon Resource Name (ARN) of the service role attached to your
1708
1776
  # web experience.
1777
+ #
1778
+ # <note markdown="1"> You must provide this value if you're using IAM Identity Center to
1779
+ # manage end user access to your application. If you're using legacy
1780
+ # identity management to manage user access, you don't need to
1781
+ # provide this value.
1782
+ #
1783
+ # </note>
1709
1784
  # @return [String]
1710
1785
  #
1711
1786
  # @!attribute [rw] tags
@@ -1724,6 +1799,11 @@ module Aws::QBusiness
1724
1799
  # not need to pass this option.
1725
1800
  # @return [String]
1726
1801
  #
1802
+ # @!attribute [rw] identity_provider_configuration
1803
+ # Information about the identity provider (IdP) used to authenticate
1804
+ # end users of an Amazon Q Business web experience.
1805
+ # @return [Types::IdentityProviderConfiguration]
1806
+ #
1727
1807
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperienceRequest AWS API Documentation
1728
1808
  #
1729
1809
  class CreateWebExperienceRequest < Struct.new(
@@ -1734,7 +1814,8 @@ module Aws::QBusiness
1734
1814
  :sample_prompts_control_mode,
1735
1815
  :role_arn,
1736
1816
  :tags,
1737
- :client_token)
1817
+ :client_token,
1818
+ :identity_provider_configuration)
1738
1819
  SENSITIVE = []
1739
1820
  include Aws::Structure
1740
1821
  end
@@ -2858,6 +2939,16 @@ module Aws::QBusiness
2858
2939
  # The Amazon Resource Name (ARN) of the Amazon Q Business application.
2859
2940
  # @return [String]
2860
2941
  #
2942
+ # @!attribute [rw] identity_type
2943
+ # The authentication type being used by a Amazon Q Business
2944
+ # application.
2945
+ # @return [String]
2946
+ #
2947
+ # @!attribute [rw] iam_identity_provider_arn
2948
+ # The Amazon Resource Name (ARN) of an identity provider being used by
2949
+ # an Amazon Q Business application.
2950
+ # @return [String]
2951
+ #
2861
2952
  # @!attribute [rw] identity_center_application_arn
2862
2953
  # The Amazon Resource Name (ARN) of the AWS IAM Identity Center
2863
2954
  # instance attached to your Amazon Q Business application.
@@ -2917,12 +3008,23 @@ module Aws::QBusiness
2917
3008
  # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html
2918
3009
  # @return [Types::PersonalizationConfiguration]
2919
3010
  #
3011
+ # @!attribute [rw] auto_subscription_configuration
3012
+ # Settings for auto-subscription behavior for this application. This
3013
+ # is only applicable to SAML and OIDC applications.
3014
+ # @return [Types::AutoSubscriptionConfiguration]
3015
+ #
3016
+ # @!attribute [rw] client_ids_for_oidc
3017
+ # The OIDC client ID for a Amazon Q Business application.
3018
+ # @return [Array<String>]
3019
+ #
2920
3020
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationResponse AWS API Documentation
2921
3021
  #
2922
3022
  class GetApplicationResponse < Struct.new(
2923
3023
  :display_name,
2924
3024
  :application_id,
2925
3025
  :application_arn,
3026
+ :identity_type,
3027
+ :iam_identity_provider_arn,
2926
3028
  :identity_center_application_arn,
2927
3029
  :role_arn,
2928
3030
  :status,
@@ -2933,7 +3035,9 @@ module Aws::QBusiness
2933
3035
  :error,
2934
3036
  :attachments_configuration,
2935
3037
  :q_apps_configuration,
2936
- :personalization_configuration)
3038
+ :personalization_configuration,
3039
+ :auto_subscription_configuration,
3040
+ :client_ids_for_oidc)
2937
3041
  SENSITIVE = []
2938
3042
  include Aws::Structure
2939
3043
  end
@@ -3544,6 +3648,11 @@ module Aws::QBusiness
3544
3648
  # web experience.
3545
3649
  # @return [String]
3546
3650
  #
3651
+ # @!attribute [rw] identity_provider_configuration
3652
+ # Information about the identity provider (IdP) used to authenticate
3653
+ # end users of an Amazon Q Business web experience.
3654
+ # @return [Types::IdentityProviderConfiguration]
3655
+ #
3547
3656
  # @!attribute [rw] authentication_configuration
3548
3657
  # The authentication configuration information for your Amazon Q
3549
3658
  # Business web experience.
@@ -3570,6 +3679,7 @@ module Aws::QBusiness
3570
3679
  :welcome_message,
3571
3680
  :sample_prompts_control_mode,
3572
3681
  :role_arn,
3682
+ :identity_provider_configuration,
3573
3683
  :authentication_configuration,
3574
3684
  :error)
3575
3685
  SENSITIVE = []
@@ -3706,6 +3816,39 @@ module Aws::QBusiness
3706
3816
  include Aws::Structure
3707
3817
  end
3708
3818
 
3819
+ # Provides information about the identity provider (IdP) used to
3820
+ # authenticate end users of an Amazon Q Business web experience.
3821
+ #
3822
+ # @note IdentityProviderConfiguration is a union - when making an API calls you must set exactly one of the members.
3823
+ #
3824
+ # @note IdentityProviderConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentityProviderConfiguration corresponding to the set member.
3825
+ #
3826
+ # @!attribute [rw] saml_configuration
3827
+ # Information about the SAML 2.0-compliant identity provider (IdP)
3828
+ # used to authenticate end users of an Amazon Q Business web
3829
+ # experience.
3830
+ # @return [Types::SamlProviderConfiguration]
3831
+ #
3832
+ # @!attribute [rw] open_id_connect_configuration
3833
+ # Information about the OIDC-compliant identity provider (IdP) used to
3834
+ # authenticate end users of an Amazon Q Business web experience.
3835
+ # @return [Types::OpenIDConnectProviderConfiguration]
3836
+ #
3837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/IdentityProviderConfiguration AWS API Documentation
3838
+ #
3839
+ class IdentityProviderConfiguration < Struct.new(
3840
+ :saml_configuration,
3841
+ :open_id_connect_configuration,
3842
+ :unknown)
3843
+ SENSITIVE = []
3844
+ include Aws::Structure
3845
+ include Aws::Structure::Union
3846
+
3847
+ class SamlConfiguration < IdentityProviderConfiguration; end
3848
+ class OpenIdConnectConfiguration < IdentityProviderConfiguration; end
3849
+ class Unknown < IdentityProviderConfiguration; end
3850
+ end
3851
+
3709
3852
  # Summary information for your Amazon Q Business index.
3710
3853
  #
3711
3854
  # @!attribute [rw] display_name
@@ -4731,6 +4874,28 @@ module Aws::QBusiness
4731
4874
  include Aws::Structure
4732
4875
  end
4733
4876
 
4877
+ # Information about the OIDC-compliant identity provider (IdP) used to
4878
+ # authenticate end users of an Amazon Q Business web experience.
4879
+ #
4880
+ # @!attribute [rw] secrets_arn
4881
+ # The Amazon Resource Name (ARN) of a Secrets Manager secret
4882
+ # containing the OIDC client secret.
4883
+ # @return [String]
4884
+ #
4885
+ # @!attribute [rw] secrets_role
4886
+ # An IAM role with permissions to access KMS to decrypt the Secrets
4887
+ # Manager secret containing your OIDC client secret.
4888
+ # @return [String]
4889
+ #
4890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/OpenIDConnectProviderConfiguration AWS API Documentation
4891
+ #
4892
+ class OpenIDConnectProviderConfiguration < Struct.new(
4893
+ :secrets_arn,
4894
+ :secrets_role)
4895
+ SENSITIVE = []
4896
+ include Aws::Structure
4897
+ end
4898
+
4734
4899
  # Configuration information about chat response personalization. For
4735
4900
  # more information, see [Personalizing chat responses][1].
4736
4901
  #
@@ -4993,12 +5158,6 @@ module Aws::QBusiness
4993
5158
  # group. For example, the group "Company" includes the user "CEO"
4994
5159
  # and the sub groups "Research", "Engineering", and "Sales and
4995
5160
  # Marketing".
4996
- #
4997
- # If you have more than 1000 users and/or sub groups for a single
4998
- # group, you need to provide the path to the S3 file that lists your
4999
- # users and sub groups for a group. Your sub groups can contain more
5000
- # than 1000 users, but the list of sub groups that belong to a group
5001
- # (and/or users) must be no more than 1000.
5002
5161
  # @return [String]
5003
5162
  #
5004
5163
  # @!attribute [rw] data_source_id
@@ -5263,6 +5422,22 @@ module Aws::QBusiness
5263
5422
  include Aws::Structure
5264
5423
  end
5265
5424
 
5425
+ # Information about the SAML 2.0-compliant identity provider (IdP) used
5426
+ # to authenticate end users of an Amazon Q Business web experience.
5427
+ #
5428
+ # @!attribute [rw] authentication_url
5429
+ # The URL where Amazon Q Business end users will be redirected for
5430
+ # authentication.
5431
+ # @return [String]
5432
+ #
5433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SamlProviderConfiguration AWS API Documentation
5434
+ #
5435
+ class SamlProviderConfiguration < Struct.new(
5436
+ :authentication_url)
5437
+ SENSITIVE = []
5438
+ include Aws::Structure
5439
+ end
5440
+
5266
5441
  # You have exceeded the set limits for your Amazon Q Business service.
5267
5442
  #
5268
5443
  # @!attribute [rw] message
@@ -5739,6 +5914,12 @@ module Aws::QBusiness
5739
5914
  # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html
5740
5915
  # @return [Types::PersonalizationConfiguration]
5741
5916
  #
5917
+ # @!attribute [rw] auto_subscription_configuration
5918
+ # An option to enable updating the default subscription type assigned
5919
+ # to an Amazon Q Business application using IAM identity federation
5920
+ # for user management.
5921
+ # @return [Types::AutoSubscriptionConfiguration]
5922
+ #
5742
5923
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplicationRequest AWS API Documentation
5743
5924
  #
5744
5925
  class UpdateApplicationRequest < Struct.new(
@@ -5749,7 +5930,8 @@ module Aws::QBusiness
5749
5930
  :role_arn,
5750
5931
  :attachments_configuration,
5751
5932
  :q_apps_configuration,
5752
- :personalization_configuration)
5933
+ :personalization_configuration,
5934
+ :auto_subscription_configuration)
5753
5935
  SENSITIVE = []
5754
5936
  include Aws::Structure
5755
5937
  end
@@ -6107,6 +6289,11 @@ module Aws::QBusiness
6107
6289
  # for an end user.
6108
6290
  # @return [String]
6109
6291
  #
6292
+ # @!attribute [rw] identity_provider_configuration
6293
+ # Information about the identity provider (IdP) used to authenticate
6294
+ # end users of an Amazon Q Business web experience.
6295
+ # @return [Types::IdentityProviderConfiguration]
6296
+ #
6110
6297
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
6111
6298
  #
6112
6299
  class UpdateWebExperienceRequest < Struct.new(
@@ -6117,7 +6304,8 @@ module Aws::QBusiness
6117
6304
  :title,
6118
6305
  :subtitle,
6119
6306
  :welcome_message,
6120
- :sample_prompts_control_mode)
6307
+ :sample_prompts_control_mode,
6308
+ :identity_provider_configuration)
6121
6309
  SENSITIVE = []
6122
6310
  include Aws::Structure
6123
6311
  end
@@ -55,6 +55,6 @@ require_relative 'aws-sdk-qbusiness/event_streams'
55
55
  # @!group service
56
56
  module Aws::QBusiness
57
57
 
58
- GEM_VERSION = '1.11.0'
58
+ GEM_VERSION = '1.12.0'
59
59
 
60
60
  end
data/sig/client.rbs CHANGED
@@ -353,7 +353,10 @@ module Aws
353
353
  def create_application: (
354
354
  display_name: ::String,
355
355
  ?role_arn: ::String,
356
+ ?identity_type: ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC"),
357
+ ?iam_identity_provider_arn: ::String,
356
358
  ?identity_center_instance_arn: ::String,
359
+ ?client_ids_for_oidc: Array[::String],
357
360
  ?description: ::String,
358
361
  ?encryption_configuration: {
359
362
  kms_key_id: ::String?
@@ -615,7 +618,16 @@ module Aws
615
618
  value: ::String
616
619
  },
617
620
  ],
618
- ?client_token: ::String
621
+ ?client_token: ::String,
622
+ ?identity_provider_configuration: {
623
+ saml_configuration: {
624
+ authentication_url: ::String
625
+ }?,
626
+ open_id_connect_configuration: {
627
+ secrets_arn: ::String,
628
+ secrets_role: ::String
629
+ }?
630
+ }
619
631
  ) -> _CreateWebExperienceResponseSuccess
620
632
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateWebExperienceResponseSuccess
621
633
 
@@ -726,6 +738,8 @@ module Aws
726
738
  def display_name: () -> ::String
727
739
  def application_id: () -> ::String
728
740
  def application_arn: () -> ::String
741
+ def identity_type: () -> ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC")
742
+ def iam_identity_provider_arn: () -> ::String
729
743
  def identity_center_application_arn: () -> ::String
730
744
  def role_arn: () -> ::String
731
745
  def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
@@ -736,6 +750,8 @@ module Aws
736
750
  def attachments_configuration: () -> Types::AppliedAttachmentsConfiguration
737
751
  def q_apps_configuration: () -> Types::QAppsConfiguration
738
752
  def personalization_configuration: () -> Types::PersonalizationConfiguration
753
+ def auto_subscription_configuration: () -> Types::AutoSubscriptionConfiguration
754
+ def client_ids_for_oidc: () -> ::Array[::String]
739
755
  end
740
756
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_application-instance_method
741
757
  def get_application: (
@@ -888,6 +904,7 @@ module Aws
888
904
  def welcome_message: () -> ::String
889
905
  def sample_prompts_control_mode: () -> ("ENABLED" | "DISABLED")
890
906
  def role_arn: () -> ::String
907
+ def identity_provider_configuration: () -> Types::IdentityProviderConfiguration
891
908
  def authentication_configuration: () -> Types::WebExperienceAuthConfiguration
892
909
  end
893
910
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_web_experience-instance_method
@@ -1172,6 +1189,10 @@ module Aws
1172
1189
  },
1173
1190
  ?personalization_configuration: {
1174
1191
  personalization_control_mode: ("ENABLED" | "DISABLED")
1192
+ },
1193
+ ?auto_subscription_configuration: {
1194
+ auto_subscribe: ("ENABLED" | "DISABLED"),
1195
+ default_subscription_type: ("Q_LITE" | "Q_BUSINESS")?
1175
1196
  }
1176
1197
  ) -> _UpdateApplicationResponseSuccess
1177
1198
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateApplicationResponseSuccess
@@ -1480,7 +1501,16 @@ module Aws
1480
1501
  ?title: ::String,
1481
1502
  ?subtitle: ::String,
1482
1503
  ?welcome_message: ::String,
1483
- ?sample_prompts_control_mode: ("ENABLED" | "DISABLED")
1504
+ ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"),
1505
+ ?identity_provider_configuration: {
1506
+ saml_configuration: {
1507
+ authentication_url: ::String
1508
+ }?,
1509
+ open_id_connect_configuration: {
1510
+ secrets_arn: ::String,
1511
+ secrets_role: ::String
1512
+ }?
1513
+ }
1484
1514
  ) -> _UpdateWebExperienceResponseSuccess
1485
1515
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateWebExperienceResponseSuccess
1486
1516
  end
data/sig/types.rbs CHANGED
@@ -103,6 +103,7 @@ module Aws::QBusiness
103
103
  attr_accessor created_at: ::Time
104
104
  attr_accessor updated_at: ::Time
105
105
  attr_accessor status: ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
106
+ attr_accessor identity_type: ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC")
106
107
  SENSITIVE: []
107
108
  end
108
109
 
@@ -176,6 +177,12 @@ module Aws::QBusiness
176
177
  SENSITIVE: []
177
178
  end
178
179
 
180
+ class AutoSubscriptionConfiguration
181
+ attr_accessor auto_subscribe: ("ENABLED" | "DISABLED")
182
+ attr_accessor default_subscription_type: ("Q_LITE" | "Q_BUSINESS")
183
+ SENSITIVE: []
184
+ end
185
+
179
186
  class BasicAuthConfiguration
180
187
  attr_accessor secret_arn: ::String
181
188
  attr_accessor role_arn: ::String
@@ -313,7 +320,10 @@ module Aws::QBusiness
313
320
  class CreateApplicationRequest
314
321
  attr_accessor display_name: ::String
315
322
  attr_accessor role_arn: ::String
323
+ attr_accessor identity_type: ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC")
324
+ attr_accessor iam_identity_provider_arn: ::String
316
325
  attr_accessor identity_center_instance_arn: ::String
326
+ attr_accessor client_ids_for_oidc: ::Array[::String]
317
327
  attr_accessor description: ::String
318
328
  attr_accessor encryption_configuration: Types::EncryptionConfiguration
319
329
  attr_accessor tags: ::Array[Types::Tag]
@@ -424,6 +434,7 @@ module Aws::QBusiness
424
434
  attr_accessor role_arn: ::String
425
435
  attr_accessor tags: ::Array[Types::Tag]
426
436
  attr_accessor client_token: ::String
437
+ attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration
427
438
  SENSITIVE: []
428
439
  end
429
440
 
@@ -739,6 +750,8 @@ module Aws::QBusiness
739
750
  attr_accessor display_name: ::String
740
751
  attr_accessor application_id: ::String
741
752
  attr_accessor application_arn: ::String
753
+ attr_accessor identity_type: ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC")
754
+ attr_accessor iam_identity_provider_arn: ::String
742
755
  attr_accessor identity_center_application_arn: ::String
743
756
  attr_accessor role_arn: ::String
744
757
  attr_accessor status: ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
@@ -750,6 +763,8 @@ module Aws::QBusiness
750
763
  attr_accessor attachments_configuration: Types::AppliedAttachmentsConfiguration
751
764
  attr_accessor q_apps_configuration: Types::QAppsConfiguration
752
765
  attr_accessor personalization_configuration: Types::PersonalizationConfiguration
766
+ attr_accessor auto_subscription_configuration: Types::AutoSubscriptionConfiguration
767
+ attr_accessor client_ids_for_oidc: ::Array[::String]
753
768
  SENSITIVE: []
754
769
  end
755
770
 
@@ -905,6 +920,7 @@ module Aws::QBusiness
905
920
  attr_accessor welcome_message: ::String
906
921
  attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED")
907
922
  attr_accessor role_arn: ::String
923
+ attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration
908
924
  attr_accessor authentication_configuration: Types::WebExperienceAuthConfiguration
909
925
  attr_accessor error: Types::ErrorDetail
910
926
  SENSITIVE: []
@@ -936,6 +952,20 @@ module Aws::QBusiness
936
952
  SENSITIVE: []
937
953
  end
938
954
 
955
+ class IdentityProviderConfiguration
956
+ attr_accessor saml_configuration: Types::SamlProviderConfiguration
957
+ attr_accessor open_id_connect_configuration: Types::OpenIDConnectProviderConfiguration
958
+ attr_accessor unknown: untyped
959
+ SENSITIVE: []
960
+
961
+ class SamlConfiguration < IdentityProviderConfiguration
962
+ end
963
+ class OpenIdConnectConfiguration < IdentityProviderConfiguration
964
+ end
965
+ class Unknown < IdentityProviderConfiguration
966
+ end
967
+ end
968
+
939
969
  class Index
940
970
  attr_accessor display_name: ::String
941
971
  attr_accessor index_id: ::String
@@ -1206,6 +1236,12 @@ module Aws::QBusiness
1206
1236
  SENSITIVE: []
1207
1237
  end
1208
1238
 
1239
+ class OpenIDConnectProviderConfiguration
1240
+ attr_accessor secrets_arn: ::String
1241
+ attr_accessor secrets_role: ::String
1242
+ SENSITIVE: []
1243
+ end
1244
+
1209
1245
  class PersonalizationConfiguration
1210
1246
  attr_accessor personalization_control_mode: ("ENABLED" | "DISABLED")
1211
1247
  SENSITIVE: []
@@ -1367,6 +1403,11 @@ module Aws::QBusiness
1367
1403
  SENSITIVE: []
1368
1404
  end
1369
1405
 
1406
+ class SamlProviderConfiguration
1407
+ attr_accessor authentication_url: ::String
1408
+ SENSITIVE: []
1409
+ end
1410
+
1370
1411
  class ServiceQuotaExceededException
1371
1412
  attr_accessor message: ::String
1372
1413
  attr_accessor resource_id: ::String
@@ -1496,6 +1537,7 @@ module Aws::QBusiness
1496
1537
  attr_accessor attachments_configuration: Types::AttachmentsConfiguration
1497
1538
  attr_accessor q_apps_configuration: Types::QAppsConfiguration
1498
1539
  attr_accessor personalization_configuration: Types::PersonalizationConfiguration
1540
+ attr_accessor auto_subscription_configuration: Types::AutoSubscriptionConfiguration
1499
1541
  SENSITIVE: []
1500
1542
  end
1501
1543
 
@@ -1596,6 +1638,7 @@ module Aws::QBusiness
1596
1638
  attr_accessor subtitle: ::String
1597
1639
  attr_accessor welcome_message: ::String
1598
1640
  attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED")
1641
+ attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration
1599
1642
  SENSITIVE: []
1600
1643
  end
1601
1644
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-qbusiness
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.11.0
4
+ version: 1.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-05 00:00:00.000000000 Z
11
+ date: 2024-08-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core