Module: Aws::QBusiness::Types

Defined in:
lib/aws-sdk-qbusiness/types.rb

Defined Under Namespace

Classes: APISchema, AccessConfiguration, AccessControl, AccessDeniedException, ActionConfiguration, ActionExecution, ActionExecutionEvent, ActionExecutionPayloadField, ActionFilterConfiguration, ActionReview, ActionReviewEvent, ActionReviewPayloadField, ActionReviewPayloadFieldAllowedValue, ActionSummary, Application, AppliedAttachmentsConfiguration, AppliedCreatorModeConfiguration, AppliedOrchestrationConfiguration, AssociatePermissionRequest, AssociatePermissionResponse, Attachment, AttachmentInput, AttachmentInputEvent, AttachmentOutput, AttachmentsConfiguration, AttributeFilter, AuthChallengeRequest, AuthChallengeRequestEvent, AuthChallengeResponse, AuthChallengeResponseEvent, AutoSubscriptionConfiguration, BasicAuthConfiguration, BatchDeleteDocumentRequest, BatchDeleteDocumentResponse, BatchPutDocumentRequest, BatchPutDocumentResponse, BlockedPhrasesConfiguration, BlockedPhrasesConfigurationUpdate, BrowserExtensionConfiguration, CancelSubscriptionRequest, CancelSubscriptionResponse, ChatInput, ChatInputStream, ChatModeConfiguration, ChatOutput, ChatOutputStream, ChatSyncInput, ChatSyncOutput, ConfigurationEvent, ConflictException, ContentBlockerRule, ContentRetrievalRule, ContentSource, Conversation, ConversationSource, CopyFromSource, CreateApplicationRequest, CreateApplicationResponse, CreateDataAccessorRequest, CreateDataAccessorResponse, CreateDataSourceRequest, CreateDataSourceResponse, CreateIndexRequest, CreateIndexResponse, CreatePluginRequest, CreatePluginResponse, CreateRetrieverRequest, CreateRetrieverResponse, CreateSubscriptionRequest, CreateSubscriptionResponse, CreateUserRequest, CreateUserResponse, CreateWebExperienceRequest, CreateWebExperienceResponse, CreatorModeConfiguration, CustomPluginConfiguration, CustomizationConfiguration, DataAccessor, DataSource, DataSourceSyncJob, DataSourceSyncJobMetrics, DataSourceVpcConfiguration, DateAttributeBoostingConfiguration, DeleteApplicationRequest, DeleteApplicationResponse, DeleteAttachmentRequest, DeleteAttachmentResponse, DeleteChatControlsConfigurationRequest, DeleteChatControlsConfigurationResponse, DeleteConversationRequest, DeleteConversationResponse, DeleteDataAccessorRequest, DeleteDataAccessorResponse, DeleteDataSourceRequest, DeleteDataSourceResponse, DeleteDocument, DeleteGroupRequest, DeleteGroupResponse, DeleteIndexRequest, DeleteIndexResponse, DeletePluginRequest, DeletePluginResponse, DeleteRetrieverRequest, DeleteRetrieverResponse, DeleteUserRequest, DeleteUserResponse, DeleteWebExperienceRequest, DeleteWebExperienceResponse, DisassociatePermissionRequest, DisassociatePermissionResponse, Document, DocumentAttribute, DocumentAttributeBoostingConfiguration, DocumentAttributeCondition, DocumentAttributeConfiguration, DocumentAttributeTarget, DocumentAttributeValue, DocumentContent, DocumentDetails, DocumentEnrichmentConfiguration, EligibleDataSource, EncryptionConfiguration, EndOfInputEvent, ErrorDetail, ExternalResourceException, FailedAttachmentEvent, FailedDocument, GetApplicationRequest, GetApplicationResponse, GetChatControlsConfigurationRequest, GetChatControlsConfigurationResponse, GetDataAccessorRequest, GetDataAccessorResponse, GetDataSourceRequest, GetDataSourceResponse, GetGroupRequest, GetGroupResponse, GetIndexRequest, GetIndexResponse, GetMediaRequest, GetMediaResponse, GetPluginRequest, GetPluginResponse, GetPolicyRequest, GetPolicyResponse, GetRetrieverRequest, GetRetrieverResponse, GetUserRequest, GetUserResponse, GetWebExperienceRequest, GetWebExperienceResponse, GroupMembers, GroupStatusDetail, GroupSummary, HookConfiguration, IdcAuthConfiguration, IdentityProviderConfiguration, ImageExtractionConfiguration, Index, IndexCapacityConfiguration, IndexStatistics, InlineDocumentEnrichmentConfiguration, InternalServerException, KendraIndexConfiguration, LicenseNotFoundException, ListApplicationsRequest, ListApplicationsResponse, ListAttachmentsRequest, ListAttachmentsResponse, ListConversationsRequest, ListConversationsResponse, ListDataAccessorsRequest, ListDataAccessorsResponse, ListDataSourceSyncJobsRequest, ListDataSourceSyncJobsResponse, ListDataSourcesRequest, ListDataSourcesResponse, ListDocumentsRequest, ListDocumentsResponse, ListGroupsRequest, ListGroupsResponse, ListIndicesRequest, ListIndicesResponse, ListMessagesRequest, ListMessagesResponse, ListPluginActionsRequest, ListPluginActionsResponse, ListPluginTypeActionsRequest, ListPluginTypeActionsResponse, ListPluginTypeMetadataRequest, ListPluginTypeMetadataResponse, ListPluginsRequest, ListPluginsResponse, ListRetrieversRequest, ListRetrieversResponse, ListSubscriptionsRequest, ListSubscriptionsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ListWebExperiencesRequest, ListWebExperiencesResponse, MediaExtractionConfiguration, MediaTooLargeException, MemberGroup, MemberUser, Message, MessageUsefulnessFeedback, MetadataEvent, NativeIndexConfiguration, NoAuthConfiguration, NumberAttributeBoostingConfiguration, OAuth2ClientCredentialConfiguration, OpenIDConnectProviderConfiguration, OrchestrationConfiguration, PersonalizationConfiguration, Plugin, PluginAuthConfiguration, PluginConfiguration, PluginTypeMetadataSummary, Principal, PrincipalGroup, PrincipalUser, PutFeedbackRequest, PutGroupRequest, PutGroupResponse, QAppsConfiguration, QuickSightConfiguration, RelevantContent, ResourceNotFoundException, Retriever, RetrieverConfiguration, RetrieverContentSource, Rule, RuleConfiguration, S3, SamlConfiguration, SamlProviderConfiguration, ScoreAttributes, SearchRelevantContentRequest, SearchRelevantContentResponse, ServiceQuotaExceededException, SnippetExcerpt, SourceAttribution, StartDataSourceSyncJobRequest, StartDataSourceSyncJobResponse, StopDataSourceSyncJobRequest, StopDataSourceSyncJobResponse, StringAttributeBoostingConfiguration, StringListAttributeBoostingConfiguration, Subscription, SubscriptionDetails, SubscriptionPrincipal, Tag, TagResourceRequest, TagResourceResponse, TextDocumentStatistics, TextInputEvent, TextOutputEvent, TextSegment, ThrottlingException, TopicConfiguration, UntagResourceRequest, UntagResourceResponse, UpdateApplicationRequest, UpdateApplicationResponse, UpdateChatControlsConfigurationRequest, UpdateChatControlsConfigurationResponse, UpdateDataAccessorRequest, UpdateDataAccessorResponse, UpdateDataSourceRequest, UpdateDataSourceResponse, UpdateIndexRequest, UpdateIndexResponse, UpdatePluginRequest, UpdatePluginResponse, UpdateRetrieverRequest, UpdateRetrieverResponse, UpdateSubscriptionRequest, UpdateSubscriptionResponse, UpdateUserRequest, UpdateUserResponse, UpdateWebExperienceRequest, UpdateWebExperienceResponse, UserAlias, UsersAndGroups, ValidationException, ValidationExceptionField, WebExperience, WebExperienceAuthConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#attachment ⇒ Types::AttachmentOutput

