Skip to content

Qbusiness Classes

APISchema

payload

  • Type: typing.Optional[str]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.S3]

AccessConfiguration

accessControls

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AccessControl]
  • Required: Yes

memberRelation

  • Type: typing.Optional[typing.Literal['AND', 'OR']]

AccessControl

principals

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Principal]
  • Required: Yes

memberRelation

  • Type: typing.Optional[typing.Literal['AND', 'OR']]

ActionConfiguration

action

  • Type:
  • Required: Yes

filterConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionFilterConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionFilterConfigurationOutput, NoneType]

ActionConfigurationOutput

action

  • Type:
  • Required: Yes

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionFilterConfigurationOutput]

ActionExecution

pluginId

  • Type:
  • Required: Yes

payload

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionPayloadField]
  • Required: Yes

payloadFieldNameSeparator

  • Type:
  • Required: Yes

ActionExecutionEvent

pluginId

  • Type:
  • Required: Yes

payload

  • Type: typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionPayloadField, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionPayloadFieldOutput]]
  • Required: Yes

payloadFieldNameSeparator

  • Type:
  • Required: Yes

ActionExecutionOutput

pluginId

  • Type:
  • Required: Yes

payload

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionPayloadFieldOutput]
  • Required: Yes

payloadFieldNameSeparator

  • Type:
  • Required: Yes

ActionExecutionPayloadField

value

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

ActionExecutionPayloadFieldOutput

value

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

ActionFilterConfiguration

documentAttributeFilter

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilter, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilterOutput]
  • Required: Yes

ActionFilterConfigurationOutput

documentAttributeFilter

  • Type:
  • Required: Yes

ActionReview

pluginId

  • Type: typing.Optional[str]

pluginType

  • Type: typing.Optional[typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']]

payload

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionReviewPayloadField]]

payloadFieldNameSeparator

  • Type: typing.Optional[str]

ActionReviewEvent

conversationId

  • Type: typing.Optional[str]

userMessageId

  • Type: typing.Optional[str]

systemMessageId

  • Type: typing.Optional[str]

pluginId

  • Type: typing.Optional[str]

pluginType

  • Type: typing.Optional[typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']]

payload

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionReviewPayloadField]]

payloadFieldNameSeparator

  • Type: typing.Optional[str]

ActionReviewPayloadField

displayName

  • Type: typing.Optional[str]

displayOrder

  • Type: typing.Optional[int]

displayDescription

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['ARRAY', 'BOOLEAN', 'NUMBER', 'STRING']]

value

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

allowedValues

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionReviewPayloadFieldAllowedValue]]

allowedFormat

  • Type: typing.Optional[str]

arrayItemJsonSchema

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

required

  • Type: typing.Optional[bool]

ActionReviewPayloadFieldAllowedValue

value

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

displayValue

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

ActionSummary

actionIdentifier

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

instructionExample

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

Application

displayName

  • Type: typing.Optional[str]

applicationId

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

identityType

  • Type: typing.Optional[typing.Literal['AWS_IAM_IDC', 'AWS_IAM_IDP_OIDC', 'AWS_IAM_IDP_SAML', 'AWS_QUICKSIGHT_IDP']]

quickSightConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.QuickSightConfiguration]

AppliedAttachmentsConfiguration

attachmentsControlMode

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

AppliedCreatorModeConfiguration

creatorModeControl

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

AppliedOrchestrationConfiguration

control

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

AssociatePermissionRequest

applicationId

  • Type:
  • Required: Yes

statementId

  • Type:
  • Required: Yes

actions

  • Type: typing.List[str]
  • Required: Yes

principal

  • Type:
  • Required: Yes

AssociatePermissionResponse

statement

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Attachment

attachmentId

  • Type: typing.Optional[str]

conversationId

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

copyFrom

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CopyFromSource]

fileType

  • Type: typing.Optional[str]

fileSize

  • Type: typing.Optional[int]

md5chksum

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['FAILED', 'SUCCESS']]

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ErrorDetail]

AttachmentInput

data

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

name

  • Type: typing.Optional[str]

copyFrom

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CopyFromSource]

AttachmentInputEvent

attachment

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentInput]

AttachmentOutput

name

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['FAILED', 'SUCCESS']]

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ErrorDetail]

attachmentId

  • Type: typing.Optional[str]

conversationId

  • Type: typing.Optional[str]

AttachmentsConfiguration

attachmentsControlMode

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

AttributeFilter

andAllFilters

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

orAllFilters

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

notFilter

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

equalsTo

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

containsAll

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

containsAny

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

greaterThan

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

greaterThanOrEquals

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

lessThan

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

lessThanOrEquals

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

AttributeFilterOutput

andAllFilters

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

orAllFilters

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

notFilter

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

equalsTo

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

containsAll

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

containsAny

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

greaterThan

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

greaterThanOrEquals

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

lessThan

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

lessThanOrEquals

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]

AttributeFilterPaginator

andAllFilters

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

orAllFilters

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

notFilter

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

equalsTo

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

containsAll

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

containsAny

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

greaterThan

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

greaterThanOrEquals

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

lessThan

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

lessThanOrEquals

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput, NoneType]

AudioExtractionConfiguration

audioExtractionStatus

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

AudioSourceDetails

mediaId

  • Type: typing.Optional[str]

mediaMimeType

  • Type: typing.Optional[str]

startTimeMilliseconds

  • Type: typing.Optional[int]

endTimeMilliseconds

  • Type: typing.Optional[int]

audioExtractionType

  • Type: typing.Optional[typing.Literal['SUMMARY', 'TRANSCRIPT']]

AuthChallengeRequest

authorizationUrl

  • Type:
  • Required: Yes

AuthChallengeRequestEvent

authorizationUrl

  • Type:
  • Required: Yes

AuthChallengeResponse

responseMap

  • Type: typing.Dict[str, str]
  • Required: Yes

AuthChallengeResponseEvent

responseMap

  • Type: typing.Dict[str, str]
  • Required: Yes

AutoSubscriptionConfiguration

autoSubscribe

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

defaultSubscriptionType

  • Type: typing.Optional[typing.Literal['Q_BUSINESS', 'Q_LITE']]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BasicAuthConfiguration

secretArn

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

BatchDeleteDocumentRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

