Type definitions#
Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
DataSourceVpcConfigurationUnionTypeDef#
# DataSourceVpcConfigurationUnionTypeDef definition
DataSourceVpcConfigurationUnionTypeDef = Union[
DataSourceVpcConfigurationTypeDef, # (1)
DataSourceVpcConfigurationOutputTypeDef, # (2)
]
ActionExecutionUnionTypeDef#
# ActionExecutionUnionTypeDef definition
ActionExecutionUnionTypeDef = Union[
ActionExecutionTypeDef, # (1)
ActionExecutionExtraOutputTypeDef, # (2)
]
RetrieverConfigurationUnionTypeDef#
# RetrieverConfigurationUnionTypeDef definition
RetrieverConfigurationUnionTypeDef = Union[
RetrieverConfigurationTypeDef, # (1)
RetrieverConfigurationOutputTypeDef, # (2)
]
TopicConfigurationUnionTypeDef#
# TopicConfigurationUnionTypeDef definition
TopicConfigurationUnionTypeDef = Union[
TopicConfigurationTypeDef, # (1)
TopicConfigurationExtraOutputTypeDef, # (2)
]
DocumentEnrichmentConfigurationUnionTypeDef#
# DocumentEnrichmentConfigurationUnionTypeDef definition
DocumentEnrichmentConfigurationUnionTypeDef = Union[
DocumentEnrichmentConfigurationTypeDef, # (1)
DocumentEnrichmentConfigurationOutputTypeDef, # (2)
]
ActionExecutionPayloadFieldExtraOutputTypeDef#
# ActionExecutionPayloadFieldExtraOutputTypeDef definition
class ActionExecutionPayloadFieldExtraOutputTypeDef(TypedDict):
value: Dict[str, Any],
ActionExecutionPayloadFieldOutputTypeDef#
# ActionExecutionPayloadFieldOutputTypeDef definition
class ActionExecutionPayloadFieldOutputTypeDef(TypedDict):
value: Dict[str, Any],
ActionExecutionPayloadFieldTypeDef#
# ActionExecutionPayloadFieldTypeDef definition
class ActionExecutionPayloadFieldTypeDef(TypedDict):
value: Mapping[str, Any],
ActionReviewPayloadFieldAllowedValueTypeDef#
# ActionReviewPayloadFieldAllowedValueTypeDef definition
class ActionReviewPayloadFieldAllowedValueTypeDef(TypedDict):
displayValue: NotRequired[Dict[str, Any]],
value: NotRequired[Dict[str, Any]],
ApplicationTypeDef#
# ApplicationTypeDef definition
class ApplicationTypeDef(TypedDict):
applicationId: NotRequired[str],
createdAt: NotRequired[datetime],
displayName: NotRequired[str],
status: NotRequired[ApplicationStatusType], # (1)
updatedAt: NotRequired[datetime],
AppliedAttachmentsConfigurationTypeDef#
# AppliedAttachmentsConfigurationTypeDef definition
class AppliedAttachmentsConfigurationTypeDef(TypedDict):
attachmentsControlMode: NotRequired[AttachmentsControlModeType], # (1)
AppliedCreatorModeConfigurationTypeDef#
# AppliedCreatorModeConfigurationTypeDef definition
class AppliedCreatorModeConfigurationTypeDef(TypedDict):
creatorModeControl: CreatorModeControlType, # (1)
ErrorDetailTypeDef#
# ErrorDetailTypeDef definition
class ErrorDetailTypeDef(TypedDict):
errorCode: NotRequired[ErrorCodeType], # (1)
errorMessage: NotRequired[str],
- See ErrorCodeType
AttachmentsConfigurationTypeDef#
# AttachmentsConfigurationTypeDef definition
class AttachmentsConfigurationTypeDef(TypedDict):
attachmentsControlMode: AttachmentsControlModeType, # (1)
BasicAuthConfigurationTypeDef#
# BasicAuthConfigurationTypeDef definition
class BasicAuthConfigurationTypeDef(TypedDict):
roleArn: str,
secretArn: str,
DeleteDocumentTypeDef#
# DeleteDocumentTypeDef definition
class DeleteDocumentTypeDef(TypedDict):
documentId: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
BlockedPhrasesConfigurationTypeDef#
# BlockedPhrasesConfigurationTypeDef definition
class BlockedPhrasesConfigurationTypeDef(TypedDict):
blockedPhrases: NotRequired[List[str]],
systemMessageOverride: NotRequired[str],
BlockedPhrasesConfigurationUpdateTypeDef#
# BlockedPhrasesConfigurationUpdateTypeDef definition
class BlockedPhrasesConfigurationUpdateTypeDef(TypedDict):
blockedPhrasesToCreateOrUpdate: NotRequired[Sequence[str]],
blockedPhrasesToDelete: NotRequired[Sequence[str]],
systemMessageOverride: NotRequired[str],
PluginConfigurationTypeDef#
# PluginConfigurationTypeDef definition
class PluginConfigurationTypeDef(TypedDict):
pluginId: str,
ContentBlockerRuleTypeDef#
# ContentBlockerRuleTypeDef definition
class ContentBlockerRuleTypeDef(TypedDict):
systemMessageOverride: NotRequired[str],
EligibleDataSourceTypeDef#
# EligibleDataSourceTypeDef definition
class EligibleDataSourceTypeDef(TypedDict):
dataSourceId: NotRequired[str],
indexId: NotRequired[str],
ConversationTypeDef#
# ConversationTypeDef definition
class ConversationTypeDef(TypedDict):
conversationId: NotRequired[str],
startTime: NotRequired[datetime],
title: NotRequired[str],
EncryptionConfigurationTypeDef#
# EncryptionConfigurationTypeDef definition
class EncryptionConfigurationTypeDef(TypedDict):
kmsKeyId: NotRequired[str],
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,
DataSourceVpcConfigurationTypeDef#
# DataSourceVpcConfigurationTypeDef definition
class DataSourceVpcConfigurationTypeDef(TypedDict):
securityGroupIds: Sequence[str],
subnetIds: Sequence[str],
IndexCapacityConfigurationTypeDef#
# IndexCapacityConfigurationTypeDef definition
class IndexCapacityConfigurationTypeDef(TypedDict):
units: NotRequired[int],
UserAliasTypeDef#
# UserAliasTypeDef definition
class UserAliasTypeDef(TypedDict):
userId: str,
dataSourceId: NotRequired[str],
indexId: NotRequired[str],
CreatorModeConfigurationTypeDef#
# CreatorModeConfigurationTypeDef definition
class CreatorModeConfigurationTypeDef(TypedDict):
creatorModeControl: CreatorModeControlType, # (1)
DataSourceSyncJobMetricsTypeDef#
# DataSourceSyncJobMetricsTypeDef definition
class DataSourceSyncJobMetricsTypeDef(TypedDict):
documentsAdded: NotRequired[str],
documentsDeleted: NotRequired[str],
documentsFailed: NotRequired[str],
documentsModified: NotRequired[str],
documentsScanned: NotRequired[str],
DataSourceTypeDef#
# DataSourceTypeDef definition
class DataSourceTypeDef(TypedDict):
createdAt: NotRequired[datetime],
dataSourceId: NotRequired[str],
displayName: NotRequired[str],
status: NotRequired[DataSourceStatusType], # (1)
type: NotRequired[str],
updatedAt: NotRequired[datetime],
DataSourceVpcConfigurationOutputTypeDef#
# DataSourceVpcConfigurationOutputTypeDef definition
class DataSourceVpcConfigurationOutputTypeDef(TypedDict):
securityGroupIds: List[str],
subnetIds: List[str],
DateAttributeBoostingConfigurationTypeDef#
# DateAttributeBoostingConfigurationTypeDef definition
class DateAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
boostingDurationInSeconds: NotRequired[int],
DeleteApplicationRequestRequestTypeDef#
# DeleteApplicationRequestRequestTypeDef definition
class DeleteApplicationRequestRequestTypeDef(TypedDict):
applicationId: str,
DeleteChatControlsConfigurationRequestRequestTypeDef#
# DeleteChatControlsConfigurationRequestRequestTypeDef definition
class DeleteChatControlsConfigurationRequestRequestTypeDef(TypedDict):
applicationId: str,
DeleteConversationRequestRequestTypeDef#
# DeleteConversationRequestRequestTypeDef definition
class DeleteConversationRequestRequestTypeDef(TypedDict):
applicationId: str,
conversationId: str,
userId: NotRequired[str],
DeleteDataSourceRequestRequestTypeDef#
# DeleteDataSourceRequestRequestTypeDef definition
class DeleteDataSourceRequestRequestTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
DeleteGroupRequestRequestTypeDef#
# DeleteGroupRequestRequestTypeDef definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
applicationId: str,
groupName: str,
indexId: str,
dataSourceId: NotRequired[str],
DeleteIndexRequestRequestTypeDef#
# DeleteIndexRequestRequestTypeDef definition
class DeleteIndexRequestRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
DeletePluginRequestRequestTypeDef#
# DeletePluginRequestRequestTypeDef definition
class DeletePluginRequestRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,
DeleteRetrieverRequestRequestTypeDef#
# DeleteRetrieverRequestRequestTypeDef definition
class DeleteRetrieverRequestRequestTypeDef(TypedDict):
applicationId: str,
retrieverId: str,
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
applicationId: str,
userId: str,
DeleteWebExperienceRequestRequestTypeDef#
# DeleteWebExperienceRequestRequestTypeDef definition
class DeleteWebExperienceRequestRequestTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,
NumberAttributeBoostingConfigurationTypeDef#
# NumberAttributeBoostingConfigurationTypeDef definition
class NumberAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
boostingType: NotRequired[NumberAttributeBoostingTypeType], # (2)
StringAttributeBoostingConfigurationOutputTypeDef#
# StringAttributeBoostingConfigurationOutputTypeDef definition
class StringAttributeBoostingConfigurationOutputTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (2)
attributeValueBoosting: NotRequired[Dict[str, StringAttributeValueBoostingLevelType]], # (1)
StringListAttributeBoostingConfigurationTypeDef#
# StringListAttributeBoostingConfigurationTypeDef definition
class StringListAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
StringAttributeBoostingConfigurationTypeDef#
# StringAttributeBoostingConfigurationTypeDef definition
class StringAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (2)
attributeValueBoosting: NotRequired[Mapping[str, StringAttributeValueBoostingLevelType]], # (1)
DocumentAttributeValueOutputTypeDef#
# DocumentAttributeValueOutputTypeDef definition
class DocumentAttributeValueOutputTypeDef(TypedDict):
dateValue: NotRequired[datetime],
longValue: NotRequired[int],
stringListValue: NotRequired[List[str]],
stringValue: NotRequired[str],
DocumentAttributeConfigurationTypeDef#
# DocumentAttributeConfigurationTypeDef definition
class DocumentAttributeConfigurationTypeDef(TypedDict):
name: NotRequired[str],
search: NotRequired[StatusType], # (1)
type: NotRequired[AttributeTypeType], # (2)
- See StatusType
- See AttributeTypeType
S3TypeDef#
# S3TypeDef definition
class S3TypeDef(TypedDict):
bucket: str,
key: str,
GetApplicationRequestRequestTypeDef#
# GetApplicationRequestRequestTypeDef definition
class GetApplicationRequestRequestTypeDef(TypedDict):
applicationId: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetChatControlsConfigurationRequestRequestTypeDef#
# GetChatControlsConfigurationRequestRequestTypeDef definition
class GetChatControlsConfigurationRequestRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
GetDataSourceRequestRequestTypeDef#
# GetDataSourceRequestRequestTypeDef definition
class GetDataSourceRequestRequestTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
GetGroupRequestRequestTypeDef#
# GetGroupRequestRequestTypeDef definition
class GetGroupRequestRequestTypeDef(TypedDict):
applicationId: str,
groupName: str,
indexId: str,
dataSourceId: NotRequired[str],
GetIndexRequestRequestTypeDef#
# GetIndexRequestRequestTypeDef definition
class GetIndexRequestRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
GetPluginRequestRequestTypeDef#
# GetPluginRequestRequestTypeDef definition
class GetPluginRequestRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,
GetRetrieverRequestRequestTypeDef#
# GetRetrieverRequestRequestTypeDef definition
class GetRetrieverRequestRequestTypeDef(TypedDict):
applicationId: str,
retrieverId: str,
GetUserRequestRequestTypeDef#
# GetUserRequestRequestTypeDef definition
class GetUserRequestRequestTypeDef(TypedDict):
applicationId: str,
userId: str,
GetWebExperienceRequestRequestTypeDef#
# GetWebExperienceRequestRequestTypeDef definition
class GetWebExperienceRequestRequestTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,
MemberGroupTypeDef#
# MemberGroupTypeDef definition
class MemberGroupTypeDef(TypedDict):
groupName: str,
type: NotRequired[MembershipTypeType], # (1)
MemberUserTypeDef#
# MemberUserTypeDef definition
class MemberUserTypeDef(TypedDict):
userId: str,
type: NotRequired[MembershipTypeType], # (1)
GroupSummaryTypeDef#
# GroupSummaryTypeDef definition
class GroupSummaryTypeDef(TypedDict):
groupName: NotRequired[str],
TextDocumentStatisticsTypeDef#
# TextDocumentStatisticsTypeDef definition
class TextDocumentStatisticsTypeDef(TypedDict):
indexedTextBytes: NotRequired[int],
indexedTextDocumentCount: NotRequired[int],
IndexTypeDef#
# IndexTypeDef definition
class IndexTypeDef(TypedDict):
createdAt: NotRequired[datetime],
displayName: NotRequired[str],
indexId: NotRequired[str],
status: NotRequired[IndexStatusType], # (1)
updatedAt: NotRequired[datetime],
- See IndexStatusType
KendraIndexConfigurationTypeDef#
# KendraIndexConfigurationTypeDef definition
class KendraIndexConfigurationTypeDef(TypedDict):
indexId: str,
ListApplicationsRequestRequestTypeDef#
# ListApplicationsRequestRequestTypeDef definition
class ListApplicationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListConversationsRequestRequestTypeDef#
# ListConversationsRequestRequestTypeDef definition
class ListConversationsRequestRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
userId: NotRequired[str],
ListDataSourcesRequestRequestTypeDef#
# ListDataSourcesRequestRequestTypeDef definition
class ListDataSourcesRequestRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDocumentsRequestRequestTypeDef#
# ListDocumentsRequestRequestTypeDef definition
class ListDocumentsRequestRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceIds: NotRequired[Sequence[str]],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListIndicesRequestRequestTypeDef#
# ListIndicesRequestRequestTypeDef definition
class ListIndicesRequestRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListMessagesRequestRequestTypeDef#
# ListMessagesRequestRequestTypeDef definition
class ListMessagesRequestRequestTypeDef(TypedDict):
applicationId: str,
conversationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
userId: NotRequired[str],
ListPluginsRequestRequestTypeDef#
# ListPluginsRequestRequestTypeDef definition
class ListPluginsRequestRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
PluginTypeDef#
# PluginTypeDef definition
class PluginTypeDef(TypedDict):
createdAt: NotRequired[datetime],
displayName: NotRequired[str],
pluginId: NotRequired[str],
serverUrl: NotRequired[str],
state: NotRequired[PluginStateType], # (1)
type: NotRequired[PluginTypeType], # (2)
updatedAt: NotRequired[datetime],
- See PluginStateType
- See PluginTypeType
ListRetrieversRequestRequestTypeDef#
# ListRetrieversRequestRequestTypeDef definition
class ListRetrieversRequestRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
RetrieverTypeDef#
# RetrieverTypeDef definition
class RetrieverTypeDef(TypedDict):
applicationId: NotRequired[str],
displayName: NotRequired[str],
retrieverId: NotRequired[str],
status: NotRequired[RetrieverStatusType], # (1)
type: NotRequired[RetrieverTypeType], # (2)
- See RetrieverStatusType
- See RetrieverTypeType
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
ListWebExperiencesRequestRequestTypeDef#
# ListWebExperiencesRequestRequestTypeDef definition
class ListWebExperiencesRequestRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
WebExperienceTypeDef#
# WebExperienceTypeDef definition
class WebExperienceTypeDef(TypedDict):
createdAt: NotRequired[datetime],
defaultEndpoint: NotRequired[str],
status: NotRequired[WebExperienceStatusType], # (1)
updatedAt: NotRequired[datetime],
webExperienceId: NotRequired[str],
OAuth2ClientCredentialConfigurationTypeDef#
# OAuth2ClientCredentialConfigurationTypeDef definition
class OAuth2ClientCredentialConfigurationTypeDef(TypedDict):
roleArn: str,
secretArn: str,
PrincipalGroupTypeDef#
# PrincipalGroupTypeDef definition
class PrincipalGroupTypeDef(TypedDict):
access: ReadAccessTypeType, # (1)
membershipType: NotRequired[MembershipTypeType], # (2)
name: NotRequired[str],
- See ReadAccessTypeType
- See MembershipTypeType
PrincipalUserTypeDef#
# PrincipalUserTypeDef definition
class PrincipalUserTypeDef(TypedDict):
access: ReadAccessTypeType, # (1)
id: NotRequired[str],
membershipType: NotRequired[MembershipTypeType], # (2)
- See ReadAccessTypeType
- See MembershipTypeType
UsersAndGroupsExtraOutputTypeDef#
# UsersAndGroupsExtraOutputTypeDef definition
class UsersAndGroupsExtraOutputTypeDef(TypedDict):
userGroups: NotRequired[List[str]],
userIds: NotRequired[List[str]],
UsersAndGroupsOutputTypeDef#
# UsersAndGroupsOutputTypeDef definition
class UsersAndGroupsOutputTypeDef(TypedDict):
userGroups: NotRequired[List[str]],
userIds: NotRequired[List[str]],
UsersAndGroupsTypeDef#
# UsersAndGroupsTypeDef definition
class UsersAndGroupsTypeDef(TypedDict):
userGroups: NotRequired[Sequence[str]],
userIds: NotRequired[Sequence[str]],
SamlConfigurationTypeDef#
# SamlConfigurationTypeDef definition
class SamlConfigurationTypeDef(TypedDict):
metadataXML: str,
roleArn: str,
userIdAttribute: str,
userGroupAttribute: NotRequired[str],
TextSegmentTypeDef#
# TextSegmentTypeDef definition
class TextSegmentTypeDef(TypedDict):
beginOffset: NotRequired[int],
endOffset: NotRequired[int],
StartDataSourceSyncJobRequestRequestTypeDef#
# StartDataSourceSyncJobRequestRequestTypeDef definition
class StartDataSourceSyncJobRequestRequestTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
StopDataSourceSyncJobRequestRequestTypeDef#
# StopDataSourceSyncJobRequestRequestTypeDef definition
class StopDataSourceSyncJobRequestRequestTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
ActionExecutionExtraOutputTypeDef#
# ActionExecutionExtraOutputTypeDef definition
class ActionExecutionExtraOutputTypeDef(TypedDict):
payload: Dict[str, ActionExecutionPayloadFieldExtraOutputTypeDef], # (1)
payloadFieldNameSeparator: str,
pluginId: str,
ActionExecutionOutputTypeDef#
# ActionExecutionOutputTypeDef definition
class ActionExecutionOutputTypeDef(TypedDict):
payload: Dict[str, ActionExecutionPayloadFieldOutputTypeDef], # (1)
payloadFieldNameSeparator: str,
pluginId: str,
ActionExecutionTypeDef#
# ActionExecutionTypeDef definition
class ActionExecutionTypeDef(TypedDict):
payload: Mapping[str, ActionExecutionPayloadFieldTypeDef], # (1)
payloadFieldNameSeparator: str,
pluginId: str,
ActionReviewPayloadFieldTypeDef#
# ActionReviewPayloadFieldTypeDef definition
class ActionReviewPayloadFieldTypeDef(TypedDict):
allowedValues: NotRequired[List[ActionReviewPayloadFieldAllowedValueTypeDef]], # (1)
displayName: NotRequired[str],
displayOrder: NotRequired[int],
required: NotRequired[bool],
type: NotRequired[ActionPayloadFieldTypeType], # (2)
value: NotRequired[Dict[str, Any]],
AttachmentInputTypeDef#
# AttachmentInputTypeDef definition
class AttachmentInputTypeDef(TypedDict):
data: Union[str, bytes, IO[Any], StreamingBody],
name: str,
AttachmentOutputTypeDef#
# AttachmentOutputTypeDef definition
class AttachmentOutputTypeDef(TypedDict):
error: NotRequired[ErrorDetailTypeDef], # (1)
name: NotRequired[str],
status: NotRequired[AttachmentStatusType], # (2)
DocumentDetailsTypeDef#
# DocumentDetailsTypeDef definition
class DocumentDetailsTypeDef(TypedDict):
createdAt: NotRequired[datetime],
documentId: NotRequired[str],
error: NotRequired[ErrorDetailTypeDef], # (1)
status: NotRequired[DocumentStatusType], # (2)
updatedAt: NotRequired[datetime],
- See ErrorDetailTypeDef
- See DocumentStatusType
FailedDocumentTypeDef#
# FailedDocumentTypeDef definition
class FailedDocumentTypeDef(TypedDict):
dataSourceId: NotRequired[str],
error: NotRequired[ErrorDetailTypeDef], # (1)
id: NotRequired[str],
GroupStatusDetailTypeDef#
# GroupStatusDetailTypeDef definition
class GroupStatusDetailTypeDef(TypedDict):
errorDetail: NotRequired[ErrorDetailTypeDef], # (1)
lastUpdatedAt: NotRequired[datetime],
status: NotRequired[GroupStatusType], # (2)
- See ErrorDetailTypeDef
- See GroupStatusType
UpdateApplicationRequestRequestTypeDef#
# UpdateApplicationRequestRequestTypeDef definition
class UpdateApplicationRequestRequestTypeDef(TypedDict):
applicationId: str,
attachmentsConfiguration: NotRequired[AttachmentsConfigurationTypeDef], # (1)
description: NotRequired[str],
displayName: NotRequired[str],
roleArn: NotRequired[str],
BatchDeleteDocumentRequestRequestTypeDef#
# BatchDeleteDocumentRequestRequestTypeDef definition
class BatchDeleteDocumentRequestRequestTypeDef(TypedDict):
applicationId: str,
documents: Sequence[DeleteDocumentTypeDef], # (1)
indexId: str,
dataSourceSyncId: NotRequired[str],
CreateApplicationResponseTypeDef#
# CreateApplicationResponseTypeDef definition
class CreateApplicationResponseTypeDef(TypedDict):
applicationArn: str,
applicationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDataSourceResponseTypeDef#
# CreateDataSourceResponseTypeDef definition
class CreateDataSourceResponseTypeDef(TypedDict):
dataSourceArn: str,
dataSourceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIndexResponseTypeDef#
# CreateIndexResponseTypeDef definition
class CreateIndexResponseTypeDef(TypedDict):
indexArn: str,
indexId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePluginResponseTypeDef#
# CreatePluginResponseTypeDef definition
class CreatePluginResponseTypeDef(TypedDict):
pluginArn: str,
pluginId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRetrieverResponseTypeDef#
# CreateRetrieverResponseTypeDef definition
class CreateRetrieverResponseTypeDef(TypedDict):
retrieverArn: str,
retrieverId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWebExperienceResponseTypeDef#
# CreateWebExperienceResponseTypeDef definition
class CreateWebExperienceResponseTypeDef(TypedDict):
webExperienceArn: str,
webExperienceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListApplicationsResponseTypeDef#
# ListApplicationsResponseTypeDef definition
class ListApplicationsResponseTypeDef(TypedDict):
applications: List[ApplicationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartDataSourceSyncJobResponseTypeDef#
# StartDataSourceSyncJobResponseTypeDef definition
class StartDataSourceSyncJobResponseTypeDef(TypedDict):
executionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ChatModeConfigurationTypeDef#
# ChatModeConfigurationTypeDef definition
class ChatModeConfigurationTypeDef(TypedDict):
pluginConfiguration: NotRequired[PluginConfigurationTypeDef], # (1)
ContentRetrievalRuleExtraOutputTypeDef#
# ContentRetrievalRuleExtraOutputTypeDef definition
class ContentRetrievalRuleExtraOutputTypeDef(TypedDict):
eligibleDataSources: NotRequired[List[EligibleDataSourceTypeDef]], # (1)
ContentRetrievalRuleOutputTypeDef#
# ContentRetrievalRuleOutputTypeDef definition
class ContentRetrievalRuleOutputTypeDef(TypedDict):
eligibleDataSources: NotRequired[List[EligibleDataSourceTypeDef]], # (1)
ContentRetrievalRuleTypeDef#
# ContentRetrievalRuleTypeDef definition
class ContentRetrievalRuleTypeDef(TypedDict):
eligibleDataSources: NotRequired[Sequence[EligibleDataSourceTypeDef]], # (1)
ListConversationsResponseTypeDef#
# ListConversationsResponseTypeDef definition
class ListConversationsResponseTypeDef(TypedDict):
conversations: List[ConversationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetApplicationResponseTypeDef#
# GetApplicationResponseTypeDef definition
class GetApplicationResponseTypeDef(TypedDict):
applicationArn: str,
applicationId: str,
attachmentsConfiguration: AppliedAttachmentsConfigurationTypeDef, # (1)
createdAt: datetime,
description: str,
displayName: str,
encryptionConfiguration: EncryptionConfigurationTypeDef, # (2)
error: ErrorDetailTypeDef, # (3)
identityCenterApplicationArn: str,
roleArn: str,
status: ApplicationStatusType, # (4)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See AppliedAttachmentsConfigurationTypeDef
- See EncryptionConfigurationTypeDef
- See ErrorDetailTypeDef
- See ApplicationStatusType
- See ResponseMetadataTypeDef
CreateApplicationRequestRequestTypeDef#
# CreateApplicationRequestRequestTypeDef definition
class CreateApplicationRequestRequestTypeDef(TypedDict):
displayName: str,
roleArn: str,
attachmentsConfiguration: NotRequired[AttachmentsConfigurationTypeDef], # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef], # (2)
identityCenterInstanceArn: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (3)
CreateWebExperienceRequestRequestTypeDef#
# CreateWebExperienceRequestRequestTypeDef definition
class CreateWebExperienceRequestRequestTypeDef(TypedDict):
applicationId: str,
clientToken: NotRequired[str],
roleArn: NotRequired[str],
samplePromptsControlMode: NotRequired[WebExperienceSamplePromptsControlModeType], # (1)
subtitle: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
title: NotRequired[str],
welcomeMessage: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateIndexRequestRequestTypeDef#
# CreateIndexRequestRequestTypeDef definition
class CreateIndexRequestRequestTypeDef(TypedDict):
applicationId: str,
displayName: str,
capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef], # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef definition
class CreateUserRequestRequestTypeDef(TypedDict):
applicationId: str,
userId: str,
clientToken: NotRequired[str],
userAliases: NotRequired[Sequence[UserAliasTypeDef]], # (1)
- See UserAliasTypeDef
GetUserResponseTypeDef#
# GetUserResponseTypeDef definition
class GetUserResponseTypeDef(TypedDict):
userAliases: List[UserAliasTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateUserRequestRequestTypeDef#
# UpdateUserRequestRequestTypeDef definition
class UpdateUserRequestRequestTypeDef(TypedDict):
applicationId: str,
userId: str,
userAliasesToDelete: NotRequired[Sequence[UserAliasTypeDef]], # (1)
userAliasesToUpdate: NotRequired[Sequence[UserAliasTypeDef]], # (1)
- See UserAliasTypeDef
- See UserAliasTypeDef
UpdateUserResponseTypeDef#
# UpdateUserResponseTypeDef definition
class UpdateUserResponseTypeDef(TypedDict):
userAliasesAdded: List[UserAliasTypeDef], # (1)
userAliasesDeleted: List[UserAliasTypeDef], # (1)
userAliasesUpdated: List[UserAliasTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See UserAliasTypeDef
- See UserAliasTypeDef
- See UserAliasTypeDef
- See ResponseMetadataTypeDef
DataSourceSyncJobTypeDef#
# DataSourceSyncJobTypeDef definition
class DataSourceSyncJobTypeDef(TypedDict):
dataSourceErrorCode: NotRequired[str],
endTime: NotRequired[datetime],
error: NotRequired[ErrorDetailTypeDef], # (1)
executionId: NotRequired[str],
metrics: NotRequired[DataSourceSyncJobMetricsTypeDef], # (2)
startTime: NotRequired[datetime],
status: NotRequired[DataSourceSyncJobStatusType], # (3)
ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
dataSources: List[DataSourceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DocumentAttributeBoostingConfigurationOutputTypeDef#
# DocumentAttributeBoostingConfigurationOutputTypeDef definition
class DocumentAttributeBoostingConfigurationOutputTypeDef(TypedDict):
dateConfiguration: NotRequired[DateAttributeBoostingConfigurationTypeDef], # (1)
numberConfiguration: NotRequired[NumberAttributeBoostingConfigurationTypeDef], # (2)
stringConfiguration: NotRequired[StringAttributeBoostingConfigurationOutputTypeDef], # (3)
stringListConfiguration: NotRequired[StringListAttributeBoostingConfigurationTypeDef], # (4)
- See DateAttributeBoostingConfigurationTypeDef
- See NumberAttributeBoostingConfigurationTypeDef
- See StringAttributeBoostingConfigurationOutputTypeDef
- See StringListAttributeBoostingConfigurationTypeDef
DocumentAttributeBoostingConfigurationTypeDef#
# DocumentAttributeBoostingConfigurationTypeDef definition
class DocumentAttributeBoostingConfigurationTypeDef(TypedDict):
dateConfiguration: NotRequired[DateAttributeBoostingConfigurationTypeDef], # (1)
numberConfiguration: NotRequired[NumberAttributeBoostingConfigurationTypeDef], # (2)
stringConfiguration: NotRequired[StringAttributeBoostingConfigurationTypeDef], # (3)
stringListConfiguration: NotRequired[StringListAttributeBoostingConfigurationTypeDef], # (4)
- See DateAttributeBoostingConfigurationTypeDef
- See NumberAttributeBoostingConfigurationTypeDef
- See StringAttributeBoostingConfigurationTypeDef
- See StringListAttributeBoostingConfigurationTypeDef
DocumentAttributeConditionOutputTypeDef#
# DocumentAttributeConditionOutputTypeDef definition
class DocumentAttributeConditionOutputTypeDef(TypedDict):
key: str,
operator: DocumentEnrichmentConditionOperatorType, # (1)
value: NotRequired[DocumentAttributeValueOutputTypeDef], # (2)
DocumentAttributeTargetOutputTypeDef#
# DocumentAttributeTargetOutputTypeDef definition
class DocumentAttributeTargetOutputTypeDef(TypedDict):
key: str,
attributeValueOperator: NotRequired[AttributeValueOperatorType], # (1)
value: NotRequired[DocumentAttributeValueOutputTypeDef], # (2)
UpdateIndexRequestRequestTypeDef#
# UpdateIndexRequestRequestTypeDef definition
class UpdateIndexRequestRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef], # (1)
description: NotRequired[str],
displayName: NotRequired[str],
documentAttributeConfigurations: NotRequired[Sequence[DocumentAttributeConfigurationTypeDef]], # (2)
DocumentAttributeValueTypeDef#
# DocumentAttributeValueTypeDef definition
class DocumentAttributeValueTypeDef(TypedDict):
dateValue: NotRequired[Union[datetime, str]],
longValue: NotRequired[int],
stringListValue: NotRequired[Sequence[str]],
stringValue: NotRequired[str],
ListDataSourceSyncJobsRequestRequestTypeDef#
# ListDataSourceSyncJobsRequestRequestTypeDef definition
class ListDataSourceSyncJobsRequestRequestTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
endTime: NotRequired[Union[datetime, str]],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
statusFilter: NotRequired[DataSourceSyncJobStatusType], # (1)
ListGroupsRequestRequestTypeDef#
# ListGroupsRequestRequestTypeDef definition
class ListGroupsRequestRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
updatedEarlierThan: Union[datetime, str],
dataSourceId: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
MessageUsefulnessFeedbackTypeDef#
# MessageUsefulnessFeedbackTypeDef definition
class MessageUsefulnessFeedbackTypeDef(TypedDict):
submittedAt: Union[datetime, str],
usefulness: MessageUsefulnessType, # (2)
comment: NotRequired[str],
reason: NotRequired[MessageUsefulnessReasonType], # (1)
DocumentContentTypeDef#
# DocumentContentTypeDef definition
class DocumentContentTypeDef(TypedDict):
blob: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
s3: NotRequired[S3TypeDef], # (1)
- See S3TypeDef
GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef#
# GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef definition
class GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListApplicationsRequestListApplicationsPaginateTypeDef#
# ListApplicationsRequestListApplicationsPaginateTypeDef definition
class ListApplicationsRequestListApplicationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListConversationsRequestListConversationsPaginateTypeDef#
# ListConversationsRequestListConversationsPaginateTypeDef definition
class ListConversationsRequestListConversationsPaginateTypeDef(TypedDict):
applicationId: str,
userId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef#
# ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef definition
class ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
endTime: NotRequired[Union[datetime, str]],
startTime: NotRequired[Union[datetime, str]],
statusFilter: NotRequired[DataSourceSyncJobStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListDataSourcesRequestListDataSourcesPaginateTypeDef#
# ListDataSourcesRequestListDataSourcesPaginateTypeDef definition
class ListDataSourcesRequestListDataSourcesPaginateTypeDef(TypedDict):
applicationId: str,
indexId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDocumentsRequestListDocumentsPaginateTypeDef#
# ListDocumentsRequestListDocumentsPaginateTypeDef definition
class ListDocumentsRequestListDocumentsPaginateTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupsRequestListGroupsPaginateTypeDef#
# ListGroupsRequestListGroupsPaginateTypeDef definition
class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
applicationId: str,
indexId: str,
updatedEarlierThan: Union[datetime, str],
dataSourceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIndicesRequestListIndicesPaginateTypeDef#
# ListIndicesRequestListIndicesPaginateTypeDef definition
class ListIndicesRequestListIndicesPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListMessagesRequestListMessagesPaginateTypeDef#
# ListMessagesRequestListMessagesPaginateTypeDef definition
class ListMessagesRequestListMessagesPaginateTypeDef(TypedDict):
applicationId: str,
conversationId: str,
userId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPluginsRequestListPluginsPaginateTypeDef#
# ListPluginsRequestListPluginsPaginateTypeDef definition
class ListPluginsRequestListPluginsPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRetrieversRequestListRetrieversPaginateTypeDef#
# ListRetrieversRequestListRetrieversPaginateTypeDef definition
class ListRetrieversRequestListRetrieversPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWebExperiencesRequestListWebExperiencesPaginateTypeDef#
# ListWebExperiencesRequestListWebExperiencesPaginateTypeDef definition
class ListWebExperiencesRequestListWebExperiencesPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GroupMembersTypeDef#
# GroupMembersTypeDef definition
class GroupMembersTypeDef(TypedDict):
memberGroups: NotRequired[Sequence[MemberGroupTypeDef]], # (1)
memberUsers: NotRequired[Sequence[MemberUserTypeDef]], # (2)
- See MemberGroupTypeDef
- See MemberUserTypeDef
ListGroupsResponseTypeDef#
# ListGroupsResponseTypeDef definition
class ListGroupsResponseTypeDef(TypedDict):
items: List[GroupSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
IndexStatisticsTypeDef#
# IndexStatisticsTypeDef definition
class IndexStatisticsTypeDef(TypedDict):
textDocumentStatistics: NotRequired[TextDocumentStatisticsTypeDef], # (1)
ListIndicesResponseTypeDef#
# ListIndicesResponseTypeDef definition
class ListIndicesResponseTypeDef(TypedDict):
indices: List[IndexTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See IndexTypeDef
- See ResponseMetadataTypeDef
ListPluginsResponseTypeDef#
# ListPluginsResponseTypeDef definition
class ListPluginsResponseTypeDef(TypedDict):
nextToken: str,
plugins: List[PluginTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See PluginTypeDef
- See ResponseMetadataTypeDef
ListRetrieversResponseTypeDef#
# ListRetrieversResponseTypeDef definition
class ListRetrieversResponseTypeDef(TypedDict):
nextToken: str,
retrievers: List[RetrieverTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWebExperiencesResponseTypeDef#
# ListWebExperiencesResponseTypeDef definition
class ListWebExperiencesResponseTypeDef(TypedDict):
nextToken: str,
webExperiences: List[WebExperienceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PluginAuthConfigurationTypeDef#
# PluginAuthConfigurationTypeDef definition
class PluginAuthConfigurationTypeDef(TypedDict):
basicAuthConfiguration: NotRequired[BasicAuthConfigurationTypeDef], # (1)
oAuth2ClientCredentialConfiguration: NotRequired[OAuth2ClientCredentialConfigurationTypeDef], # (2)
PrincipalTypeDef#
# PrincipalTypeDef definition
class PrincipalTypeDef(TypedDict):
group: NotRequired[PrincipalGroupTypeDef], # (1)
user: NotRequired[PrincipalUserTypeDef], # (2)
WebExperienceAuthConfigurationTypeDef#
# WebExperienceAuthConfigurationTypeDef definition
class WebExperienceAuthConfigurationTypeDef(TypedDict):
samlConfiguration: NotRequired[SamlConfigurationTypeDef], # (1)
SourceAttributionTypeDef#
# SourceAttributionTypeDef definition
class SourceAttributionTypeDef(TypedDict):
citationNumber: NotRequired[int],
snippet: NotRequired[str],
textMessageSegments: NotRequired[List[TextSegmentTypeDef]], # (1)
title: NotRequired[str],
updatedAt: NotRequired[datetime],
url: NotRequired[str],
ActionReviewTypeDef#
# ActionReviewTypeDef definition
class ActionReviewTypeDef(TypedDict):
payload: NotRequired[Dict[str, ActionReviewPayloadFieldTypeDef]], # (1)
payloadFieldNameSeparator: NotRequired[str],
pluginId: NotRequired[str],
pluginType: NotRequired[PluginTypeType], # (2)
ListDocumentsResponseTypeDef#
# ListDocumentsResponseTypeDef definition
class ListDocumentsResponseTypeDef(TypedDict):
documentDetailList: List[DocumentDetailsTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDeleteDocumentResponseTypeDef#
# BatchDeleteDocumentResponseTypeDef definition
class BatchDeleteDocumentResponseTypeDef(TypedDict):
failedDocuments: List[FailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchPutDocumentResponseTypeDef#
# BatchPutDocumentResponseTypeDef definition
class BatchPutDocumentResponseTypeDef(TypedDict):
failedDocuments: List[FailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetGroupResponseTypeDef#
# GetGroupResponseTypeDef definition
class GetGroupResponseTypeDef(TypedDict):
status: GroupStatusDetailTypeDef, # (1)
statusHistory: List[GroupStatusDetailTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ChatSyncInputRequestTypeDef#
# ChatSyncInputRequestTypeDef definition
class ChatSyncInputRequestTypeDef(TypedDict):
applicationId: str,
actionExecution: NotRequired[ActionExecutionTypeDef], # (1)
attachments: NotRequired[Sequence[AttachmentInputTypeDef]], # (2)
attributeFilter: NotRequired[AttributeFilterTypeDef], # (3)
chatMode: NotRequired[ChatModeType], # (4)
chatModeConfiguration: NotRequired[ChatModeConfigurationTypeDef], # (5)
clientToken: NotRequired[str],
conversationId: NotRequired[str],
parentMessageId: NotRequired[str],
userGroups: NotRequired[Sequence[str]],
userId: NotRequired[str],
userMessage: NotRequired[str],
- See ActionExecutionTypeDef
- See AttachmentInputTypeDef
- See AttributeFilterTypeDef
- See ChatModeType
- See ChatModeConfigurationTypeDef
RuleConfigurationExtraOutputTypeDef#
# RuleConfigurationExtraOutputTypeDef definition
class RuleConfigurationExtraOutputTypeDef(TypedDict):
contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef], # (1)
contentRetrievalRule: NotRequired[ContentRetrievalRuleExtraOutputTypeDef], # (2)
RuleConfigurationOutputTypeDef#
# RuleConfigurationOutputTypeDef definition
class RuleConfigurationOutputTypeDef(TypedDict):
contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef], # (1)
contentRetrievalRule: NotRequired[ContentRetrievalRuleOutputTypeDef], # (2)
RuleConfigurationTypeDef#
# RuleConfigurationTypeDef definition
class RuleConfigurationTypeDef(TypedDict):
contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef], # (1)
contentRetrievalRule: NotRequired[ContentRetrievalRuleTypeDef], # (2)
ListDataSourceSyncJobsResponseTypeDef#
# ListDataSourceSyncJobsResponseTypeDef definition
class ListDataSourceSyncJobsResponseTypeDef(TypedDict):
history: List[DataSourceSyncJobTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NativeIndexConfigurationOutputTypeDef#
# NativeIndexConfigurationOutputTypeDef definition
class NativeIndexConfigurationOutputTypeDef(TypedDict):
indexId: str,
boostingOverride: NotRequired[Dict[str, DocumentAttributeBoostingConfigurationOutputTypeDef]], # (1)
NativeIndexConfigurationTypeDef#
# NativeIndexConfigurationTypeDef definition
class NativeIndexConfigurationTypeDef(TypedDict):
indexId: str,
boostingOverride: NotRequired[Mapping[str, DocumentAttributeBoostingConfigurationTypeDef]], # (1)
HookConfigurationOutputTypeDef#
# HookConfigurationOutputTypeDef definition
class HookConfigurationOutputTypeDef(TypedDict):
invocationCondition: NotRequired[DocumentAttributeConditionOutputTypeDef], # (1)
lambdaArn: NotRequired[str],
roleArn: NotRequired[str],
s3BucketName: NotRequired[str],
InlineDocumentEnrichmentConfigurationOutputTypeDef#
# InlineDocumentEnrichmentConfigurationOutputTypeDef definition
class InlineDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
condition: NotRequired[DocumentAttributeConditionOutputTypeDef], # (1)
documentContentOperator: NotRequired[DocumentContentOperatorType], # (2)
target: NotRequired[DocumentAttributeTargetOutputTypeDef], # (3)
- See DocumentAttributeConditionOutputTypeDef
- See DocumentContentOperatorType
- See DocumentAttributeTargetOutputTypeDef
DocumentAttributeConditionTypeDef#
# DocumentAttributeConditionTypeDef definition
class DocumentAttributeConditionTypeDef(TypedDict):
key: str,
operator: DocumentEnrichmentConditionOperatorType, # (1)
value: NotRequired[DocumentAttributeValueTypeDef], # (2)
DocumentAttributeTargetTypeDef#
# DocumentAttributeTargetTypeDef definition
class DocumentAttributeTargetTypeDef(TypedDict):
key: str,
attributeValueOperator: NotRequired[AttributeValueOperatorType], # (1)
value: NotRequired[DocumentAttributeValueTypeDef], # (2)
DocumentAttributeTypeDef#
# DocumentAttributeTypeDef definition
class DocumentAttributeTypeDef(TypedDict):
name: str,
value: DocumentAttributeValueTypeDef, # (1)
PutFeedbackRequestRequestTypeDef#
# PutFeedbackRequestRequestTypeDef definition
class PutFeedbackRequestRequestTypeDef(TypedDict):
applicationId: str,
conversationId: str,
messageId: str,
messageCopiedAt: NotRequired[Union[datetime, str]],
messageUsefulness: NotRequired[MessageUsefulnessFeedbackTypeDef], # (1)
userId: NotRequired[str],
PutGroupRequestRequestTypeDef#
# PutGroupRequestRequestTypeDef definition
class PutGroupRequestRequestTypeDef(TypedDict):
applicationId: str,
groupMembers: GroupMembersTypeDef, # (1)
groupName: str,
indexId: str,
type: MembershipTypeType, # (2)
dataSourceId: NotRequired[str],
GetIndexResponseTypeDef#
# GetIndexResponseTypeDef definition
class GetIndexResponseTypeDef(TypedDict):
applicationId: str,
capacityConfiguration: IndexCapacityConfigurationTypeDef, # (1)
createdAt: datetime,
description: str,
displayName: str,
documentAttributeConfigurations: List[DocumentAttributeConfigurationTypeDef], # (2)
error: ErrorDetailTypeDef, # (3)
indexArn: str,
indexId: str,
indexStatistics: IndexStatisticsTypeDef, # (4)
status: IndexStatusType, # (5)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See IndexCapacityConfigurationTypeDef
- See DocumentAttributeConfigurationTypeDef
- See ErrorDetailTypeDef
- See IndexStatisticsTypeDef
- See IndexStatusType
- See ResponseMetadataTypeDef
CreatePluginRequestRequestTypeDef#
# CreatePluginRequestRequestTypeDef definition
class CreatePluginRequestRequestTypeDef(TypedDict):
applicationId: str,
authConfiguration: PluginAuthConfigurationTypeDef, # (1)
displayName: str,
serverUrl: str,
type: PluginTypeType, # (2)
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See PluginAuthConfigurationTypeDef
- See PluginTypeType
- See TagTypeDef
GetPluginResponseTypeDef#
# GetPluginResponseTypeDef definition
class GetPluginResponseTypeDef(TypedDict):
applicationId: str,
authConfiguration: PluginAuthConfigurationTypeDef, # (1)
createdAt: datetime,
displayName: str,
pluginArn: str,
pluginId: str,
serverUrl: str,
state: PluginStateType, # (2)
type: PluginTypeType, # (3)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See PluginAuthConfigurationTypeDef
- See PluginStateType
- See PluginTypeType
- See ResponseMetadataTypeDef
UpdatePluginRequestRequestTypeDef#
# UpdatePluginRequestRequestTypeDef definition
class UpdatePluginRequestRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,
authConfiguration: NotRequired[PluginAuthConfigurationTypeDef], # (1)
displayName: NotRequired[str],
serverUrl: NotRequired[str],
state: NotRequired[PluginStateType], # (2)
AccessControlTypeDef#
# AccessControlTypeDef definition
class AccessControlTypeDef(TypedDict):
principals: Sequence[PrincipalTypeDef], # (2)
memberRelation: NotRequired[MemberRelationType], # (1)
- See MemberRelationType
- See PrincipalTypeDef
GetWebExperienceResponseTypeDef#
# GetWebExperienceResponseTypeDef definition
class GetWebExperienceResponseTypeDef(TypedDict):
applicationId: str,
authenticationConfiguration: WebExperienceAuthConfigurationTypeDef, # (1)
createdAt: datetime,
defaultEndpoint: str,
error: ErrorDetailTypeDef, # (2)
roleArn: str,
samplePromptsControlMode: WebExperienceSamplePromptsControlModeType, # (3)
status: WebExperienceStatusType, # (4)
subtitle: str,
title: str,
updatedAt: datetime,
webExperienceArn: str,
webExperienceId: str,
welcomeMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See WebExperienceAuthConfigurationTypeDef
- See ErrorDetailTypeDef
- See WebExperienceSamplePromptsControlModeType
- See WebExperienceStatusType
- See ResponseMetadataTypeDef
UpdateWebExperienceRequestRequestTypeDef#
# UpdateWebExperienceRequestRequestTypeDef definition
class UpdateWebExperienceRequestRequestTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,
authenticationConfiguration: NotRequired[WebExperienceAuthConfigurationTypeDef], # (1)
samplePromptsControlMode: NotRequired[WebExperienceSamplePromptsControlModeType], # (2)
subtitle: NotRequired[str],
title: NotRequired[str],
welcomeMessage: NotRequired[str],
ChatSyncOutputTypeDef#
# ChatSyncOutputTypeDef definition
class ChatSyncOutputTypeDef(TypedDict):
actionReview: ActionReviewTypeDef, # (1)
conversationId: str,
failedAttachments: List[AttachmentOutputTypeDef], # (2)
sourceAttributions: List[SourceAttributionTypeDef], # (3)
systemMessage: str,
systemMessageId: str,
userMessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ActionReviewTypeDef
- See AttachmentOutputTypeDef
- See SourceAttributionTypeDef
- See ResponseMetadataTypeDef
MessageTypeDef#
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
actionExecution: NotRequired[ActionExecutionOutputTypeDef], # (1)
actionReview: NotRequired[ActionReviewTypeDef], # (2)
attachments: NotRequired[List[AttachmentOutputTypeDef]], # (3)
body: NotRequired[str],
messageId: NotRequired[str],
sourceAttribution: NotRequired[List[SourceAttributionTypeDef]], # (4)
time: NotRequired[datetime],
type: NotRequired[MessageTypeType], # (5)
- See ActionExecutionOutputTypeDef
- See ActionReviewTypeDef
- See AttachmentOutputTypeDef
- See SourceAttributionTypeDef
- See MessageTypeType
RuleExtraOutputTypeDef#
# RuleExtraOutputTypeDef definition
class RuleExtraOutputTypeDef(TypedDict):
ruleType: RuleTypeType, # (4)
excludedUsersAndGroups: NotRequired[UsersAndGroupsExtraOutputTypeDef], # (1)
includedUsersAndGroups: NotRequired[UsersAndGroupsExtraOutputTypeDef], # (1)
ruleConfiguration: NotRequired[RuleConfigurationExtraOutputTypeDef], # (3)
- See UsersAndGroupsExtraOutputTypeDef
- See UsersAndGroupsExtraOutputTypeDef
- See RuleConfigurationExtraOutputTypeDef
- See RuleTypeType
RuleOutputTypeDef#
# RuleOutputTypeDef definition
class RuleOutputTypeDef(TypedDict):
ruleType: RuleTypeType, # (4)
excludedUsersAndGroups: NotRequired[UsersAndGroupsOutputTypeDef], # (1)
includedUsersAndGroups: NotRequired[UsersAndGroupsOutputTypeDef], # (1)
ruleConfiguration: NotRequired[RuleConfigurationOutputTypeDef], # (3)
- See UsersAndGroupsOutputTypeDef
- See UsersAndGroupsOutputTypeDef
- See RuleConfigurationOutputTypeDef
- See RuleTypeType
RuleTypeDef#
# RuleTypeDef definition
class RuleTypeDef(TypedDict):
ruleType: RuleTypeType, # (4)
excludedUsersAndGroups: NotRequired[UsersAndGroupsTypeDef], # (1)
includedUsersAndGroups: NotRequired[UsersAndGroupsTypeDef], # (1)
ruleConfiguration: NotRequired[RuleConfigurationTypeDef], # (3)
RetrieverConfigurationOutputTypeDef#
# RetrieverConfigurationOutputTypeDef definition
class RetrieverConfigurationOutputTypeDef(TypedDict):
kendraIndexConfiguration: NotRequired[KendraIndexConfigurationTypeDef], # (1)
nativeIndexConfiguration: NotRequired[NativeIndexConfigurationOutputTypeDef], # (2)
RetrieverConfigurationTypeDef#
# RetrieverConfigurationTypeDef definition
class RetrieverConfigurationTypeDef(TypedDict):
kendraIndexConfiguration: NotRequired[KendraIndexConfigurationTypeDef], # (1)
nativeIndexConfiguration: NotRequired[NativeIndexConfigurationTypeDef], # (2)
DocumentEnrichmentConfigurationOutputTypeDef#
# DocumentEnrichmentConfigurationOutputTypeDef definition
class DocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
inlineConfigurations: NotRequired[List[InlineDocumentEnrichmentConfigurationOutputTypeDef]], # (1)
postExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef], # (2)
preExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef], # (2)
- See InlineDocumentEnrichmentConfigurationOutputTypeDef
- See HookConfigurationOutputTypeDef
- See HookConfigurationOutputTypeDef
HookConfigurationTypeDef#
# HookConfigurationTypeDef definition
class HookConfigurationTypeDef(TypedDict):
invocationCondition: NotRequired[DocumentAttributeConditionTypeDef], # (1)
lambdaArn: NotRequired[str],
roleArn: NotRequired[str],
s3BucketName: NotRequired[str],
InlineDocumentEnrichmentConfigurationTypeDef#
# InlineDocumentEnrichmentConfigurationTypeDef definition
class InlineDocumentEnrichmentConfigurationTypeDef(TypedDict):
condition: NotRequired[DocumentAttributeConditionTypeDef], # (1)
documentContentOperator: NotRequired[DocumentContentOperatorType], # (2)
target: NotRequired[DocumentAttributeTargetTypeDef], # (3)
- See DocumentAttributeConditionTypeDef
- See DocumentContentOperatorType
- See DocumentAttributeTargetTypeDef
AttributeFilterTypeDef#
# AttributeFilterTypeDef definition
class AttributeFilterTypeDef(TypedDict):
andAllFilters: NotRequired[Sequence[Dict[str, Any]]],
containsAll: NotRequired[DocumentAttributeTypeDef], # (1)
containsAny: NotRequired[DocumentAttributeTypeDef], # (1)
equalsTo: NotRequired[DocumentAttributeTypeDef], # (1)
greaterThan: NotRequired[DocumentAttributeTypeDef], # (1)
greaterThanOrEquals: NotRequired[DocumentAttributeTypeDef], # (1)
lessThan: NotRequired[DocumentAttributeTypeDef], # (1)
lessThanOrEquals: NotRequired[DocumentAttributeTypeDef], # (1)
notFilter: NotRequired[Dict[str, Any]],
orAllFilters: NotRequired[Sequence[Dict[str, Any]]],
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
AccessConfigurationTypeDef#
# AccessConfigurationTypeDef definition
class AccessConfigurationTypeDef(TypedDict):
accessControls: Sequence[AccessControlTypeDef], # (1)
memberRelation: NotRequired[MemberRelationType], # (2)
ListMessagesResponseTypeDef#
# ListMessagesResponseTypeDef definition
class ListMessagesResponseTypeDef(TypedDict):
messages: List[MessageTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TopicConfigurationExtraOutputTypeDef#
# TopicConfigurationExtraOutputTypeDef definition
class TopicConfigurationExtraOutputTypeDef(TypedDict):
name: str,
rules: List[RuleExtraOutputTypeDef], # (1)
description: NotRequired[str],
exampleChatMessages: NotRequired[List[str]],
TopicConfigurationOutputTypeDef#
# TopicConfigurationOutputTypeDef definition
class TopicConfigurationOutputTypeDef(TypedDict):
name: str,
rules: List[RuleOutputTypeDef], # (1)
description: NotRequired[str],
exampleChatMessages: NotRequired[List[str]],
TopicConfigurationTypeDef#
# TopicConfigurationTypeDef definition
class TopicConfigurationTypeDef(TypedDict):
name: str,
rules: Sequence[RuleTypeDef], # (1)
description: NotRequired[str],
exampleChatMessages: NotRequired[Sequence[str]],
- See RuleTypeDef
GetRetrieverResponseTypeDef#
# GetRetrieverResponseTypeDef definition
class GetRetrieverResponseTypeDef(TypedDict):
applicationId: str,
configuration: RetrieverConfigurationOutputTypeDef, # (1)
createdAt: datetime,
displayName: str,
retrieverArn: str,
retrieverId: str,
roleArn: str,
status: RetrieverStatusType, # (2)
type: RetrieverTypeType, # (3)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See RetrieverConfigurationOutputTypeDef
- See RetrieverStatusType
- See RetrieverTypeType
- See ResponseMetadataTypeDef
CreateRetrieverRequestRequestTypeDef#
# CreateRetrieverRequestRequestTypeDef definition
class CreateRetrieverRequestRequestTypeDef(TypedDict):
applicationId: str,
configuration: RetrieverConfigurationTypeDef, # (1)
displayName: str,
type: RetrieverTypeType, # (2)
clientToken: NotRequired[str],
roleArn: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See RetrieverConfigurationTypeDef
- See RetrieverTypeType
- See TagTypeDef
UpdateRetrieverRequestRequestTypeDef#
# UpdateRetrieverRequestRequestTypeDef definition
class UpdateRetrieverRequestRequestTypeDef(TypedDict):
applicationId: str,
retrieverId: str,
configuration: NotRequired[RetrieverConfigurationTypeDef], # (1)
displayName: NotRequired[str],
roleArn: NotRequired[str],
GetDataSourceResponseTypeDef#
# GetDataSourceResponseTypeDef definition
class GetDataSourceResponseTypeDef(TypedDict):
applicationId: str,
configuration: Dict[str, Any],
createdAt: datetime,
dataSourceArn: str,
dataSourceId: str,
description: str,
displayName: str,
documentEnrichmentConfiguration: DocumentEnrichmentConfigurationOutputTypeDef, # (1)
error: ErrorDetailTypeDef, # (2)
indexId: str,
roleArn: str,
status: DataSourceStatusType, # (3)
syncSchedule: str,
type: str,
updatedAt: datetime,
vpcConfiguration: DataSourceVpcConfigurationOutputTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DocumentEnrichmentConfigurationOutputTypeDef
- See ErrorDetailTypeDef
- See DataSourceStatusType
- See DataSourceVpcConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
DocumentEnrichmentConfigurationTypeDef#
# DocumentEnrichmentConfigurationTypeDef definition
class DocumentEnrichmentConfigurationTypeDef(TypedDict):
inlineConfigurations: NotRequired[Sequence[InlineDocumentEnrichmentConfigurationTypeDef]], # (1)
postExtractionHookConfiguration: NotRequired[HookConfigurationTypeDef], # (2)
preExtractionHookConfiguration: NotRequired[HookConfigurationTypeDef], # (2)
- See InlineDocumentEnrichmentConfigurationTypeDef
- See HookConfigurationTypeDef
- See HookConfigurationTypeDef
GetChatControlsConfigurationResponseTypeDef#
# GetChatControlsConfigurationResponseTypeDef definition
class GetChatControlsConfigurationResponseTypeDef(TypedDict):
blockedPhrases: BlockedPhrasesConfigurationTypeDef, # (1)
creatorModeConfiguration: AppliedCreatorModeConfigurationTypeDef, # (2)
nextToken: str,
responseScope: ResponseScopeType, # (3)
topicConfigurations: List[TopicConfigurationOutputTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See BlockedPhrasesConfigurationTypeDef
- See AppliedCreatorModeConfigurationTypeDef
- See ResponseScopeType
- See TopicConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
CreateDataSourceRequestRequestTypeDef#
# CreateDataSourceRequestRequestTypeDef definition
class CreateDataSourceRequestRequestTypeDef(TypedDict):
applicationId: str,
configuration: Mapping[str, Any],
displayName: str,
indexId: str,
clientToken: NotRequired[str],
description: NotRequired[str],
documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationTypeDef], # (1)
roleArn: NotRequired[str],
syncSchedule: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
vpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (3)
DocumentTypeDef#
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
id: str,
accessConfiguration: NotRequired[AccessConfigurationTypeDef], # (1)
attributes: NotRequired[Sequence[DocumentAttributeTypeDef]], # (2)
content: NotRequired[DocumentContentTypeDef], # (3)
contentType: NotRequired[ContentTypeType], # (4)
documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationTypeDef], # (5)
title: NotRequired[str],
- See AccessConfigurationTypeDef
- See DocumentAttributeTypeDef
- See DocumentContentTypeDef
- See ContentTypeType
- See DocumentEnrichmentConfigurationTypeDef
UpdateDataSourceRequestRequestTypeDef#
# UpdateDataSourceRequestRequestTypeDef definition
class UpdateDataSourceRequestRequestTypeDef(TypedDict):
applicationId: str,
dataSourceId: str,
indexId: str,
configuration: NotRequired[Mapping[str, Any]],
description: NotRequired[str],
displayName: NotRequired[str],
documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationTypeDef], # (1)
roleArn: NotRequired[str],
syncSchedule: NotRequired[str],
vpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (2)
UpdateChatControlsConfigurationRequestRequestTypeDef#
# UpdateChatControlsConfigurationRequestRequestTypeDef definition
class UpdateChatControlsConfigurationRequestRequestTypeDef(TypedDict):
applicationId: str,
blockedPhrasesConfigurationUpdate: NotRequired[BlockedPhrasesConfigurationUpdateTypeDef], # (1)
clientToken: NotRequired[str],
creatorModeConfiguration: NotRequired[CreatorModeConfigurationTypeDef], # (2)
responseScope: NotRequired[ResponseScopeType], # (3)
topicConfigurationsToCreateOrUpdate: NotRequired[Sequence[Union[TopicConfigurationTypeDef, TopicConfigurationExtraOutputTypeDef]]], # (4)
topicConfigurationsToDelete: NotRequired[Sequence[Union[TopicConfigurationTypeDef, TopicConfigurationExtraOutputTypeDef]]], # (4)
- See BlockedPhrasesConfigurationUpdateTypeDef
- See CreatorModeConfigurationTypeDef
- See ResponseScopeType
- See TopicConfigurationTypeDef TopicConfigurationExtraOutputTypeDef
- See TopicConfigurationTypeDef TopicConfigurationExtraOutputTypeDef
BatchPutDocumentRequestRequestTypeDef#
# BatchPutDocumentRequestRequestTypeDef definition
class BatchPutDocumentRequestRequestTypeDef(TypedDict):
applicationId: str,
documents: Sequence[DocumentTypeDef], # (1)
indexId: str,
dataSourceSyncId: NotRequired[str],
roleArn: NotRequired[str],
- See DocumentTypeDef