The details of a file uploaded during chat.

Returns:



679
680
681
682
683
684
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 679

class AttachmentInputEvent < Struct.new(
  :attachment,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_filter ⇒ Types::AttributeFilter

Enables filtering of responses based on document attributes or metadata fields.

Returns:



1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1465

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_url ⇒ String

The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.

Returns:

  • (String) 


866
867
868
869
870
871
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 866

class AuthChallengeRequestEvent < Struct.new(
  :authorization_url,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#basic_auth_configuration ⇒ Types::BasicAuthConfiguration

Information about the basic authentication credentials used to configure a plugin.

Returns:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6321

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#blob ⇒ String

The contents of the document. Documents passed to the ‘blob` parameter must be base64 encoded. Your code might not need to encode the document file bytes if you’re using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

Returns:

  • (String) 


3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3395

class DocumentContent < Struct.new(
  :blob,
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Blob < DocumentContent; end
  class S3 < DocumentContent; end
  class Unknown < DocumentContent; end
end

#chat_mode ⇒ String

The chat modes available to an Amazon Q Business end user.

  • ‘RETRIEVAL_MODE` - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

  • ‘CREATOR_MODE` - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

  • ‘PLUGIN_MODE` - By selecting this mode, users can choose to use plugins in chat.

For more information, see [Admin controls and guardrails], [Plugins], and [Conversation settings].

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html [2]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html [3]: docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope

Returns:

  • (String) 


1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1465

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#chat_mode_configuration ⇒ Types::ChatModeConfiguration

Configuration information for Amazon Q Business conversation modes.

For more information, see [Admin controls and guardrails] and [Conversation settings].

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html [2]: docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope

Returns:



1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1465

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#content_blocker_rule ⇒ Types::ContentBlockerRule

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

Returns:



6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6801

class RuleConfiguration < Struct.new(
  :content_blocker_rule,
  :content_retrieval_rule,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ContentBlockerRule < RuleConfiguration; end
  class ContentRetrievalRule < RuleConfiguration; end
  class Unknown < RuleConfiguration; end
end

#content_retrieval_rule ⇒ Types::ContentRetrievalRule

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

Returns:



6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6801

class RuleConfiguration < Struct.new(
  :content_blocker_rule,
  :content_retrieval_rule,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ContentBlockerRule < RuleConfiguration; end
  class ContentRetrievalRule < RuleConfiguration; end
  class Unknown < RuleConfiguration; end
end

#conversation ⇒ Types::ConversationSource

A reference to an attachment in an existing conversation.

Returns:



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1611

class CopyFromSource < Struct.new(
  :conversation,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Conversation < CopyFromSource; end
  class Unknown < CopyFromSource; end
end

#conversation_id ⇒ String

The identifier of the conversation with which the text output event is associated.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#date_configuration ⇒ Types::DateAttributeBoostingConfiguration

Provides information on boosting ‘DATE` type document attributes.

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3170

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#date_value ⇒ Time

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Returns:

  • (Time) 


3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3359

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#final_text_message ⇒ String

The final text output message generated by the system.

Returns:

  • (String) 


6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6072

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#group ⇒ String

The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6401

class Principal < Struct.new(
  :user,
  :group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class User < Principal; end
  class Group < Principal; end
  class Unknown < Principal; end
end

#idc_auth_configuration ⇒ Types::IdcAuthConfiguration

Information about the IAM Identity Center Application used to configure authentication for a plugin.

Returns:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6321

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#kendra_index_configuration ⇒ Types::KendraIndexConfiguration

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

Returns:



6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6726

class RetrieverConfiguration < Struct.new(
  :native_index_configuration,
  :kendra_index_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NativeIndexConfiguration < RetrieverConfiguration; end
  class KendraIndexConfiguration < RetrieverConfiguration; end
  class Unknown < RetrieverConfiguration; end
end

#long_value ⇒ Integer

A long integer value.

Returns:

  • (Integer) 


3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3359

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#native_index_configuration ⇒ Types::NativeIndexConfiguration

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

Returns:



6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6726

class RetrieverConfiguration < Struct.new(
  :native_index_configuration,
  :kendra_index_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NativeIndexConfiguration < RetrieverConfiguration; end
  class KendraIndexConfiguration < RetrieverConfiguration; end
  class Unknown < RetrieverConfiguration; end
end

#no_auth_configuration ⇒ Types::NoAuthConfiguration

Information about invoking a custom plugin without any authentication.

Returns:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6321

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#number_configuration ⇒ Types::NumberAttributeBoostingConfiguration

Provides information on boosting ‘NUMBER` type document attributes.

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3170

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#o_auth_2_client_credential_configuration ⇒ Types::OAuth2ClientCredentialConfiguration

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Returns:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6321

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#open_id_connect_configuration ⇒ Types::OpenIDConnectProviderConfiguration

Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Returns:



4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 4797

class IdentityProviderConfiguration < Struct.new(
  :saml_configuration,
  :open_id_connect_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SamlConfiguration < IdentityProviderConfiguration; end
  class OpenIdConnectConfiguration < IdentityProviderConfiguration; end
  class Unknown < IdentityProviderConfiguration; end
end

#payload ⇒ Hash<String,Types::ActionReviewPayloadField>

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 40

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#payload_field_name_separator ⇒ String

A string used to retain information about the hierarchical contexts within an action review event payload.

Returns:

  • (String) 


177
178
179
180
181
182
183
184
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 177

class ActionExecutionEvent < Struct.new(
  :plugin_id,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_configuration ⇒ Types::PluginConfiguration

Configuration information required to invoke chat in ‘PLUGIN_MODE`.

Returns:



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1229

class ChatModeConfiguration < Struct.new(
  :plugin_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class PluginConfiguration < ChatModeConfiguration; end
  class Unknown < ChatModeConfiguration; end
end

#plugin_id ⇒ String

The identifier of the plugin associated with the action review event.

Returns:

  • (String) 


177
178
179
180
181
182
183
184
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 177

class ActionExecutionEvent < Struct.new(
  :plugin_id,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_type ⇒ String

The type of plugin.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#response_map ⇒ Hash<String,String>

The mapping of key-value pairs in an authentication challenge response.

Returns:

  • (Hash<String,String>) 


900
901
902
903
904
905
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 900

class AuthChallengeResponseEvent < Struct.new(
  :response_map,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#retriever ⇒ Types::RetrieverContentSource

The retriever to use as the content source.

Returns:



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1544

class ContentSource < Struct.new(
  :retriever,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Retriever < ContentSource; end
  class Unknown < ContentSource; end
end

#s3 ⇒ Types::S3

The path to the document in an Amazon S3 bucket.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 40

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#saml_configuration ⇒ Types::SamlConfiguration

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

Returns:



4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 4797

class IdentityProviderConfiguration < Struct.new(
  :saml_configuration,
  :open_id_connect_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SamlConfiguration < IdentityProviderConfiguration; end
  class OpenIdConnectConfiguration < IdentityProviderConfiguration; end
  class Unknown < IdentityProviderConfiguration; end
end

#source_attributions ⇒ Array<Types::SourceAttribution>

The source documents used to generate the conversation response.

Returns:



6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6072

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#string_configuration ⇒ Types::StringAttributeBoostingConfiguration

Provides information on boosting ‘STRING` type document attributes.

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3170

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#string_list_configuration ⇒ Types::StringListAttributeBoostingConfiguration

Provides information on boosting ‘STRING_LIST` type document attributes.

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3170

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#string_list_value ⇒ Array<String>

A list of strings.

Returns:

  • (Array<String>) 


3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3359

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#string_value ⇒ String

A string.

Returns:

  • (String) 


3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3359

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#system_message ⇒ String

An AI-generated message in a ‘TextOutputEvent`.

Returns:

  • (String) 


7376
7377
7378
7379
7380
7381
7382
7383
7384
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 7376

class TextOutputEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_id ⇒ String

The identifier of an AI-generated message in a ‘TextOutputEvent`.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#user ⇒ String

The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6401

class Principal < Struct.new(
  :user,
  :group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class User < Principal; end
  class Group < Principal; end
  class Unknown < Principal; end
end

#user_message ⇒ String

A user message in a text message input event.

Returns:

  • (String) 


7347
7348
7349
7350
7351
7352
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 7347

class TextInputEvent < Struct.new(
  :user_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_message_id ⇒ String

The identifier of an end user message in a ‘TextOutputEvent`.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end