documents

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DeleteDocument]
  • Required: Yes

dataSourceSyncId

  • Type: typing.Optional[str]

BatchDeleteDocumentResponse

failedDocuments

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.FailedDocument]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchPutDocumentRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

documents

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Document]
  • Required: Yes

roleArn

  • Type: typing.Optional[str]

dataSourceSyncId

  • Type: typing.Optional[str]

BatchPutDocumentResponse

failedDocuments

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.FailedDocument]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BlockedPhrasesConfiguration

blockedPhrases

  • Type: typing.Optional[typing.List[str]]

systemMessageOverride

  • Type: typing.Optional[str]

BlockedPhrasesConfigurationUpdate

blockedPhrasesToCreateOrUpdate

  • Type: typing.Optional[typing.List[str]]

blockedPhrasesToDelete

  • Type: typing.Optional[typing.List[str]]

systemMessageOverride

  • Type: typing.Optional[str]

BrowserExtensionConfiguration

enabledBrowserExtensions

  • Type: typing.List[typing.Literal['CHROME', 'FIREFOX']]
  • Required: Yes

BrowserExtensionConfigurationOutput

enabledBrowserExtensions

  • Type: typing.List[typing.Literal['CHROME', 'FIREFOX']]
  • Required: Yes

CancelSubscriptionRequest

applicationId

  • Type:
  • Required: Yes

subscriptionId

  • Type:
  • Required: Yes

CancelSubscriptionResponse

subscriptionArn

  • Type:
  • Required: Yes

currentSubscription

  • Type:
  • Required: Yes

nextSubscription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ChatInput

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

userGroups

  • Type: typing.Optional[typing.List[str]]

conversationId

  • Type: typing.Optional[str]

parentMessageId

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

inputStream

  • Type: typing.Optional[aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ChatInputStream]]

ChatInputStream

configurationEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ConfigurationEvent]

textEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TextInputEvent]

attachmentEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentInputEvent]

actionExecutionEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionEvent]

endOfInputEvent

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

authChallengeResponseEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AuthChallengeResponseEvent]

ChatModeConfiguration

pluginConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PluginConfiguration]

ChatOutput

outputStream

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ChatOutputStream]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ChatOutputStream

textEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TextOutputEvent]

metadataEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MetadataEvent]

actionReviewEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionReviewEvent]

failedAttachmentEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.FailedAttachmentEvent]

authChallengeRequestEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AuthChallengeRequestEvent]

ChatSyncInput

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

userGroups

  • Type: typing.Optional[typing.List[str]]

userMessage

  • Type: typing.Optional[str]

attachments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentInput]]

actionExecution

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecution, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionOutput, NoneType]

authChallengeResponse

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AuthChallengeResponse]

conversationId

  • Type: typing.Optional[str]

parentMessageId

  • Type: typing.Optional[str]

attributeFilter

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilter, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilterOutput, NoneType]

chatMode

  • Type: typing.Optional[typing.Literal['CREATOR_MODE', 'PLUGIN_MODE', 'RETRIEVAL_MODE']]

chatModeConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ChatModeConfiguration]

clientToken

  • Type: typing.Optional[str]

ChatSyncOutput

conversationId

  • Type:
  • Required: Yes

systemMessage

  • Type:
  • Required: Yes

systemMessageId

  • Type:
  • Required: Yes

userMessageId

  • Type:
  • Required: Yes

actionReview

  • Type:
  • Required: Yes

authChallengeRequest

  • Type:
  • Required: Yes

sourceAttributions

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SourceAttribution]
  • Required: Yes

failedAttachments

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ConfigurationEvent

chatMode

  • Type: typing.Optional[typing.Literal['CREATOR_MODE', 'PLUGIN_MODE', 'RETRIEVAL_MODE']]

chatModeConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ChatModeConfiguration]

attributeFilter

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilter, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilterOutput, NoneType]

ContentBlockerRule

systemMessageOverride

  • Type: typing.Optional[str]

ContentRetrievalRule

eligibleDataSources

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.EligibleDataSource]]

ContentRetrievalRuleOutput

eligibleDataSources

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.EligibleDataSource]]

ContentSource

retriever

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RetrieverContentSource]

Conversation

conversationId

  • Type: typing.Optional[str]

title

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

ConversationSource

conversationId

  • Type:
  • Required: Yes

attachmentId

  • Type:
  • Required: Yes

CopyFromSource

conversation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ConversationSource]

CreateApplicationRequest

displayName

  • Type:
  • Required: Yes

roleArn

  • Type: typing.Optional[str]

identityType

  • Type: typing.Optional[typing.Literal['AWS_IAM_IDC', 'AWS_IAM_IDP_OIDC', 'AWS_IAM_IDP_SAML', 'AWS_QUICKSIGHT_IDP']]

iamIdentityProviderArn

  • Type: typing.Optional[str]

identityCenterInstanceArn

  • Type: typing.Optional[str]

clientIdsForOIDC

  • Type: typing.Optional[typing.List[str]]

description

  • Type: typing.Optional[str]

encryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.EncryptionConfiguration]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

clientToken

  • Type: typing.Optional[str]

attachmentsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentsConfiguration]

qAppsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.QAppsConfiguration]

personalizationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PersonalizationConfiguration]

quickSightConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.QuickSightConfiguration]

CreateApplicationResponse

applicationId

  • Type:
  • Required: Yes

applicationArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataAccessorRequest

applicationId

  • Type:
  • Required: Yes

principal

  • Type:
  • Required: Yes

actionConfigurations

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionConfigurationOutput]]
  • Required: Yes

displayName

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

CreateDataAccessorResponse

dataAccessorId

  • Type:
  • Required: Yes

idcApplicationArn

  • Type:
  • Required: Yes

dataAccessorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataSourceRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

displayName

  • Type:
  • Required: Yes

configuration

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

vpcConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSourceVpcConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSourceVpcConfigurationOutput, NoneType]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

syncSchedule

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

documentEnrichmentConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentEnrichmentConfigurationOutput, NoneType]

mediaExtractionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MediaExtractionConfiguration]

CreateDataSourceResponse

dataSourceId

  • Type:
  • Required: Yes

dataSourceArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateIndexRequest

applicationId

  • Type:
  • Required: Yes

displayName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['ENTERPRISE', 'STARTER']]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

capacityConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.IndexCapacityConfiguration]

clientToken

  • Type: typing.Optional[str]

CreateIndexResponse

indexId

  • Type:
  • Required: Yes

indexArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatePluginRequest

applicationId

  • Type:
  • Required: Yes

displayName

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']
  • Required: Yes

authConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PluginAuthConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PluginAuthConfigurationOutput]
  • Required: Yes

serverUrl

  • Type: typing.Optional[str]

customPluginConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CustomPluginConfiguration]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

clientToken

  • Type: typing.Optional[str]

CreatePluginResponse

pluginId

  • Type:
  • Required: Yes

pluginArn

  • Type:
  • Required: Yes

buildStatus

  • Type: typing.Literal['CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'READY', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateRetrieverRequest

applicationId

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['KENDRA_INDEX', 'NATIVE_INDEX']
  • Required: Yes

displayName

  • Type:
  • Required: Yes

configuration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RetrieverConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RetrieverConfigurationOutput]
  • Required: Yes

roleArn

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

CreateRetrieverResponse

retrieverId

  • Type:
  • Required: Yes

retrieverArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSubscriptionRequest

applicationId

  • Type:
  • Required: Yes

principal

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Q_BUSINESS', 'Q_LITE']
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

CreateSubscriptionResponse

subscriptionId

  • Type:
  • Required: Yes

subscriptionArn

  • Type:
  • Required: Yes

currentSubscription

  • Type:
  • Required: Yes

nextSubscription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserRequest

applicationId

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

userAliases

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]]

clientToken

  • Type: typing.Optional[str]

CreateWebExperienceRequest

applicationId

  • Type:
  • Required: Yes

title

  • Type: typing.Optional[str]

subtitle

  • Type: typing.Optional[str]

welcomeMessage

  • Type: typing.Optional[str]

samplePromptsControlMode

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

origins

  • Type: typing.Optional[typing.List[str]]

roleArn

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]]

clientToken

  • Type: typing.Optional[str]

identityProviderConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.IdentityProviderConfiguration]

browserExtensionConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BrowserExtensionConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BrowserExtensionConfigurationOutput, NoneType]

customizationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CustomizationConfiguration]

CreateWebExperienceResponse

webExperienceId

  • Type:
  • Required: Yes

webExperienceArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatorModeConfiguration

creatorModeControl

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

CustomPluginConfiguration

description

  • Type:
  • Required: Yes

apiSchemaType

  • Type: typing.Literal['OPEN_API_V3']
  • Required: Yes

apiSchema

  • Type:
  • Required: Yes

CustomizationConfiguration

customCSSUrl

  • Type: typing.Optional[str]

logoUrl

  • Type: typing.Optional[str]

fontUrl

  • Type: typing.Optional[str]

faviconUrl

  • Type: typing.Optional[str]

DataAccessor

displayName

  • Type: typing.Optional[str]

dataAccessorId

  • Type: typing.Optional[str]

dataAccessorArn

  • Type: typing.Optional[str]

idcApplicationArn

  • Type: typing.Optional[str]

principal

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

DataSource

displayName

  • Type: typing.Optional[str]

dataSourceId

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PENDING_CREATION', 'UPDATING']]

DataSourceSyncJob

executionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['ABORTED', 'FAILED', 'INCOMPLETE', 'STOPPING', 'SUCCEEDED', 'SYNCING', 'SYNCING_INDEXING']]

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ErrorDetail]

dataSourceErrorCode

  • Type: typing.Optional[str]

metrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSourceSyncJobMetrics]

DataSourceSyncJobMetrics

documentsAdded

  • Type: typing.Optional[str]

documentsModified

  • Type: typing.Optional[str]

documentsDeleted

  • Type: typing.Optional[str]

documentsFailed

  • Type: typing.Optional[str]

documentsScanned

  • Type: typing.Optional[str]

DataSourceVpcConfiguration

subnetIds

  • Type: typing.List[str]
  • Required: Yes

securityGroupIds

  • Type: typing.List[str]
  • Required: Yes

DataSourceVpcConfigurationOutput

subnetIds

  • Type: typing.List[str]
  • Required: Yes

securityGroupIds

  • Type: typing.List[str]
  • Required: Yes

DateAttributeBoostingConfiguration

boostingLevel

  • Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE', 'VERY_HIGH']
  • Required: Yes

boostingDurationInSeconds

  • Type: typing.Optional[int]

DeleteApplicationRequest

applicationId

  • Type:
  • Required: Yes

DeleteAttachmentRequest

applicationId

  • Type:
  • Required: Yes

conversationId

  • Type:
  • Required: Yes

attachmentId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

DeleteChatControlsConfigurationRequest

applicationId

  • Type:
  • Required: Yes

DeleteConversationRequest

conversationId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

DeleteDataAccessorRequest

applicationId

  • Type:
  • Required: Yes

dataAccessorId

  • Type:
  • Required: Yes

DeleteDataSourceRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

dataSourceId

  • Type:
  • Required: Yes

DeleteDocument

documentId

  • Type:
  • Required: Yes

DeleteGroupRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

groupName

  • Type:
  • Required: Yes

dataSourceId

  • Type: typing.Optional[str]

DeleteIndexRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

DeletePluginRequest

applicationId

  • Type:
  • Required: Yes

pluginId

  • Type:
  • Required: Yes

DeleteRetrieverRequest

applicationId

  • Type:
  • Required: Yes

retrieverId

  • Type:
  • Required: Yes

DeleteUserRequest

applicationId

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

DeleteWebExperienceRequest

applicationId

  • Type:
  • Required: Yes

webExperienceId

  • Type:
  • Required: Yes

DisassociatePermissionRequest

applicationId

  • Type:
  • Required: Yes

statementId

  • Type:
  • Required: Yes

Document

id

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttribute, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]]]

content

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentContent]

contentType

  • Type: typing.Optional[typing.Literal['CSV', 'HTML', 'JSON', 'MD', 'MS_EXCEL', 'MS_WORD', 'PDF', 'PLAIN_TEXT', 'PPT', 'RTF', 'XML', 'XSLT']]

title

  • Type: typing.Optional[str]

accessConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AccessConfiguration]

documentEnrichmentConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentEnrichmentConfigurationOutput, NoneType]

mediaExtractionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MediaExtractionConfiguration]

DocumentAttribute

name

  • Type:
  • Required: Yes

value

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValue, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValueOutput]
  • Required: Yes

DocumentAttributeBoostingConfiguration

numberConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.NumberAttributeBoostingConfiguration]

stringConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.StringAttributeBoostingConfiguration]

dateConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DateAttributeBoostingConfiguration]

stringListConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.StringListAttributeBoostingConfiguration]

DocumentAttributeBoostingConfigurationOutput

numberConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.NumberAttributeBoostingConfiguration]

stringConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.StringAttributeBoostingConfigurationOutput]

dateConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DateAttributeBoostingConfiguration]

stringListConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.StringListAttributeBoostingConfiguration]

DocumentAttributeCondition

key

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['BEGINS_WITH', 'CONTAINS', 'EQUALS', 'EXISTS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'NOT_CONTAINS', 'NOT_EQUALS', 'NOT_EXISTS']
  • Required: Yes

value

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValue, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValueOutput, NoneType]

DocumentAttributeConditionOutput

key

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['BEGINS_WITH', 'CONTAINS', 'EQUALS', 'EXISTS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'NOT_CONTAINS', 'NOT_EQUALS', 'NOT_EXISTS']
  • Required: Yes

value

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValueOutput]

DocumentAttributeConfiguration

name

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['DATE', 'NUMBER', 'STRING', 'STRING_LIST']]
  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

DocumentAttributeOutput

name

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

DocumentAttributeTarget

key

  • Type:
  • Required: Yes

value

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValue, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValueOutput, NoneType]

attributeValueOperator

  • Type: typing.Optional[typing.Literal['DELETE']]

DocumentAttributeTargetOutput

key

  • Type:
  • Required: Yes

value

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeValueOutput]

attributeValueOperator

  • Type: typing.Optional[typing.Literal['DELETE']]

DocumentAttributeValue

stringValue

  • Type: typing.Optional[str]

stringListValue

  • Type: typing.Optional[typing.List[str]]

longValue

  • Type: typing.Optional[int]

dateValue

  • Type: typing.Union[datetime.datetime, str, NoneType]

DocumentAttributeValueOutput

stringValue

  • Type: typing.Optional[str]

stringListValue

  • Type: typing.Optional[typing.List[str]]

longValue

  • Type: typing.Optional[int]

dateValue

  • Type: typing.Optional[datetime.datetime]

DocumentContent

blob

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.S3]

DocumentDetails

documentId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['DELETED', 'DELETING', 'DOCUMENT_FAILED_TO_INDEX', 'FAILED', 'INDEXED', 'PROCESSING', 'RECEIVED', 'UPDATED']]

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ErrorDetail]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

DocumentEnrichmentConfiguration

inlineConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.InlineDocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.InlineDocumentEnrichmentConfigurationOutput]]]

preExtractionHookConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.HookConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.HookConfigurationOutput, NoneType]

postExtractionHookConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.HookConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.HookConfigurationOutput, NoneType]

DocumentEnrichmentConfigurationOutput

inlineConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.InlineDocumentEnrichmentConfigurationOutput]]

preExtractionHookConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.HookConfigurationOutput]

postExtractionHookConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.HookConfigurationOutput]

EligibleDataSource

indexId

  • Type: typing.Optional[str]

dataSourceId

  • Type: typing.Optional[str]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

EncryptionConfiguration

kmsKeyId

  • Type: typing.Optional[str]

ErrorDetail

errorMessage

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['InternalError', 'InvalidRequest', 'ResourceInactive', 'ResourceNotFound']]

FailedAttachmentEvent

conversationId

  • Type: typing.Optional[str]

userMessageId

  • Type: typing.Optional[str]

systemMessageId

  • Type: typing.Optional[str]

attachment

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentOutput]

FailedDocument

id

  • Type: typing.Optional[str]

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ErrorDetail]

dataSourceId

  • Type: typing.Optional[str]

GetApplicationRequest

applicationId

  • Type:
  • Required: Yes

GetApplicationResponse

displayName

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

applicationArn

  • Type:
  • Required: Yes

identityType

  • Type: typing.Literal['AWS_IAM_IDC', 'AWS_IAM_IDP_OIDC', 'AWS_IAM_IDP_SAML', 'AWS_QUICKSIGHT_IDP']
  • Required: Yes

iamIdentityProviderArn

  • Type:
  • Required: Yes

identityCenterApplicationArn

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

description

  • Type:
  • Required: Yes

encryptionConfiguration

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

error

  • Type:
  • Required: Yes

attachmentsConfiguration

  • Type:
  • Required: Yes

qAppsConfiguration

  • Type:
  • Required: Yes

personalizationConfiguration

  • Type:
  • Required: Yes

autoSubscriptionConfiguration

  • Type:
  • Required: Yes

clientIdsForOIDC

  • Type: typing.List[str]
  • Required: Yes

quickSightConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetChatControlsConfigurationRequest

applicationId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

GetChatControlsConfigurationRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

GetChatControlsConfigurationResponse

responseScope

  • Type: typing.Literal['ENTERPRISE_CONTENT_ONLY', 'EXTENDED_KNOWLEDGE_ENABLED']
  • Required: Yes

orchestrationConfiguration

  • Type:
  • Required: Yes

blockedPhrases

  • Type:
  • Required: Yes

topicConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TopicConfigurationOutput]
  • Required: Yes

creatorModeConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetDataAccessorRequest

applicationId

  • Type:
  • Required: Yes

dataAccessorId

  • Type:
  • Required: Yes

GetDataAccessorResponse

displayName

  • Type:
  • Required: Yes

dataAccessorId

  • Type:
  • Required: Yes

dataAccessorArn

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

idcApplicationArn

  • Type:
  • Required: Yes

principal

  • Type:
  • Required: Yes

actionConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionConfigurationOutput]
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataSourceRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

dataSourceId

  • Type:
  • Required: Yes

GetDataSourceResponse

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

dataSourceId

  • Type:
  • Required: Yes

dataSourceArn

  • Type:
  • Required: Yes

displayName

  • Type:
  • Required: Yes

type

  • Type:
  • Required: Yes

configuration

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

vpcConfiguration

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PENDING_CREATION', 'UPDATING']
  • Required: Yes

syncSchedule

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

error

  • Type:
  • Required: Yes

documentEnrichmentConfiguration

  • Type:
  • Required: Yes

mediaExtractionConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGroupRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

groupName

  • Type:
  • Required: Yes

dataSourceId

  • Type: typing.Optional[str]

GetGroupResponse

status

  • Type:
  • Required: Yes

statusHistory

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.GroupStatusDetail]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIndexRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

GetIndexResponse

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

displayName

  • Type:
  • Required: Yes

indexArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

type

  • Type: typing.Literal['ENTERPRISE', 'STARTER']
  • Required: Yes

description

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

capacityConfiguration

  • Type:
  • Required: Yes

documentAttributeConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeConfiguration]
  • Required: Yes

error

  • Type:
  • Required: Yes

indexStatistics

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetMediaRequest

applicationId

  • Type:
  • Required: Yes

conversationId

  • Type:
  • Required: Yes

messageId

  • Type:
  • Required: Yes

mediaId

  • Type:
  • Required: Yes

GetMediaResponse

mediaBytes

  • Type:
  • Required: Yes

mediaMimeType

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPluginRequest

applicationId

  • Type:
  • Required: Yes

pluginId

  • Type:
  • Required: Yes

GetPluginResponse

applicationId

  • Type:
  • Required: Yes

pluginId

  • Type:
  • Required: Yes

displayName

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']
  • Required: Yes

serverUrl

  • Type:
  • Required: Yes

authConfiguration

  • Type:
  • Required: Yes

customPluginConfiguration

  • Type:
  • Required: Yes

buildStatus

  • Type: typing.Literal['CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'READY', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

pluginArn

  • Type:
  • Required: Yes

state

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPolicyRequest

applicationId

  • Type:
  • Required: Yes

GetPolicyResponse

policy

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRetrieverRequest

applicationId

  • Type:
  • Required: Yes

retrieverId

  • Type:
  • Required: Yes

GetRetrieverResponse

applicationId

  • Type:
  • Required: Yes

retrieverId

  • Type:
  • Required: Yes

retrieverArn

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['KENDRA_INDEX', 'NATIVE_INDEX']
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'FAILED']
  • Required: Yes

displayName

  • Type:
  • Required: Yes

configuration

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserRequest

applicationId

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

GetUserResponse

userAliases

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetWebExperienceRequest

applicationId

  • Type:
  • Required: Yes

webExperienceId

  • Type:
  • Required: Yes

GetWebExperienceResponse

applicationId

  • Type:
  • Required: Yes

webExperienceId

  • Type:
  • Required: Yes

webExperienceArn

  • Type:
  • Required: Yes

defaultEndpoint

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PENDING_AUTH_CONFIG']
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

title

  • Type:
  • Required: Yes

subtitle

  • Type:
  • Required: Yes

welcomeMessage

  • Type:
  • Required: Yes

samplePromptsControlMode

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

origins

  • Type: typing.List[str]
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

identityProviderConfiguration

  • Type:
  • Required: Yes

authenticationConfiguration

  • Type:
  • Required: Yes

error

  • Type:
  • Required: Yes

browserExtensionConfiguration

  • Type:
  • Required: Yes

customizationConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GroupMembers

memberGroups

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MemberGroup]]

memberUsers

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MemberUser]]

s3PathForGroupMembers

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.S3]

GroupStatusDetail

status

  • Type: typing.Optional[typing.Literal['DELETED', 'DELETING', 'FAILED', 'PROCESSING', 'SUCCEEDED']]

lastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

errorDetail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ErrorDetail]

GroupSummary

groupName

  • Type: typing.Optional[str]

HookConfiguration

invocationCondition

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeCondition, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeConditionOutput, NoneType]

lambdaArn

  • Type: typing.Optional[str]

s3BucketName

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

HookConfigurationOutput

invocationCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeConditionOutput]

lambdaArn

  • Type: typing.Optional[str]

s3BucketName

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

IdcAuthConfiguration

idcApplicationArn

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

IdentityProviderConfiguration

samlConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SamlProviderConfiguration]

openIDConnectConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.OpenIDConnectProviderConfiguration]

ImageExtractionConfiguration

imageExtractionStatus

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

ImageSourceDetails

mediaId

  • Type: typing.Optional[str]

mediaMimeType

  • Type: typing.Optional[str]

Index

displayName

  • Type: typing.Optional[str]

indexId

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

IndexCapacityConfiguration

units

  • Type: typing.Optional[int]

IndexStatistics

textDocumentStatistics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TextDocumentStatistics]

InlineDocumentEnrichmentConfiguration

condition

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeCondition, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeConditionOutput, NoneType]

target

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeTarget, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeTargetOutput, NoneType]

documentContentOperator

  • Type: typing.Optional[typing.Literal['DELETE']]

InlineDocumentEnrichmentConfigurationOutput

condition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeConditionOutput]

target

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeTargetOutput]

documentContentOperator

  • Type: typing.Optional[typing.Literal['DELETE']]

KendraIndexConfiguration

indexId

  • Type:
  • Required: Yes

ListApplicationsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListApplicationsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListApplicationsResponse

applications

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Application]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAttachmentsRequest

applicationId

  • Type:
  • Required: Yes

conversationId

  • Type: typing.Optional[str]

userId

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAttachmentsRequestPaginate

applicationId

  • Type:
  • Required: Yes

conversationId

  • Type: typing.Optional[str]

userId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListAttachmentsResponse

attachments

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Attachment]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListConversationsRequest

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListConversationsRequestPaginate

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListConversationsResponse

conversations

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Conversation]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDataAccessorsRequest

applicationId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDataAccessorsRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListDataAccessorsResponse

dataAccessors

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataAccessor]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDataSourceSyncJobsRequest

dataSourceId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

endTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

statusFilter

  • Type: typing.Optional[typing.Literal['ABORTED', 'FAILED', 'INCOMPLETE', 'STOPPING', 'SUCCEEDED', 'SYNCING', 'SYNCING_INDEXING']]

ListDataSourceSyncJobsRequestPaginate

dataSourceId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

endTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

statusFilter

  • Type: typing.Optional[typing.Literal['ABORTED', 'FAILED', 'INCOMPLETE', 'STOPPING', 'SUCCEEDED', 'SYNCING', 'SYNCING_INDEXING']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListDataSourceSyncJobsResponse

history

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSourceSyncJob]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDataSourcesRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDataSourcesRequestPaginate

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListDataSourcesResponse

dataSources

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSource]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDocumentsRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

dataSourceIds

  • Type: typing.Optional[typing.List[str]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDocumentsRequestPaginate

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

dataSourceIds

  • Type: typing.Optional[typing.List[str]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListDocumentsResponse

documentDetailList

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentDetails]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListGroupsRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

updatedEarlierThan

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

dataSourceId

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListGroupsRequestPaginate

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

updatedEarlierThan

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

dataSourceId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListGroupsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.GroupSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListIndicesRequest

applicationId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListIndicesRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListIndicesResponse

indices

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Index]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListMessagesRequest

conversationId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListMessagesRequestPaginate

conversationId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListMessagesResponse

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Message]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPluginActionsRequest

applicationId

  • Type:
  • Required: Yes

pluginId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListPluginActionsRequestPaginate

applicationId

  • Type:
  • Required: Yes

pluginId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListPluginActionsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPluginTypeActionsRequest

pluginType

  • Type: typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListPluginTypeActionsRequestPaginate

pluginType

  • Type: typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListPluginTypeActionsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPluginTypeMetadataRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListPluginTypeMetadataRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListPluginTypeMetadataResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PluginTypeMetadataSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPluginsRequest

applicationId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListPluginsRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListPluginsResponse

plugins

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Plugin]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListRetrieversRequest

applicationId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListRetrieversRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListRetrieversResponse

retrievers

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Retriever]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListSubscriptionsRequest

applicationId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListSubscriptionsRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListSubscriptionsResponse

subscriptions

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Subscription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceARN

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListWebExperiencesRequest

applicationId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListWebExperiencesRequestPaginate

applicationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

ListWebExperiencesResponse

webExperiences

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.WebExperience]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

MediaExtractionConfiguration

imageExtractionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ImageExtractionConfiguration]

audioExtractionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AudioExtractionConfiguration]

videoExtractionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.VideoExtractionConfiguration]

MemberGroup

groupName

  • Type:
  • Required: Yes

type

  • Type: typing.Optional[typing.Literal['DATASOURCE', 'INDEX']]

MemberUser

userId

  • Type:
  • Required: Yes

type

  • Type: typing.Optional[typing.Literal['DATASOURCE', 'INDEX']]

Message

messageId

  • Type: typing.Optional[str]

body

  • Type: typing.Optional[str]

time

  • Type: typing.Optional[datetime.datetime]

type

  • Type: typing.Optional[typing.Literal['SYSTEM', 'USER']]

attachments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentOutput]]

sourceAttribution

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SourceAttribution]]

actionReview

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionReview]

actionExecution

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionExecutionOutput]

MessageUsefulnessFeedback

usefulness

  • Type: typing.Literal['NOT_USEFUL', 'USEFUL']
  • Required: Yes

submittedAt

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

reason

  • Type: typing.Optional[typing.Literal['COMPLETE', 'FACTUALLY_CORRECT', 'HARMFUL_OR_UNSAFE', 'HELPFUL', 'INCORRECT_OR_MISSING_SOURCES', 'NOT_BASED_ON_DOCUMENTS', 'NOT_COMPLETE', 'NOT_CONCISE', 'NOT_FACTUALLY_CORRECT', 'NOT_HELPFUL', 'OTHER', 'RELEVANT_SOURCES']]

comment

  • Type: typing.Optional[str]

MetadataEvent

conversationId

  • Type: typing.Optional[str]

userMessageId

  • Type: typing.Optional[str]

systemMessageId

  • Type: typing.Optional[str]

sourceAttributions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SourceAttribution]]

finalTextMessage

  • Type: typing.Optional[str]

NativeIndexConfiguration

indexId

  • Type:
  • Required: Yes

boostingOverride

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeBoostingConfiguration]]

NativeIndexConfigurationOutput

indexId

  • Type:
  • Required: Yes

boostingOverride

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeBoostingConfigurationOutput]]

NumberAttributeBoostingConfiguration

boostingLevel

  • Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE', 'VERY_HIGH']
  • Required: Yes

boostingType

  • Type: typing.Optional[typing.Literal['PRIORITIZE_LARGER_VALUES', 'PRIORITIZE_SMALLER_VALUES']]

OAuth2ClientCredentialConfiguration

secretArn

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

authorizationUrl

  • Type: typing.Optional[str]

tokenUrl

  • Type: typing.Optional[str]

OpenIDConnectProviderConfiguration

secretsArn

  • Type:
  • Required: Yes

secretsRole

  • Type:
  • Required: Yes

OrchestrationConfiguration

control

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PersonalizationConfiguration

personalizationControlMode

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

Plugin

pluginId

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']]

serverUrl

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

buildStatus

  • Type: typing.Optional[typing.Literal['CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'READY', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

PluginAuthConfiguration

basicAuthConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BasicAuthConfiguration]

oAuth2ClientCredentialConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.OAuth2ClientCredentialConfiguration]

noAuthConfiguration

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

idcAuthConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.IdcAuthConfiguration]

PluginAuthConfigurationOutput

basicAuthConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BasicAuthConfiguration]

oAuth2ClientCredentialConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.OAuth2ClientCredentialConfiguration]

noAuthConfiguration

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

idcAuthConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.IdcAuthConfiguration]

PluginConfiguration

pluginId

  • Type:
  • Required: Yes

PluginTypeMetadataSummary

type

  • Type: typing.Optional[typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'QUICKSIGHT', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']]

category

  • Type: typing.Optional[typing.Literal['Communication', 'Customer relationship management (CRM)', 'Productivity', 'Project management', 'Ticketing and incident management']]

description

  • Type: typing.Optional[str]

Principal

user

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PrincipalUser]

group

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PrincipalGroup]

PrincipalGroup

access

  • Type: typing.Literal['ALLOW', 'DENY']
  • Required: Yes

name

  • Type: typing.Optional[str]

membershipType

  • Type: typing.Optional[typing.Literal['DATASOURCE', 'INDEX']]

PrincipalUser

access

  • Type: typing.Literal['ALLOW', 'DENY']
  • Required: Yes

id

  • Type: typing.Optional[str]

membershipType

  • Type: typing.Optional[typing.Literal['DATASOURCE', 'INDEX']]

PutFeedbackRequest

applicationId

  • Type:
  • Required: Yes

conversationId

  • Type:
  • Required: Yes

messageId

  • Type:
  • Required: Yes

userId

  • Type: typing.Optional[str]

messageCopiedAt

  • Type: typing.Union[datetime.datetime, str, NoneType]

messageUsefulness

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MessageUsefulnessFeedback]

PutGroupRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

groupName

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['DATASOURCE', 'INDEX']
  • Required: Yes

groupMembers

  • Type:
  • Required: Yes

dataSourceId

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

QAppsConfiguration

qAppsControlMode

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

QuickSightConfiguration

clientNamespace

  • Type:
  • Required: Yes

RelevantContent

content

  • Type: typing.Optional[str]

documentId

  • Type: typing.Optional[str]

documentTitle

  • Type: typing.Optional[str]

documentUri

  • Type: typing.Optional[str]

documentAttributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeOutput]]

scoreAttributes

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ScoreAttributes]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

Retriever

applicationId

  • Type: typing.Optional[str]

retrieverId

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['KENDRA_INDEX', 'NATIVE_INDEX']]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'FAILED']]

displayName

  • Type: typing.Optional[str]

RetrieverConfiguration

nativeIndexConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.NativeIndexConfiguration]

kendraIndexConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.KendraIndexConfiguration]

RetrieverConfigurationOutput

nativeIndexConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.NativeIndexConfigurationOutput]

kendraIndexConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.KendraIndexConfiguration]

RetrieverContentSource

retrieverId

  • Type:
  • Required: Yes

Rule

ruleType

  • Type: typing.Literal['CONTENT_BLOCKER_RULE', 'CONTENT_RETRIEVAL_RULE']
  • Required: Yes

includedUsersAndGroups

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UsersAndGroups, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UsersAndGroupsOutput, NoneType]

excludedUsersAndGroups

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UsersAndGroups, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UsersAndGroupsOutput, NoneType]

ruleConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RuleConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RuleConfigurationOutput, NoneType]

RuleConfiguration

contentBlockerRule

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ContentBlockerRule]

contentRetrievalRule

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ContentRetrievalRule, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ContentRetrievalRuleOutput, NoneType]

RuleConfigurationOutput

contentBlockerRule

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ContentBlockerRule]

contentRetrievalRule

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ContentRetrievalRuleOutput]

RuleOutput

ruleType

  • Type: typing.Literal['CONTENT_BLOCKER_RULE', 'CONTENT_RETRIEVAL_RULE']
  • Required: Yes

includedUsersAndGroups

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UsersAndGroupsOutput]

excludedUsersAndGroups

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UsersAndGroupsOutput]

ruleConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RuleConfigurationOutput]

S3

bucket

  • Type:
  • Required: Yes

key

  • Type:
  • Required: Yes

SamlConfiguration

metadataXML

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

userIdAttribute

  • Type:
  • Required: Yes

userGroupAttribute

  • Type: typing.Optional[str]

SamlProviderConfiguration

authenticationUrl

  • Type:
  • Required: Yes

ScoreAttributes

scoreConfidence

  • Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NOT_AVAILABLE', 'VERY_HIGH']]

SearchRelevantContentRequest

applicationId

  • Type:
  • Required: Yes

queryText

  • Type:
  • Required: Yes

contentSource

  • Type:
  • Required: Yes

attributeFilter

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilter, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilterOutput, NoneType]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchRelevantContentRequestPaginate

applicationId

  • Type:
  • Required: Yes

queryText

  • Type:
  • Required: Yes

contentSource

  • Type:
  • Required: Yes

attributeFilter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttributeFilterPaginator]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PaginatorConfig]

SearchRelevantContentResponse

relevantContent

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RelevantContent]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SnippetExcerpt

text

  • Type: typing.Optional[str]

SourceAttribution

title

  • Type: typing.Optional[str]

snippet

  • Type: typing.Optional[str]

url

  • Type: typing.Optional[str]

citationNumber

  • Type: typing.Optional[int]

updatedAt

  • Type: typing.Optional[datetime.datetime]

textMessageSegments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TextSegment]]

SourceDetails

imageSourceDetails

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ImageSourceDetails]

audioSourceDetails

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AudioSourceDetails]

videoSourceDetails

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.VideoSourceDetails]

StartDataSourceSyncJobRequest

dataSourceId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

StartDataSourceSyncJobResponse

executionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopDataSourceSyncJobRequest

dataSourceId

  • Type:
  • Required: Yes

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

StringAttributeBoostingConfiguration

boostingLevel

  • Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE', 'VERY_HIGH']
  • Required: Yes

attributeValueBoosting

  • Type: typing.Optional[typing.Dict[str, typing.Literal['HIGH', 'LOW', 'MEDIUM', 'VERY_HIGH']]]

StringAttributeBoostingConfigurationOutput

boostingLevel

  • Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE', 'VERY_HIGH']
  • Required: Yes

attributeValueBoosting

  • Type: typing.Optional[typing.Dict[str, typing.Literal['HIGH', 'LOW', 'MEDIUM', 'VERY_HIGH']]]

StringListAttributeBoostingConfiguration

boostingLevel

  • Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE', 'VERY_HIGH']
  • Required: Yes

Subscription

subscriptionId

  • Type: typing.Optional[str]

subscriptionArn

  • Type: typing.Optional[str]

principal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SubscriptionPrincipal]

currentSubscription

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SubscriptionDetails]

nextSubscription

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SubscriptionDetails]

SubscriptionDetails

type

  • Type: typing.Optional[typing.Literal['Q_BUSINESS', 'Q_LITE']]

SubscriptionPrincipal

user

  • Type: typing.Optional[str]

group

  • Type: typing.Optional[str]

Tag

key

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

TagResourceRequest

resourceARN

  • Type:
  • Required: Yes

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Tag]
  • Required: Yes

TextDocumentStatistics

indexedTextBytes

  • Type: typing.Optional[int]

indexedTextDocumentCount

  • Type: typing.Optional[int]

TextInputEvent

userMessage

  • Type:
  • Required: Yes

TextOutputEvent

conversationId

  • Type: typing.Optional[str]

userMessageId

  • Type: typing.Optional[str]

systemMessageId

  • Type: typing.Optional[str]

systemMessage

  • Type: typing.Optional[str]

TextSegment

beginOffset

  • Type: typing.Optional[int]

endOffset

  • Type: typing.Optional[int]

snippetExcerpt

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SnippetExcerpt]

mediaId

  • Type: typing.Optional[str]

mediaMimeType

  • Type: typing.Optional[str]

sourceDetails

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SourceDetails]

TopicConfiguration

name

  • Type:
  • Required: Yes

rules

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.Rule, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RuleOutput]]
  • Required: Yes

description

  • Type: typing.Optional[str]

exampleChatMessages

  • Type: typing.Optional[typing.List[str]]

TopicConfigurationOutput

name

  • Type:
  • Required: Yes

rules

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RuleOutput]
  • Required: Yes

description

  • Type: typing.Optional[str]

exampleChatMessages

  • Type: typing.Optional[typing.List[str]]

UntagResourceRequest

resourceARN

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateApplicationRequest

applicationId

  • Type:
  • Required: Yes

identityCenterInstanceArn

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

attachmentsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AttachmentsConfiguration]

qAppsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.QAppsConfiguration]

personalizationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PersonalizationConfiguration]

autoSubscriptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.AutoSubscriptionConfiguration]

UpdateChatControlsConfigurationRequest

applicationId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

responseScope

  • Type: typing.Optional[typing.Literal['ENTERPRISE_CONTENT_ONLY', 'EXTENDED_KNOWLEDGE_ENABLED']]

orchestrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.OrchestrationConfiguration]

blockedPhrasesConfigurationUpdate

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BlockedPhrasesConfigurationUpdate]

topicConfigurationsToCreateOrUpdate

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TopicConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TopicConfigurationOutput]]]

topicConfigurationsToDelete

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TopicConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.TopicConfigurationOutput]]]

creatorModeConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CreatorModeConfiguration]

UpdateDataAccessorRequest

applicationId

  • Type:
  • Required: Yes

dataAccessorId

  • Type:
  • Required: Yes

actionConfigurations

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.ActionConfigurationOutput]]
  • Required: Yes

displayName

  • Type: typing.Optional[str]

UpdateDataSourceRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

dataSourceId

  • Type:
  • Required: Yes

displayName

  • Type: typing.Optional[str]

configuration

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

vpcConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSourceVpcConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DataSourceVpcConfigurationOutput, NoneType]

description

  • Type: typing.Optional[str]

syncSchedule

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

documentEnrichmentConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentEnrichmentConfigurationOutput, NoneType]

mediaExtractionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.MediaExtractionConfiguration]

UpdateIndexRequest

applicationId

  • Type:
  • Required: Yes

indexId

  • Type:
  • Required: Yes

displayName

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

capacityConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.IndexCapacityConfiguration]

documentAttributeConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.DocumentAttributeConfiguration]]

UpdatePluginRequest

applicationId

  • Type:
  • Required: Yes

pluginId

  • Type:
  • Required: Yes

displayName

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

serverUrl

  • Type: typing.Optional[str]

customPluginConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CustomPluginConfiguration]

authConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PluginAuthConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.PluginAuthConfigurationOutput, NoneType]

UpdateRetrieverRequest

applicationId

  • Type:
  • Required: Yes

retrieverId

  • Type:
  • Required: Yes

configuration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RetrieverConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.RetrieverConfigurationOutput, NoneType]

displayName

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

UpdateSubscriptionRequest

applicationId

  • Type:
  • Required: Yes

subscriptionId

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Q_BUSINESS', 'Q_LITE']
  • Required: Yes

UpdateSubscriptionResponse

subscriptionArn

  • Type:
  • Required: Yes

currentSubscription

  • Type:
  • Required: Yes

nextSubscription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserRequest

applicationId

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

userAliasesToUpdate

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]]

userAliasesToDelete

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]]

UpdateUserResponse

userAliasesAdded

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]
  • Required: Yes

userAliasesUpdated

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]
  • Required: Yes

userAliasesDeleted

  • Type: typing.List[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.UserAlias]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateWebExperienceRequest

applicationId

  • Type:
  • Required: Yes

webExperienceId

  • Type:
  • Required: Yes

roleArn

  • Type: typing.Optional[str]

authenticationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.WebExperienceAuthConfiguration]

title

  • Type: typing.Optional[str]

subtitle

  • Type: typing.Optional[str]

welcomeMessage

  • Type: typing.Optional[str]

samplePromptsControlMode

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

identityProviderConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.IdentityProviderConfiguration]

origins

  • Type: typing.Optional[typing.List[str]]

browserExtensionConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BrowserExtensionConfiguration, aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.BrowserExtensionConfigurationOutput, NoneType]

customizationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.CustomizationConfiguration]

UserAlias

userId

  • Type:
  • Required: Yes

indexId

  • Type: typing.Optional[str]

dataSourceId

  • Type: typing.Optional[str]

UsersAndGroups

userIds

  • Type: typing.Optional[typing.List[str]]

userGroups

  • Type: typing.Optional[typing.List[str]]

UsersAndGroupsOutput

userIds

  • Type: typing.Optional[typing.List[str]]

userGroups

  • Type: typing.Optional[typing.List[str]]

VideoExtractionConfiguration

videoExtractionStatus

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

VideoSourceDetails

mediaId

  • Type: typing.Optional[str]

mediaMimeType

  • Type: typing.Optional[str]

startTimeMilliseconds

  • Type: typing.Optional[int]

endTimeMilliseconds

  • Type: typing.Optional[int]

videoExtractionType

  • Type: typing.Optional[typing.Literal['SUMMARY', 'TRANSCRIPT']]

WebExperience

webExperienceId

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

defaultEndpoint

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PENDING_AUTH_CONFIG']]

WebExperienceAuthConfiguration

samlConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.qbusiness.qbusiness_classes.SamlConfiguration]