Type definitions#

Index > QBusiness > Type definitions

Auto-generated documentation for QBusiness type annotations stubs module types-boto3-qbusiness.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ActionExecutionPayloadFieldUnionTypeDef#

# ActionExecutionPayloadFieldUnionTypeDef definition

ActionExecutionPayloadFieldUnionTypeDef = Union[
    ActionExecutionPayloadFieldTypeDef,  # (1)
    ActionExecutionPayloadFieldOutputTypeDef,  # (2)
]

StringAttributeBoostingConfigurationUnionTypeDef#

# StringAttributeBoostingConfigurationUnionTypeDef definition

StringAttributeBoostingConfigurationUnionTypeDef = Union[
    StringAttributeBoostingConfigurationTypeDef,  # (1)
    StringAttributeBoostingConfigurationOutputTypeDef,  # (2)
]

UsersAndGroupsUnionTypeDef#

# UsersAndGroupsUnionTypeDef definition

UsersAndGroupsUnionTypeDef = Union[
    UsersAndGroupsTypeDef,  # (1)
    UsersAndGroupsOutputTypeDef,  # (2)
]

See UsersAndGroupsTypeDef
See UsersAndGroupsOutputTypeDef

ContentRetrievalRuleUnionTypeDef#

# ContentRetrievalRuleUnionTypeDef definition

ContentRetrievalRuleUnionTypeDef = Union[
    ContentRetrievalRuleTypeDef,  # (1)
    ContentRetrievalRuleOutputTypeDef,  # (2)
]

DocumentAttributeValueUnionTypeDef#

# DocumentAttributeValueUnionTypeDef definition

DocumentAttributeValueUnionTypeDef = Union[
    DocumentAttributeValueTypeDef,  # (1)
    DocumentAttributeValueOutputTypeDef,  # (2)
]

DocumentAttributeBoostingConfigurationUnionTypeDef#

# DocumentAttributeBoostingConfigurationUnionTypeDef definition

DocumentAttributeBoostingConfigurationUnionTypeDef = Union[
    DocumentAttributeBoostingConfigurationTypeDef,  # (1)
    DocumentAttributeBoostingConfigurationOutputTypeDef,  # (2)
]

RuleConfigurationUnionTypeDef#

# RuleConfigurationUnionTypeDef definition

RuleConfigurationUnionTypeDef = Union[
    RuleConfigurationTypeDef,  # (1)
    RuleConfigurationOutputTypeDef,  # (2)
]

See RuleConfigurationTypeDef
See RuleConfigurationOutputTypeDef

DocumentAttributeConditionUnionTypeDef#

# DocumentAttributeConditionUnionTypeDef definition

DocumentAttributeConditionUnionTypeDef = Union[
    DocumentAttributeConditionTypeDef,  # (1)
    DocumentAttributeConditionOutputTypeDef,  # (2)
]

DocumentAttributeTargetUnionTypeDef#

# DocumentAttributeTargetUnionTypeDef definition

DocumentAttributeTargetUnionTypeDef = Union[
    DocumentAttributeTargetTypeDef,  # (1)
    DocumentAttributeTargetOutputTypeDef,  # (2)
]

DocumentAttributeUnionTypeDef#

# DocumentAttributeUnionTypeDef definition

DocumentAttributeUnionTypeDef = Union[
    DocumentAttributeTypeDef,  # (1)
    DocumentAttributeOutputTypeDef,  # (2)
]

See DocumentAttributeTypeDef
See DocumentAttributeOutputTypeDef

NativeIndexConfigurationUnionTypeDef#

# NativeIndexConfigurationUnionTypeDef definition

NativeIndexConfigurationUnionTypeDef = Union[
    NativeIndexConfigurationTypeDef,  # (1)
    NativeIndexConfigurationOutputTypeDef,  # (2)
]

RuleUnionTypeDef#

# RuleUnionTypeDef definition

RuleUnionTypeDef = Union[
    RuleTypeDef,  # (1)
    RuleOutputTypeDef,  # (2)
]

See RuleTypeDef
See RuleOutputTypeDef

HookConfigurationUnionTypeDef#

# HookConfigurationUnionTypeDef definition

HookConfigurationUnionTypeDef = Union[
    HookConfigurationTypeDef,  # (1)
    HookConfigurationOutputTypeDef,  # (2)
]

See HookConfigurationTypeDef
See HookConfigurationOutputTypeDef

InlineDocumentEnrichmentConfigurationUnionTypeDef#

# InlineDocumentEnrichmentConfigurationUnionTypeDef definition

InlineDocumentEnrichmentConfigurationUnionTypeDef = Union[
    InlineDocumentEnrichmentConfigurationTypeDef,  # (1)
    InlineDocumentEnrichmentConfigurationOutputTypeDef,  # (2)
]

AttributeFilterUnionTypeDef#

# AttributeFilterUnionTypeDef definition

AttributeFilterUnionTypeDef = Union[
    AttributeFilterTypeDef,  # (1)
    AttributeFilterOutputTypeDef,  # (2)
]

See AttributeFilterTypeDef
See AttributeFilterOutputTypeDef

TopicConfigurationUnionTypeDef#

# TopicConfigurationUnionTypeDef definition

TopicConfigurationUnionTypeDef = Union[
    TopicConfigurationTypeDef,  # (1)
    TopicConfigurationOutputTypeDef,  # (2)
]

See TopicConfigurationTypeDef
See TopicConfigurationOutputTypeDef

DocumentEnrichmentConfigurationUnionTypeDef#

# DocumentEnrichmentConfigurationUnionTypeDef definition

DocumentEnrichmentConfigurationUnionTypeDef = Union[
    DocumentEnrichmentConfigurationTypeDef,  # (1)
    DocumentEnrichmentConfigurationOutputTypeDef,  # (2)
]

ActionFilterConfigurationUnionTypeDef#

# ActionFilterConfigurationUnionTypeDef definition

ActionFilterConfigurationUnionTypeDef = Union[
    ActionFilterConfigurationTypeDef,  # (1)
    ActionFilterConfigurationOutputTypeDef,  # (2)
]

ActionConfigurationUnionTypeDef#

# ActionConfigurationUnionTypeDef definition

ActionConfigurationUnionTypeDef = Union[
    ActionConfigurationTypeDef,  # (1)
    ActionConfigurationOutputTypeDef,  # (2)
]

S3TypeDef#

# S3TypeDef definition

class S3TypeDef(TypedDict):
    bucket: str,
    key: str,

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):
    value: NotRequired[dict[str, Any]],
    displayValue: NotRequired[dict[str, Any]],

ActionSummaryTypeDef#

# ActionSummaryTypeDef definition

class ActionSummaryTypeDef(TypedDict):
    actionIdentifier: NotRequired[str],
    displayName: NotRequired[str],
    instructionExample: NotRequired[str],
    description: NotRequired[str],

QuickSightConfigurationTypeDef#

# QuickSightConfigurationTypeDef definition

class QuickSightConfigurationTypeDef(TypedDict):
    clientNamespace: str,

AppliedAttachmentsConfigurationTypeDef#

# AppliedAttachmentsConfigurationTypeDef definition

class AppliedAttachmentsConfigurationTypeDef(TypedDict):
    attachmentsControlMode: NotRequired[AttachmentsControlModeType],  # (1)

See AttachmentsControlModeType

AppliedCreatorModeConfigurationTypeDef#

# AppliedCreatorModeConfigurationTypeDef definition

class AppliedCreatorModeConfigurationTypeDef(TypedDict):
    creatorModeControl: CreatorModeControlType,  # (1)

See CreatorModeControlType

AssociatePermissionRequestRequestTypeDef#

# AssociatePermissionRequestRequestTypeDef definition

class AssociatePermissionRequestRequestTypeDef(TypedDict):
    applicationId: str,
    statementId: str,
    actions: Sequence[str],
    principal: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ErrorDetailTypeDef#

# ErrorDetailTypeDef definition

class ErrorDetailTypeDef(TypedDict):
    errorMessage: NotRequired[str],
    errorCode: NotRequired[ErrorCodeType],  # (1)

See ErrorCodeType

AttachmentsConfigurationTypeDef#

# AttachmentsConfigurationTypeDef definition

class AttachmentsConfigurationTypeDef(TypedDict):
    attachmentsControlMode: AttachmentsControlModeType,  # (1)

See AttachmentsControlModeType

AuthChallengeRequestEventTypeDef#

# AuthChallengeRequestEventTypeDef definition

class AuthChallengeRequestEventTypeDef(TypedDict):
    authorizationUrl: str,

AuthChallengeRequestTypeDef#

# AuthChallengeRequestTypeDef definition

class AuthChallengeRequestTypeDef(TypedDict):
    authorizationUrl: str,

AuthChallengeResponseEventTypeDef#

# AuthChallengeResponseEventTypeDef definition

class AuthChallengeResponseEventTypeDef(TypedDict):
    responseMap: Mapping[str, str],

AuthChallengeResponseTypeDef#

# AuthChallengeResponseTypeDef definition

class AuthChallengeResponseTypeDef(TypedDict):
    responseMap: Mapping[str, str],

AutoSubscriptionConfigurationTypeDef#

# AutoSubscriptionConfigurationTypeDef definition

class AutoSubscriptionConfigurationTypeDef(TypedDict):
    autoSubscribe: AutoSubscriptionStatusType,  # (1)
    defaultSubscriptionType: NotRequired[SubscriptionTypeType],  # (2)

See AutoSubscriptionStatusType
See SubscriptionTypeType

BasicAuthConfigurationTypeDef#

# BasicAuthConfigurationTypeDef definition

class BasicAuthConfigurationTypeDef(TypedDict):
    secretArn: str,
    roleArn: str,

DeleteDocumentTypeDef#

# DeleteDocumentTypeDef definition

class DeleteDocumentTypeDef(TypedDict):
    documentId: 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],

BrowserExtensionConfigurationOutputTypeDef#

# BrowserExtensionConfigurationOutputTypeDef definition

class BrowserExtensionConfigurationOutputTypeDef(TypedDict):
    enabledBrowserExtensions: list[BrowserExtensionType],  # (1)

See BrowserExtensionType

BrowserExtensionConfigurationTypeDef#

# BrowserExtensionConfigurationTypeDef definition

class BrowserExtensionConfigurationTypeDef(TypedDict):
    enabledBrowserExtensions: Sequence[BrowserExtensionType],  # (1)

See BrowserExtensionType

TextInputEventTypeDef#

# TextInputEventTypeDef definition

class TextInputEventTypeDef(TypedDict):
    userMessage: str,

PluginConfigurationTypeDef#

# PluginConfigurationTypeDef definition

class PluginConfigurationTypeDef(TypedDict):
    pluginId: str,

TextOutputEventTypeDef#

# TextOutputEventTypeDef definition

class TextOutputEventTypeDef(TypedDict):
    conversationId: NotRequired[str],
    userMessageId: NotRequired[str],
    systemMessageId: NotRequired[str],
    systemMessage: NotRequired[str],

ContentBlockerRuleTypeDef#

# ContentBlockerRuleTypeDef definition

class ContentBlockerRuleTypeDef(TypedDict):
    systemMessageOverride: NotRequired[str],

EligibleDataSourceTypeDef#

# EligibleDataSourceTypeDef definition

class EligibleDataSourceTypeDef(TypedDict):
    indexId: NotRequired[str],
    dataSourceId: NotRequired[str],

RetrieverContentSourceTypeDef#

# RetrieverContentSourceTypeDef definition

class RetrieverContentSourceTypeDef(TypedDict):
    retrieverId: str,

ConversationSourceTypeDef#

# ConversationSourceTypeDef definition

class ConversationSourceTypeDef(TypedDict):
    conversationId: str,
    attachmentId: str,

ConversationTypeDef#

# ConversationTypeDef definition

class ConversationTypeDef(TypedDict):
    conversationId: NotRequired[str],
    title: NotRequired[str],
    startTime: NotRequired[datetime],

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    kmsKeyId: NotRequired[str],

PersonalizationConfigurationTypeDef#

# PersonalizationConfigurationTypeDef definition

class PersonalizationConfigurationTypeDef(TypedDict):
    personalizationControlMode: PersonalizationControlModeType,  # (1)

See PersonalizationControlModeType

QAppsConfigurationTypeDef#

# QAppsConfigurationTypeDef definition

class QAppsConfigurationTypeDef(TypedDict):
    qAppsControlMode: QAppsControlModeType,  # (1)

See QAppsControlModeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

DataSourceVpcConfigurationTypeDef#

# DataSourceVpcConfigurationTypeDef definition

class DataSourceVpcConfigurationTypeDef(TypedDict):
    subnetIds: Sequence[str],
    securityGroupIds: Sequence[str],

IndexCapacityConfigurationTypeDef#

# IndexCapacityConfigurationTypeDef definition

class IndexCapacityConfigurationTypeDef(TypedDict):
    units: NotRequired[int],

UserAliasTypeDef#

# UserAliasTypeDef definition

class UserAliasTypeDef(TypedDict):
    userId: str,
    indexId: NotRequired[str],
    dataSourceId: NotRequired[str],

CustomizationConfigurationTypeDef#

# CustomizationConfigurationTypeDef definition

class CustomizationConfigurationTypeDef(TypedDict):
    customCSSUrl: NotRequired[str],
    logoUrl: NotRequired[str],
    fontUrl: NotRequired[str],
    faviconUrl: NotRequired[str],

CreatorModeConfigurationTypeDef#

# CreatorModeConfigurationTypeDef definition

class CreatorModeConfigurationTypeDef(TypedDict):
    creatorModeControl: CreatorModeControlType,  # (1)

See CreatorModeControlType

DataAccessorTypeDef#

# DataAccessorTypeDef definition

class DataAccessorTypeDef(TypedDict):
    displayName: NotRequired[str],
    dataAccessorId: NotRequired[str],
    dataAccessorArn: NotRequired[str],
    idcApplicationArn: NotRequired[str],
    principal: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],

DataSourceSyncJobMetricsTypeDef#

# DataSourceSyncJobMetricsTypeDef definition

class DataSourceSyncJobMetricsTypeDef(TypedDict):
    documentsAdded: NotRequired[str],
    documentsModified: NotRequired[str],
    documentsDeleted: NotRequired[str],
    documentsFailed: NotRequired[str],
    documentsScanned: NotRequired[str],

DataSourceTypeDef#

# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    displayName: NotRequired[str],
    dataSourceId: NotRequired[str],
    type: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    status: NotRequired[DataSourceStatusType],  # (1)

See DataSourceStatusType

DataSourceVpcConfigurationOutputTypeDef#

# DataSourceVpcConfigurationOutputTypeDef definition

class DataSourceVpcConfigurationOutputTypeDef(TypedDict):
    subnetIds: list[str],
    securityGroupIds: list[str],

DateAttributeBoostingConfigurationTypeDef#

# DateAttributeBoostingConfigurationTypeDef definition

class DateAttributeBoostingConfigurationTypeDef(TypedDict):
    boostingLevel: DocumentAttributeBoostingLevelType,  # (1)
    boostingDurationInSeconds: NotRequired[int],

See DocumentAttributeBoostingLevelType

DeleteApplicationRequestRequestTypeDef#

# DeleteApplicationRequestRequestTypeDef definition

class DeleteApplicationRequestRequestTypeDef(TypedDict):
    applicationId: str,

DeleteChatControlsConfigurationRequestRequestTypeDef#

# DeleteChatControlsConfigurationRequestRequestTypeDef definition

class DeleteChatControlsConfigurationRequestRequestTypeDef(TypedDict):
    applicationId: str,

DeleteConversationRequestRequestTypeDef#

# DeleteConversationRequestRequestTypeDef definition

class DeleteConversationRequestRequestTypeDef(TypedDict):
    conversationId: str,
    applicationId: str,
    userId: NotRequired[str],

DeleteDataAccessorRequestRequestTypeDef#

# DeleteDataAccessorRequestRequestTypeDef definition

class DeleteDataAccessorRequestRequestTypeDef(TypedDict):
    applicationId: str,
    dataAccessorId: str,

DeleteDataSourceRequestRequestTypeDef#

# DeleteDataSourceRequestRequestTypeDef definition

class DeleteDataSourceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    dataSourceId: str,

DeleteGroupRequestRequestTypeDef#

# DeleteGroupRequestRequestTypeDef definition

class DeleteGroupRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    groupName: 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,

DisassociatePermissionRequestRequestTypeDef#

# DisassociatePermissionRequestRequestTypeDef definition

class DisassociatePermissionRequestRequestTypeDef(TypedDict):
    applicationId: str,
    statementId: str,

NumberAttributeBoostingConfigurationTypeDef#

# NumberAttributeBoostingConfigurationTypeDef definition

class NumberAttributeBoostingConfigurationTypeDef(TypedDict):
    boostingLevel: DocumentAttributeBoostingLevelType,  # (1)
    boostingType: NotRequired[NumberAttributeBoostingTypeType],  # (2)

StringAttributeBoostingConfigurationOutputTypeDef#

# StringAttributeBoostingConfigurationOutputTypeDef definition

class StringAttributeBoostingConfigurationOutputTypeDef(TypedDict):
    boostingLevel: DocumentAttributeBoostingLevelType,  # (1)
    attributeValueBoosting: NotRequired[dict[str, StringAttributeValueBoostingLevelType]],  # (2)

StringListAttributeBoostingConfigurationTypeDef#

# StringListAttributeBoostingConfigurationTypeDef definition

class StringListAttributeBoostingConfigurationTypeDef(TypedDict):
    boostingLevel: DocumentAttributeBoostingLevelType,  # (1)

See DocumentAttributeBoostingLevelType

DocumentAttributeValueOutputTypeDef#

# DocumentAttributeValueOutputTypeDef definition

class DocumentAttributeValueOutputTypeDef(TypedDict):
    stringValue: NotRequired[str],
    stringListValue: NotRequired[list[str]],
    longValue: NotRequired[int],
    dateValue: NotRequired[datetime],

DocumentAttributeConfigurationTypeDef#

# DocumentAttributeConfigurationTypeDef definition

class DocumentAttributeConfigurationTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[AttributeTypeType],  # (1)
    search: NotRequired[StatusType],  # (2)

See AttributeTypeType
See StatusType

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],

GetDataAccessorRequestRequestTypeDef#

# GetDataAccessorRequestRequestTypeDef definition

class GetDataAccessorRequestRequestTypeDef(TypedDict):
    applicationId: str,
    dataAccessorId: str,

GetDataSourceRequestRequestTypeDef#

# GetDataSourceRequestRequestTypeDef definition

class GetDataSourceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    dataSourceId: str,

GetGroupRequestRequestTypeDef#

# GetGroupRequestRequestTypeDef definition

class GetGroupRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    groupName: str,
    dataSourceId: NotRequired[str],

GetIndexRequestRequestTypeDef#

# GetIndexRequestRequestTypeDef definition

class GetIndexRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,

GetMediaRequestRequestTypeDef#

# GetMediaRequestRequestTypeDef definition

class GetMediaRequestRequestTypeDef(TypedDict):
    applicationId: str,
    conversationId: str,
    messageId: str,
    mediaId: str,

GetPluginRequestRequestTypeDef#

# GetPluginRequestRequestTypeDef definition

class GetPluginRequestRequestTypeDef(TypedDict):
    applicationId: str,
    pluginId: str,

GetPolicyRequestRequestTypeDef#

# GetPolicyRequestRequestTypeDef definition

class GetPolicyRequestRequestTypeDef(TypedDict):
    applicationId: 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)

See MembershipTypeType

MemberUserTypeDef#

# MemberUserTypeDef definition

class MemberUserTypeDef(TypedDict):
    userId: str,
    type: NotRequired[MembershipTypeType],  # (1)

See MembershipTypeType

GroupSummaryTypeDef#

# GroupSummaryTypeDef definition

class GroupSummaryTypeDef(TypedDict):
    groupName: NotRequired[str],

IdcAuthConfigurationTypeDef#

# IdcAuthConfigurationTypeDef definition

class IdcAuthConfigurationTypeDef(TypedDict):
    idcApplicationArn: str,
    roleArn: str,

OpenIDConnectProviderConfigurationTypeDef#

# OpenIDConnectProviderConfigurationTypeDef definition

class OpenIDConnectProviderConfigurationTypeDef(TypedDict):
    secretsArn: str,
    secretsRole: str,

SamlProviderConfigurationTypeDef#

# SamlProviderConfigurationTypeDef definition

class SamlProviderConfigurationTypeDef(TypedDict):
    authenticationUrl: str,

ImageExtractionConfigurationTypeDef#

# ImageExtractionConfigurationTypeDef definition

class ImageExtractionConfigurationTypeDef(TypedDict):
    imageExtractionStatus: ImageExtractionStatusType,  # (1)

See ImageExtractionStatusType

TextDocumentStatisticsTypeDef#

# TextDocumentStatisticsTypeDef definition

class TextDocumentStatisticsTypeDef(TypedDict):
    indexedTextBytes: NotRequired[int],
    indexedTextDocumentCount: NotRequired[int],

IndexTypeDef#

# IndexTypeDef definition

class IndexTypeDef(TypedDict):
    displayName: NotRequired[str],
    indexId: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    status: NotRequired[IndexStatusType],  # (1)

See IndexStatusType

KendraIndexConfigurationTypeDef#

# KendraIndexConfigurationTypeDef definition

class KendraIndexConfigurationTypeDef(TypedDict):
    indexId: str,

ListApplicationsRequestRequestTypeDef#

# ListApplicationsRequestRequestTypeDef definition

class ListApplicationsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListAttachmentsRequestRequestTypeDef#

# ListAttachmentsRequestRequestTypeDef definition

class ListAttachmentsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    conversationId: NotRequired[str],
    userId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListConversationsRequestRequestTypeDef#

# ListConversationsRequestRequestTypeDef definition

class ListConversationsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    userId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDataAccessorsRequestRequestTypeDef#

# ListDataAccessorsRequestRequestTypeDef definition

class ListDataAccessorsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDataSourcesRequestRequestTypeDef#

# ListDataSourcesRequestRequestTypeDef definition

class ListDataSourcesRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDocumentsRequestRequestTypeDef#

# ListDocumentsRequestRequestTypeDef definition

class ListDocumentsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    dataSourceIds: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListIndicesRequestRequestTypeDef#

# ListIndicesRequestRequestTypeDef definition

class ListIndicesRequestRequestTypeDef(TypedDict):
    applicationId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListMessagesRequestRequestTypeDef#

# ListMessagesRequestRequestTypeDef definition

class ListMessagesRequestRequestTypeDef(TypedDict):
    conversationId: str,
    applicationId: str,
    userId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPluginActionsRequestRequestTypeDef#

# ListPluginActionsRequestRequestTypeDef definition

class ListPluginActionsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    pluginId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPluginTypeActionsRequestRequestTypeDef#

# ListPluginTypeActionsRequestRequestTypeDef definition

class ListPluginTypeActionsRequestRequestTypeDef(TypedDict):
    pluginType: PluginTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

See PluginTypeType

ListPluginTypeMetadataRequestRequestTypeDef#

# ListPluginTypeMetadataRequestRequestTypeDef definition

class ListPluginTypeMetadataRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PluginTypeMetadataSummaryTypeDef#

# PluginTypeMetadataSummaryTypeDef definition

class PluginTypeMetadataSummaryTypeDef(TypedDict):
    type: NotRequired[PluginTypeType],  # (1)
    category: NotRequired[PluginTypeCategoryType],  # (2)
    description: NotRequired[str],

See PluginTypeType
See PluginTypeCategoryType

ListPluginsRequestRequestTypeDef#

# ListPluginsRequestRequestTypeDef definition

class ListPluginsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PluginTypeDef#

# PluginTypeDef definition

class PluginTypeDef(TypedDict):
    pluginId: NotRequired[str],
    displayName: NotRequired[str],
    type: NotRequired[PluginTypeType],  # (1)
    serverUrl: NotRequired[str],
    state: NotRequired[PluginStateType],  # (2)
    buildStatus: NotRequired[PluginBuildStatusType],  # (3)
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],

ListRetrieversRequestRequestTypeDef#

# ListRetrieversRequestRequestTypeDef definition

class ListRetrieversRequestRequestTypeDef(TypedDict):
    applicationId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

RetrieverTypeDef#

# RetrieverTypeDef definition

class RetrieverTypeDef(TypedDict):
    applicationId: NotRequired[str],
    retrieverId: NotRequired[str],
    type: NotRequired[RetrieverTypeType],  # (1)
    status: NotRequired[RetrieverStatusType],  # (2)
    displayName: NotRequired[str],

See RetrieverTypeType
See RetrieverStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,

ListWebExperiencesRequestRequestTypeDef#

# ListWebExperiencesRequestRequestTypeDef definition

class ListWebExperiencesRequestRequestTypeDef(TypedDict):
    applicationId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

WebExperienceTypeDef#

# WebExperienceTypeDef definition

class WebExperienceTypeDef(TypedDict):
    webExperienceId: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    defaultEndpoint: NotRequired[str],
    status: NotRequired[WebExperienceStatusType],  # (1)

See WebExperienceStatusType

OAuth2ClientCredentialConfigurationTypeDef#

# OAuth2ClientCredentialConfigurationTypeDef definition

class OAuth2ClientCredentialConfigurationTypeDef(TypedDict):
    secretArn: str,
    roleArn: str,
    authorizationUrl: NotRequired[str],
    tokenUrl: NotRequired[str],

PrincipalGroupTypeDef#

# PrincipalGroupTypeDef definition

class PrincipalGroupTypeDef(TypedDict):
    access: ReadAccessTypeType,  # (1)
    name: NotRequired[str],
    membershipType: NotRequired[MembershipTypeType],  # (2)

See ReadAccessTypeType
See MembershipTypeType

PrincipalUserTypeDef#

# PrincipalUserTypeDef definition

class PrincipalUserTypeDef(TypedDict):
    access: ReadAccessTypeType,  # (1)
    id: NotRequired[str],
    membershipType: NotRequired[MembershipTypeType],  # (2)

See ReadAccessTypeType
See MembershipTypeType

ScoreAttributesTypeDef#

# ScoreAttributesTypeDef definition

class ScoreAttributesTypeDef(TypedDict):
    scoreConfidence: NotRequired[ScoreConfidenceType],  # (1)

See ScoreConfidenceType

UsersAndGroupsOutputTypeDef#

# UsersAndGroupsOutputTypeDef definition

class UsersAndGroupsOutputTypeDef(TypedDict):
    userIds: NotRequired[list[str]],
    userGroups: NotRequired[list[str]],

SamlConfigurationTypeDef#

# SamlConfigurationTypeDef definition

class SamlConfigurationTypeDef(TypedDict):
    metadataXML: str,
    roleArn: str,
    userIdAttribute: str,
    userGroupAttribute: NotRequired[str],

SnippetExcerptTypeDef#

# SnippetExcerptTypeDef definition

class SnippetExcerptTypeDef(TypedDict):
    text: NotRequired[str],

StartDataSourceSyncJobRequestRequestTypeDef#

# StartDataSourceSyncJobRequestRequestTypeDef definition

class StartDataSourceSyncJobRequestRequestTypeDef(TypedDict):
    dataSourceId: str,
    applicationId: str,
    indexId: str,

StopDataSourceSyncJobRequestRequestTypeDef#

# StopDataSourceSyncJobRequestRequestTypeDef definition

class StopDataSourceSyncJobRequestRequestTypeDef(TypedDict):
    dataSourceId: str,
    applicationId: str,
    indexId: str,

StringAttributeBoostingConfigurationTypeDef#

# StringAttributeBoostingConfigurationTypeDef definition

class StringAttributeBoostingConfigurationTypeDef(TypedDict):
    boostingLevel: DocumentAttributeBoostingLevelType,  # (1)
    attributeValueBoosting: NotRequired[Mapping[str, StringAttributeValueBoostingLevelType]],  # (2)

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,
    tagKeys: Sequence[str],

UsersAndGroupsTypeDef#

# UsersAndGroupsTypeDef definition

class UsersAndGroupsTypeDef(TypedDict):
    userIds: NotRequired[Sequence[str]],
    userGroups: NotRequired[Sequence[str]],

APISchemaTypeDef#

# APISchemaTypeDef definition

class APISchemaTypeDef(TypedDict):
    payload: NotRequired[str],
    s3: NotRequired[S3TypeDef],  # (1)

See S3TypeDef

ActionExecutionOutputTypeDef#

# ActionExecutionOutputTypeDef definition

class ActionExecutionOutputTypeDef(TypedDict):
    pluginId: str,
    payload: dict[str, ActionExecutionPayloadFieldOutputTypeDef],  # (1)
    payloadFieldNameSeparator: str,

See ActionExecutionPayloadFieldOutputTypeDef

ActionReviewPayloadFieldTypeDef#

# ActionReviewPayloadFieldTypeDef definition

class ActionReviewPayloadFieldTypeDef(TypedDict):
    displayName: NotRequired[str],
    displayOrder: NotRequired[int],
    displayDescription: NotRequired[str],
    type: NotRequired[ActionPayloadFieldTypeType],  # (1)
    value: NotRequired[dict[str, Any]],
    allowedValues: NotRequired[list[ActionReviewPayloadFieldAllowedValueTypeDef]],  # (2)
    allowedFormat: NotRequired[str],
    arrayItemJsonSchema: NotRequired[dict[str, Any]],
    required: NotRequired[bool],

ApplicationTypeDef#

# ApplicationTypeDef definition

class ApplicationTypeDef(TypedDict):
    displayName: NotRequired[str],
    applicationId: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    status: NotRequired[ApplicationStatusType],  # (1)
    identityType: NotRequired[IdentityTypeType],  # (2)
    quickSightConfiguration: NotRequired[QuickSightConfigurationTypeDef],  # (3)

AssociatePermissionResponseTypeDef#

# AssociatePermissionResponseTypeDef definition

class AssociatePermissionResponseTypeDef(TypedDict):
    statement: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateApplicationResponseTypeDef#

# CreateApplicationResponseTypeDef definition

class CreateApplicationResponseTypeDef(TypedDict):
    applicationId: str,
    applicationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateDataAccessorResponseTypeDef#

# CreateDataAccessorResponseTypeDef definition

class CreateDataAccessorResponseTypeDef(TypedDict):
    dataAccessorId: str,
    idcApplicationArn: str,
    dataAccessorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateDataSourceResponseTypeDef#

# CreateDataSourceResponseTypeDef definition

class CreateDataSourceResponseTypeDef(TypedDict):
    dataSourceId: str,
    dataSourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateIndexResponseTypeDef#

# CreateIndexResponseTypeDef definition

class CreateIndexResponseTypeDef(TypedDict):
    indexId: str,
    indexArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreatePluginResponseTypeDef#

# CreatePluginResponseTypeDef definition

class CreatePluginResponseTypeDef(TypedDict):
    pluginId: str,
    pluginArn: str,
    buildStatus: PluginBuildStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See PluginBuildStatusType
See ResponseMetadataTypeDef

CreateRetrieverResponseTypeDef#

# CreateRetrieverResponseTypeDef definition

class CreateRetrieverResponseTypeDef(TypedDict):
    retrieverId: str,
    retrieverArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateWebExperienceResponseTypeDef#

# CreateWebExperienceResponseTypeDef definition

class CreateWebExperienceResponseTypeDef(TypedDict):
    webExperienceId: str,
    webExperienceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetMediaResponseTypeDef#

# GetMediaResponseTypeDef definition

class GetMediaResponseTypeDef(TypedDict):
    mediaBytes: bytes,
    mediaMimeType: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetPolicyResponseTypeDef#

# GetPolicyResponseTypeDef definition

class GetPolicyResponseTypeDef(TypedDict):
    policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

ListPluginActionsResponseTypeDef#

# ListPluginActionsResponseTypeDef definition

class ListPluginActionsResponseTypeDef(TypedDict):
    items: list[ActionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See ActionSummaryTypeDef
See ResponseMetadataTypeDef

ListPluginTypeActionsResponseTypeDef#

# ListPluginTypeActionsResponseTypeDef definition

class ListPluginTypeActionsResponseTypeDef(TypedDict):
    items: list[ActionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See ActionSummaryTypeDef
See ResponseMetadataTypeDef

StartDataSourceSyncJobResponseTypeDef#

# StartDataSourceSyncJobResponseTypeDef definition

class StartDataSourceSyncJobResponseTypeDef(TypedDict):
    executionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

DocumentContentTypeDef#

# DocumentContentTypeDef definition

class DocumentContentTypeDef(TypedDict):
    blob: NotRequired[BlobTypeDef],
    s3: NotRequired[S3TypeDef],  # (1)

See S3TypeDef

AttachmentOutputTypeDef#

# AttachmentOutputTypeDef definition

class AttachmentOutputTypeDef(TypedDict):
    name: NotRequired[str],
    status: NotRequired[AttachmentStatusType],  # (1)
    error: NotRequired[ErrorDetailTypeDef],  # (2)
    attachmentId: NotRequired[str],
    conversationId: NotRequired[str],

See AttachmentStatusType
See ErrorDetailTypeDef

DocumentDetailsTypeDef#

# DocumentDetailsTypeDef definition

class DocumentDetailsTypeDef(TypedDict):
    documentId: NotRequired[str],
    status: NotRequired[DocumentStatusType],  # (1)
    error: NotRequired[ErrorDetailTypeDef],  # (2)
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],

See DocumentStatusType
See ErrorDetailTypeDef

FailedDocumentTypeDef#

# FailedDocumentTypeDef definition

class FailedDocumentTypeDef(TypedDict):
    id: NotRequired[str],
    error: NotRequired[ErrorDetailTypeDef],  # (1)
    dataSourceId: NotRequired[str],

See ErrorDetailTypeDef

GroupStatusDetailTypeDef#

# GroupStatusDetailTypeDef definition

class GroupStatusDetailTypeDef(TypedDict):
    status: NotRequired[GroupStatusType],  # (1)
    lastUpdatedAt: NotRequired[datetime],
    errorDetail: NotRequired[ErrorDetailTypeDef],  # (2)

See GroupStatusType
See ErrorDetailTypeDef

BatchDeleteDocumentRequestRequestTypeDef#

# BatchDeleteDocumentRequestRequestTypeDef definition

class BatchDeleteDocumentRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    documents: Sequence[DeleteDocumentTypeDef],  # (1)
    dataSourceSyncId: NotRequired[str],

See DeleteDocumentTypeDef

ChatModeConfigurationTypeDef#

# ChatModeConfigurationTypeDef definition

class ChatModeConfigurationTypeDef(TypedDict):
    pluginConfiguration: NotRequired[PluginConfigurationTypeDef],  # (1)

See PluginConfigurationTypeDef

ContentRetrievalRuleOutputTypeDef#

# ContentRetrievalRuleOutputTypeDef definition

class ContentRetrievalRuleOutputTypeDef(TypedDict):
    eligibleDataSources: NotRequired[list[EligibleDataSourceTypeDef]],  # (1)

See EligibleDataSourceTypeDef

ContentRetrievalRuleTypeDef#

# ContentRetrievalRuleTypeDef definition

class ContentRetrievalRuleTypeDef(TypedDict):
    eligibleDataSources: NotRequired[Sequence[EligibleDataSourceTypeDef]],  # (1)

See EligibleDataSourceTypeDef

ContentSourceTypeDef#

# ContentSourceTypeDef definition

class ContentSourceTypeDef(TypedDict):
    retriever: NotRequired[RetrieverContentSourceTypeDef],  # (1)

See RetrieverContentSourceTypeDef

CopyFromSourceTypeDef#

# CopyFromSourceTypeDef definition

class CopyFromSourceTypeDef(TypedDict):
    conversation: NotRequired[ConversationSourceTypeDef],  # (1)

See ConversationSourceTypeDef

ListConversationsResponseTypeDef#

# ListConversationsResponseTypeDef definition

class ListConversationsResponseTypeDef(TypedDict):
    conversations: list[ConversationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See ConversationTypeDef
See ResponseMetadataTypeDef

GetApplicationResponseTypeDef#

# GetApplicationResponseTypeDef definition

class GetApplicationResponseTypeDef(TypedDict):
    displayName: str,
    applicationId: str,
    applicationArn: str,
    identityType: IdentityTypeType,  # (1)
    iamIdentityProviderArn: str,
    identityCenterApplicationArn: str,
    roleArn: str,
    status: ApplicationStatusType,  # (2)
    description: str,
    encryptionConfiguration: EncryptionConfigurationTypeDef,  # (3)
    createdAt: datetime,
    updatedAt: datetime,
    error: ErrorDetailTypeDef,  # (4)
    attachmentsConfiguration: AppliedAttachmentsConfigurationTypeDef,  # (5)
    qAppsConfiguration: QAppsConfigurationTypeDef,  # (6)
    personalizationConfiguration: PersonalizationConfigurationTypeDef,  # (7)
    autoSubscriptionConfiguration: AutoSubscriptionConfigurationTypeDef,  # (8)
    clientIdsForOIDC: list[str],
    quickSightConfiguration: QuickSightConfigurationTypeDef,  # (9)
    ResponseMetadata: ResponseMetadataTypeDef,  # (10)

See IdentityTypeType
See ApplicationStatusType
See EncryptionConfigurationTypeDef
See ErrorDetailTypeDef
See AppliedAttachmentsConfigurationTypeDef
See QAppsConfigurationTypeDef
See PersonalizationConfigurationTypeDef
See AutoSubscriptionConfigurationTypeDef
See QuickSightConfigurationTypeDef
See ResponseMetadataTypeDef

UpdateApplicationRequestRequestTypeDef#

# UpdateApplicationRequestRequestTypeDef definition

class UpdateApplicationRequestRequestTypeDef(TypedDict):
    applicationId: str,
    identityCenterInstanceArn: NotRequired[str],
    displayName: NotRequired[str],
    description: NotRequired[str],
    roleArn: NotRequired[str],
    attachmentsConfiguration: NotRequired[AttachmentsConfigurationTypeDef],  # (1)
    qAppsConfiguration: NotRequired[QAppsConfigurationTypeDef],  # (2)
    personalizationConfiguration: NotRequired[PersonalizationConfigurationTypeDef],  # (3)
    autoSubscriptionConfiguration: NotRequired[AutoSubscriptionConfigurationTypeDef],  # (4)

CreateApplicationRequestRequestTypeDef#

# CreateApplicationRequestRequestTypeDef definition

class CreateApplicationRequestRequestTypeDef(TypedDict):
    displayName: str,
    roleArn: NotRequired[str],
    identityType: NotRequired[IdentityTypeType],  # (1)
    iamIdentityProviderArn: NotRequired[str],
    identityCenterInstanceArn: NotRequired[str],
    clientIdsForOIDC: NotRequired[Sequence[str]],
    description: NotRequired[str],
    encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (2)
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    clientToken: NotRequired[str],
    attachmentsConfiguration: NotRequired[AttachmentsConfigurationTypeDef],  # (4)
    qAppsConfiguration: NotRequired[QAppsConfigurationTypeDef],  # (5)
    personalizationConfiguration: NotRequired[PersonalizationConfigurationTypeDef],  # (6)
    quickSightConfiguration: NotRequired[QuickSightConfigurationTypeDef],  # (7)

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,
    description: NotRequired[str],
    type: NotRequired[IndexTypeType],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef],  # (3)
    clientToken: NotRequired[str],

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    applicationId: str,
    userId: str,
    userAliases: NotRequired[Sequence[UserAliasTypeDef]],  # (1)
    clientToken: NotRequired[str],

See UserAliasTypeDef

GetUserResponseTypeDef#

# GetUserResponseTypeDef definition

class GetUserResponseTypeDef(TypedDict):
    userAliases: list[UserAliasTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See UserAliasTypeDef
See ResponseMetadataTypeDef

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    applicationId: str,
    userId: str,
    userAliasesToUpdate: NotRequired[Sequence[UserAliasTypeDef]],  # (1)
    userAliasesToDelete: NotRequired[Sequence[UserAliasTypeDef]],  # (1)

See UserAliasTypeDef
See UserAliasTypeDef

UpdateUserResponseTypeDef#

# UpdateUserResponseTypeDef definition

class UpdateUserResponseTypeDef(TypedDict):
    userAliasesAdded: list[UserAliasTypeDef],  # (1)
    userAliasesUpdated: list[UserAliasTypeDef],  # (1)
    userAliasesDeleted: list[UserAliasTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

ListDataAccessorsResponseTypeDef#

# ListDataAccessorsResponseTypeDef definition

class ListDataAccessorsResponseTypeDef(TypedDict):
    dataAccessors: list[DataAccessorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See DataAccessorTypeDef
See ResponseMetadataTypeDef

DataSourceSyncJobTypeDef#

# DataSourceSyncJobTypeDef definition

class DataSourceSyncJobTypeDef(TypedDict):
    executionId: NotRequired[str],
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    status: NotRequired[DataSourceSyncJobStatusType],  # (1)
    error: NotRequired[ErrorDetailTypeDef],  # (2)
    dataSourceErrorCode: NotRequired[str],
    metrics: NotRequired[DataSourceSyncJobMetricsTypeDef],  # (3)

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef definition

class ListDataSourcesResponseTypeDef(TypedDict):
    dataSources: list[DataSourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See DataSourceTypeDef
See ResponseMetadataTypeDef

DocumentAttributeBoostingConfigurationOutputTypeDef#

# DocumentAttributeBoostingConfigurationOutputTypeDef definition

class DocumentAttributeBoostingConfigurationOutputTypeDef(TypedDict):
    numberConfiguration: NotRequired[NumberAttributeBoostingConfigurationTypeDef],  # (1)
    stringConfiguration: NotRequired[StringAttributeBoostingConfigurationOutputTypeDef],  # (2)
    dateConfiguration: NotRequired[DateAttributeBoostingConfigurationTypeDef],  # (3)
    stringListConfiguration: NotRequired[StringListAttributeBoostingConfigurationTypeDef],  # (4)

DocumentAttributeConditionOutputTypeDef#

# DocumentAttributeConditionOutputTypeDef definition

class DocumentAttributeConditionOutputTypeDef(TypedDict):
    key: str,
    operator: DocumentEnrichmentConditionOperatorType,  # (1)
    value: NotRequired[DocumentAttributeValueOutputTypeDef],  # (2)

DocumentAttributeOutputTypeDef#

# DocumentAttributeOutputTypeDef definition

class DocumentAttributeOutputTypeDef(TypedDict):
    name: str,
    value: DocumentAttributeValueOutputTypeDef,  # (1)

See DocumentAttributeValueOutputTypeDef

DocumentAttributeTargetOutputTypeDef#

# DocumentAttributeTargetOutputTypeDef definition

class DocumentAttributeTargetOutputTypeDef(TypedDict):
    key: str,
    value: NotRequired[DocumentAttributeValueOutputTypeDef],  # (1)
    attributeValueOperator: NotRequired[AttributeValueOperatorType],  # (2)

UpdateIndexRequestRequestTypeDef#

# UpdateIndexRequestRequestTypeDef definition

class UpdateIndexRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    displayName: NotRequired[str],
    description: NotRequired[str],
    capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef],  # (1)
    documentAttributeConfigurations: NotRequired[Sequence[DocumentAttributeConfigurationTypeDef]],  # (2)

DocumentAttributeValueTypeDef#

# DocumentAttributeValueTypeDef definition

class DocumentAttributeValueTypeDef(TypedDict):
    stringValue: NotRequired[str],
    stringListValue: NotRequired[Sequence[str]],
    longValue: NotRequired[int],
    dateValue: NotRequired[TimestampTypeDef],

ListDataSourceSyncJobsRequestRequestTypeDef#

# ListDataSourceSyncJobsRequestRequestTypeDef definition

class ListDataSourceSyncJobsRequestRequestTypeDef(TypedDict):
    dataSourceId: str,
    applicationId: str,
    indexId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    startTime: NotRequired[TimestampTypeDef],
    endTime: NotRequired[TimestampTypeDef],
    statusFilter: NotRequired[DataSourceSyncJobStatusType],  # (1)

See DataSourceSyncJobStatusType

ListGroupsRequestRequestTypeDef#

# ListGroupsRequestRequestTypeDef definition

class ListGroupsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    updatedEarlierThan: TimestampTypeDef,
    dataSourceId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

MessageUsefulnessFeedbackTypeDef#

# MessageUsefulnessFeedbackTypeDef definition

class MessageUsefulnessFeedbackTypeDef(TypedDict):
    usefulness: MessageUsefulnessType,  # (1)
    submittedAt: TimestampTypeDef,
    reason: NotRequired[MessageUsefulnessReasonType],  # (2)
    comment: NotRequired[str],

See MessageUsefulnessType
See MessageUsefulnessReasonType

GetChatControlsConfigurationRequestPaginateTypeDef#

# GetChatControlsConfigurationRequestPaginateTypeDef definition

class GetChatControlsConfigurationRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListApplicationsRequestPaginateTypeDef#

# ListApplicationsRequestPaginateTypeDef definition

class ListApplicationsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListAttachmentsRequestPaginateTypeDef#

# ListAttachmentsRequestPaginateTypeDef definition

class ListAttachmentsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    conversationId: NotRequired[str],
    userId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListConversationsRequestPaginateTypeDef#

# ListConversationsRequestPaginateTypeDef definition

class ListConversationsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    userId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListDataAccessorsRequestPaginateTypeDef#

# ListDataAccessorsRequestPaginateTypeDef definition

class ListDataAccessorsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListDataSourceSyncJobsRequestPaginateTypeDef#

# ListDataSourceSyncJobsRequestPaginateTypeDef definition

class ListDataSourceSyncJobsRequestPaginateTypeDef(TypedDict):
    dataSourceId: str,
    applicationId: str,
    indexId: str,
    startTime: NotRequired[TimestampTypeDef],
    endTime: NotRequired[TimestampTypeDef],
    statusFilter: NotRequired[DataSourceSyncJobStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See DataSourceSyncJobStatusType
See PaginatorConfigTypeDef

ListDataSourcesRequestPaginateTypeDef#

# ListDataSourcesRequestPaginateTypeDef definition

class ListDataSourcesRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListDocumentsRequestPaginateTypeDef#

# ListDocumentsRequestPaginateTypeDef definition

class ListDocumentsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    dataSourceIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListGroupsRequestPaginateTypeDef#

# ListGroupsRequestPaginateTypeDef definition

class ListGroupsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    updatedEarlierThan: TimestampTypeDef,
    dataSourceId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListIndicesRequestPaginateTypeDef#

# ListIndicesRequestPaginateTypeDef definition

class ListIndicesRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListMessagesRequestPaginateTypeDef#

# ListMessagesRequestPaginateTypeDef definition

class ListMessagesRequestPaginateTypeDef(TypedDict):
    conversationId: str,
    applicationId: str,
    userId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListPluginActionsRequestPaginateTypeDef#

# ListPluginActionsRequestPaginateTypeDef definition

class ListPluginActionsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    pluginId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListPluginTypeActionsRequestPaginateTypeDef#

# ListPluginTypeActionsRequestPaginateTypeDef definition

class ListPluginTypeActionsRequestPaginateTypeDef(TypedDict):
    pluginType: PluginTypeType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See PluginTypeType
See PaginatorConfigTypeDef

ListPluginTypeMetadataRequestPaginateTypeDef#

# ListPluginTypeMetadataRequestPaginateTypeDef definition

class ListPluginTypeMetadataRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListPluginsRequestPaginateTypeDef#

# ListPluginsRequestPaginateTypeDef definition

class ListPluginsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListRetrieversRequestPaginateTypeDef#

# ListRetrieversRequestPaginateTypeDef definition

class ListRetrieversRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListWebExperiencesRequestPaginateTypeDef#

# ListWebExperiencesRequestPaginateTypeDef definition

class ListWebExperiencesRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GroupMembersTypeDef#

# GroupMembersTypeDef definition

class GroupMembersTypeDef(TypedDict):
    memberGroups: NotRequired[Sequence[MemberGroupTypeDef]],  # (1)
    memberUsers: NotRequired[Sequence[MemberUserTypeDef]],  # (2)
    s3PathForGroupMembers: NotRequired[S3TypeDef],  # (3)

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef definition

class ListGroupsResponseTypeDef(TypedDict):
    items: list[GroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See GroupSummaryTypeDef
See ResponseMetadataTypeDef

IdentityProviderConfigurationTypeDef#

# IdentityProviderConfigurationTypeDef definition

class IdentityProviderConfigurationTypeDef(TypedDict):
    samlConfiguration: NotRequired[SamlProviderConfigurationTypeDef],  # (1)
    openIDConnectConfiguration: NotRequired[OpenIDConnectProviderConfigurationTypeDef],  # (2)

MediaExtractionConfigurationTypeDef#

# MediaExtractionConfigurationTypeDef definition

class MediaExtractionConfigurationTypeDef(TypedDict):
    imageExtractionConfiguration: NotRequired[ImageExtractionConfigurationTypeDef],  # (1)

See ImageExtractionConfigurationTypeDef

IndexStatisticsTypeDef#

# IndexStatisticsTypeDef definition

class IndexStatisticsTypeDef(TypedDict):
    textDocumentStatistics: NotRequired[TextDocumentStatisticsTypeDef],  # (1)

See TextDocumentStatisticsTypeDef

ListIndicesResponseTypeDef#

# ListIndicesResponseTypeDef definition

class ListIndicesResponseTypeDef(TypedDict):
    indices: list[IndexTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See IndexTypeDef
See ResponseMetadataTypeDef

ListPluginTypeMetadataResponseTypeDef#

# ListPluginTypeMetadataResponseTypeDef definition

class ListPluginTypeMetadataResponseTypeDef(TypedDict):
    items: list[PluginTypeMetadataSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See PluginTypeMetadataSummaryTypeDef
See ResponseMetadataTypeDef

ListPluginsResponseTypeDef#

# ListPluginsResponseTypeDef definition

class ListPluginsResponseTypeDef(TypedDict):
    plugins: list[PluginTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See PluginTypeDef
See ResponseMetadataTypeDef

ListRetrieversResponseTypeDef#

# ListRetrieversResponseTypeDef definition

class ListRetrieversResponseTypeDef(TypedDict):
    retrievers: list[RetrieverTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See RetrieverTypeDef
See ResponseMetadataTypeDef

ListWebExperiencesResponseTypeDef#

# ListWebExperiencesResponseTypeDef definition

class ListWebExperiencesResponseTypeDef(TypedDict):
    webExperiences: list[WebExperienceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See WebExperienceTypeDef
See ResponseMetadataTypeDef

PluginAuthConfigurationOutputTypeDef#

# PluginAuthConfigurationOutputTypeDef definition

class PluginAuthConfigurationOutputTypeDef(TypedDict):
    basicAuthConfiguration: NotRequired[BasicAuthConfigurationTypeDef],  # (1)
    oAuth2ClientCredentialConfiguration: NotRequired[OAuth2ClientCredentialConfigurationTypeDef],  # (2)
    noAuthConfiguration: NotRequired[dict[str, Any]],
    idcAuthConfiguration: NotRequired[IdcAuthConfigurationTypeDef],  # (3)

PluginAuthConfigurationTypeDef#

# PluginAuthConfigurationTypeDef definition

class PluginAuthConfigurationTypeDef(TypedDict):
    basicAuthConfiguration: NotRequired[BasicAuthConfigurationTypeDef],  # (1)
    oAuth2ClientCredentialConfiguration: NotRequired[OAuth2ClientCredentialConfigurationTypeDef],  # (2)
    noAuthConfiguration: NotRequired[Mapping[str, Any]],
    idcAuthConfiguration: NotRequired[IdcAuthConfigurationTypeDef],  # (3)

PrincipalTypeDef#

# PrincipalTypeDef definition

class PrincipalTypeDef(TypedDict):
    user: NotRequired[PrincipalUserTypeDef],  # (1)
    group: NotRequired[PrincipalGroupTypeDef],  # (2)

See PrincipalUserTypeDef
See PrincipalGroupTypeDef

WebExperienceAuthConfigurationTypeDef#

# WebExperienceAuthConfigurationTypeDef definition

class WebExperienceAuthConfigurationTypeDef(TypedDict):
    samlConfiguration: NotRequired[SamlConfigurationTypeDef],  # (1)

See SamlConfigurationTypeDef

TextSegmentTypeDef#

# TextSegmentTypeDef definition

class TextSegmentTypeDef(TypedDict):
    beginOffset: NotRequired[int],
    endOffset: NotRequired[int],
    snippetExcerpt: NotRequired[SnippetExcerptTypeDef],  # (1)
    mediaId: NotRequired[str],
    mediaMimeType: NotRequired[str],

See SnippetExcerptTypeDef

CustomPluginConfigurationTypeDef#

# CustomPluginConfigurationTypeDef definition

class CustomPluginConfigurationTypeDef(TypedDict):
    description: str,
    apiSchemaType: APISchemaTypeType,  # (1)
    apiSchema: APISchemaTypeDef,  # (2)

See APISchemaTypeType
See APISchemaTypeDef

ActionExecutionEventTypeDef#

# ActionExecutionEventTypeDef definition

class ActionExecutionEventTypeDef(TypedDict):
    pluginId: str,
    payload: Mapping[str, ActionExecutionPayloadFieldUnionTypeDef],  # (1)
    payloadFieldNameSeparator: str,

See ActionExecutionPayloadFieldTypeDef ActionExecutionPayloadFieldOutputTypeDef

ActionExecutionTypeDef#

# ActionExecutionTypeDef definition

class ActionExecutionTypeDef(TypedDict):
    pluginId: str,
    payload: Mapping[str, ActionExecutionPayloadFieldUnionTypeDef],  # (1)
    payloadFieldNameSeparator: str,

See ActionExecutionPayloadFieldTypeDef ActionExecutionPayloadFieldOutputTypeDef

ActionReviewEventTypeDef#

# ActionReviewEventTypeDef definition

class ActionReviewEventTypeDef(TypedDict):
    conversationId: NotRequired[str],
    userMessageId: NotRequired[str],
    systemMessageId: NotRequired[str],
    pluginId: NotRequired[str],
    pluginType: NotRequired[PluginTypeType],  # (1)
    payload: NotRequired[dict[str, ActionReviewPayloadFieldTypeDef]],  # (2)
    payloadFieldNameSeparator: NotRequired[str],

See PluginTypeType
See ActionReviewPayloadFieldTypeDef

ActionReviewTypeDef#

# ActionReviewTypeDef definition

class ActionReviewTypeDef(TypedDict):
    pluginId: NotRequired[str],
    pluginType: NotRequired[PluginTypeType],  # (1)
    payload: NotRequired[dict[str, ActionReviewPayloadFieldTypeDef]],  # (2)
    payloadFieldNameSeparator: NotRequired[str],

See PluginTypeType
See ActionReviewPayloadFieldTypeDef

ListApplicationsResponseTypeDef#

# ListApplicationsResponseTypeDef definition

class ListApplicationsResponseTypeDef(TypedDict):
    applications: list[ApplicationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See ApplicationTypeDef
See ResponseMetadataTypeDef

FailedAttachmentEventTypeDef#

# FailedAttachmentEventTypeDef definition

class FailedAttachmentEventTypeDef(TypedDict):
    conversationId: NotRequired[str],
    userMessageId: NotRequired[str],
    systemMessageId: NotRequired[str],
    attachment: NotRequired[AttachmentOutputTypeDef],  # (1)

See AttachmentOutputTypeDef

ListDocumentsResponseTypeDef#

# ListDocumentsResponseTypeDef definition

class ListDocumentsResponseTypeDef(TypedDict):
    documentDetailList: list[DocumentDetailsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See DocumentDetailsTypeDef
See ResponseMetadataTypeDef

BatchDeleteDocumentResponseTypeDef#

# BatchDeleteDocumentResponseTypeDef definition

class BatchDeleteDocumentResponseTypeDef(TypedDict):
    failedDocuments: list[FailedDocumentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See FailedDocumentTypeDef
See ResponseMetadataTypeDef

BatchPutDocumentResponseTypeDef#

# BatchPutDocumentResponseTypeDef definition

class BatchPutDocumentResponseTypeDef(TypedDict):
    failedDocuments: list[FailedDocumentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See FailedDocumentTypeDef
See ResponseMetadataTypeDef

GetGroupResponseTypeDef#

# GetGroupResponseTypeDef definition

class GetGroupResponseTypeDef(TypedDict):
    status: GroupStatusDetailTypeDef,  # (1)
    statusHistory: list[GroupStatusDetailTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

RuleConfigurationOutputTypeDef#

# RuleConfigurationOutputTypeDef definition

class RuleConfigurationOutputTypeDef(TypedDict):
    contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef],  # (1)
    contentRetrievalRule: NotRequired[ContentRetrievalRuleOutputTypeDef],  # (2)

AttachmentInputTypeDef#

# AttachmentInputTypeDef definition

class AttachmentInputTypeDef(TypedDict):
    data: NotRequired[BlobTypeDef],
    name: NotRequired[str],
    copyFrom: NotRequired[CopyFromSourceTypeDef],  # (1)

See CopyFromSourceTypeDef

AttachmentTypeDef#

# AttachmentTypeDef definition

class AttachmentTypeDef(TypedDict):
    attachmentId: NotRequired[str],
    conversationId: NotRequired[str],
    name: NotRequired[str],
    copyFrom: NotRequired[CopyFromSourceTypeDef],  # (1)
    fileType: NotRequired[str],
    fileSize: NotRequired[int],
    md5chksum: NotRequired[str],
    createdAt: NotRequired[datetime],
    status: NotRequired[AttachmentStatusType],  # (2)
    error: NotRequired[ErrorDetailTypeDef],  # (3)

ListDataSourceSyncJobsResponseTypeDef#

# ListDataSourceSyncJobsResponseTypeDef definition

class ListDataSourceSyncJobsResponseTypeDef(TypedDict):
    history: list[DataSourceSyncJobTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See DataSourceSyncJobTypeDef
See ResponseMetadataTypeDef

NativeIndexConfigurationOutputTypeDef#

# NativeIndexConfigurationOutputTypeDef definition

class NativeIndexConfigurationOutputTypeDef(TypedDict):
    indexId: str,
    boostingOverride: NotRequired[dict[str, DocumentAttributeBoostingConfigurationOutputTypeDef]],  # (1)

See DocumentAttributeBoostingConfigurationOutputTypeDef

HookConfigurationOutputTypeDef#

# HookConfigurationOutputTypeDef definition

class HookConfigurationOutputTypeDef(TypedDict):
    invocationCondition: NotRequired[DocumentAttributeConditionOutputTypeDef],  # (1)
    lambdaArn: NotRequired[str],
    s3BucketName: NotRequired[str],
    roleArn: NotRequired[str],

See DocumentAttributeConditionOutputTypeDef

AttributeFilterOutputTypeDef#

# AttributeFilterOutputTypeDef definition

class AttributeFilterOutputTypeDef(TypedDict):
    andAllFilters: NotRequired[list[dict[str, Any]]],
    orAllFilters: NotRequired[list[dict[str, Any]]],
    notFilter: NotRequired[dict[str, Any]],
    equalsTo: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeOutputTypeDef],  # (1)

RelevantContentTypeDef#

# RelevantContentTypeDef definition

class RelevantContentTypeDef(TypedDict):
    content: NotRequired[str],
    documentId: NotRequired[str],
    documentTitle: NotRequired[str],
    documentUri: NotRequired[str],
    documentAttributes: NotRequired[list[DocumentAttributeOutputTypeDef]],  # (1)
    scoreAttributes: NotRequired[ScoreAttributesTypeDef],  # (2)

See DocumentAttributeOutputTypeDef
See ScoreAttributesTypeDef

InlineDocumentEnrichmentConfigurationOutputTypeDef#

# InlineDocumentEnrichmentConfigurationOutputTypeDef definition

class InlineDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
    condition: NotRequired[DocumentAttributeConditionOutputTypeDef],  # (1)
    target: NotRequired[DocumentAttributeTargetOutputTypeDef],  # (2)
    documentContentOperator: NotRequired[DocumentContentOperatorType],  # (3)

PutFeedbackRequestRequestTypeDef#

# PutFeedbackRequestRequestTypeDef definition

class PutFeedbackRequestRequestTypeDef(TypedDict):
    applicationId: str,
    conversationId: str,
    messageId: str,
    userId: NotRequired[str],
    messageCopiedAt: NotRequired[TimestampTypeDef],
    messageUsefulness: NotRequired[MessageUsefulnessFeedbackTypeDef],  # (1)

See MessageUsefulnessFeedbackTypeDef

PutGroupRequestRequestTypeDef#

# PutGroupRequestRequestTypeDef definition

class PutGroupRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    groupName: str,
    type: MembershipTypeType,  # (1)
    groupMembers: GroupMembersTypeDef,  # (2)
    dataSourceId: NotRequired[str],
    roleArn: NotRequired[str],

See MembershipTypeType
See GroupMembersTypeDef

CreateWebExperienceRequestRequestTypeDef#

# CreateWebExperienceRequestRequestTypeDef definition

class CreateWebExperienceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    title: NotRequired[str],
    subtitle: NotRequired[str],
    welcomeMessage: NotRequired[str],
    samplePromptsControlMode: NotRequired[WebExperienceSamplePromptsControlModeType],  # (1)
    origins: NotRequired[Sequence[str]],
    roleArn: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    clientToken: NotRequired[str],
    identityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef],  # (3)
    browserExtensionConfiguration: NotRequired[BrowserExtensionConfigurationTypeDef],  # (4)
    customizationConfiguration: NotRequired[CustomizationConfigurationTypeDef],  # (5)

See WebExperienceSamplePromptsControlModeType
See TagTypeDef
See IdentityProviderConfigurationTypeDef
See BrowserExtensionConfigurationTypeDef
See CustomizationConfigurationTypeDef

GetIndexResponseTypeDef#

# GetIndexResponseTypeDef definition

class GetIndexResponseTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    displayName: str,
    indexArn: str,
    status: IndexStatusType,  # (1)
    type: IndexTypeType,  # (2)
    description: str,
    createdAt: datetime,
    updatedAt: datetime,
    capacityConfiguration: IndexCapacityConfigurationTypeDef,  # (3)
    documentAttributeConfigurations: list[DocumentAttributeConfigurationTypeDef],  # (4)
    error: ErrorDetailTypeDef,  # (5)
    indexStatistics: IndexStatisticsTypeDef,  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

See IndexStatusType
See IndexTypeType
See IndexCapacityConfigurationTypeDef
See DocumentAttributeConfigurationTypeDef
See ErrorDetailTypeDef
See IndexStatisticsTypeDef
See ResponseMetadataTypeDef

AccessControlTypeDef#

# AccessControlTypeDef definition

class AccessControlTypeDef(TypedDict):
    principals: Sequence[PrincipalTypeDef],  # (1)
    memberRelation: NotRequired[MemberRelationType],  # (2)

See PrincipalTypeDef
See MemberRelationType

GetWebExperienceResponseTypeDef#

# GetWebExperienceResponseTypeDef definition

class GetWebExperienceResponseTypeDef(TypedDict):
    applicationId: str,
    webExperienceId: str,
    webExperienceArn: str,
    defaultEndpoint: str,
    status: WebExperienceStatusType,  # (1)
    createdAt: datetime,
    updatedAt: datetime,
    title: str,
    subtitle: str,
    welcomeMessage: str,
    samplePromptsControlMode: WebExperienceSamplePromptsControlModeType,  # (2)
    origins: list[str],
    roleArn: str,
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef,  # (3)
    authenticationConfiguration: WebExperienceAuthConfigurationTypeDef,  # (4)
    error: ErrorDetailTypeDef,  # (5)
    browserExtensionConfiguration: BrowserExtensionConfigurationOutputTypeDef,  # (6)
    customizationConfiguration: CustomizationConfigurationTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)

See WebExperienceStatusType
See WebExperienceSamplePromptsControlModeType
See IdentityProviderConfigurationTypeDef
See WebExperienceAuthConfigurationTypeDef
See ErrorDetailTypeDef
See BrowserExtensionConfigurationOutputTypeDef
See CustomizationConfigurationTypeDef
See ResponseMetadataTypeDef

UpdateWebExperienceRequestRequestTypeDef#

# UpdateWebExperienceRequestRequestTypeDef definition

class UpdateWebExperienceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    webExperienceId: str,
    roleArn: NotRequired[str],
    authenticationConfiguration: NotRequired[WebExperienceAuthConfigurationTypeDef],  # (1)
    title: NotRequired[str],
    subtitle: NotRequired[str],
    welcomeMessage: NotRequired[str],
    samplePromptsControlMode: NotRequired[WebExperienceSamplePromptsControlModeType],  # (2)
    identityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef],  # (3)
    origins: NotRequired[Sequence[str]],
    browserExtensionConfiguration: NotRequired[BrowserExtensionConfigurationTypeDef],  # (4)
    customizationConfiguration: NotRequired[CustomizationConfigurationTypeDef],  # (5)

SourceAttributionTypeDef#

# SourceAttributionTypeDef definition

class SourceAttributionTypeDef(TypedDict):
    title: NotRequired[str],
    snippet: NotRequired[str],
    url: NotRequired[str],
    citationNumber: NotRequired[int],
    updatedAt: NotRequired[datetime],
    textMessageSegments: NotRequired[list[TextSegmentTypeDef]],  # (1)

See TextSegmentTypeDef

DocumentAttributeBoostingConfigurationTypeDef#

# DocumentAttributeBoostingConfigurationTypeDef definition

class DocumentAttributeBoostingConfigurationTypeDef(TypedDict):
    numberConfiguration: NotRequired[NumberAttributeBoostingConfigurationTypeDef],  # (1)
    stringConfiguration: NotRequired[StringAttributeBoostingConfigurationUnionTypeDef],  # (2)
    dateConfiguration: NotRequired[DateAttributeBoostingConfigurationTypeDef],  # (3)
    stringListConfiguration: NotRequired[StringListAttributeBoostingConfigurationTypeDef],  # (4)

CreatePluginRequestRequestTypeDef#

# CreatePluginRequestRequestTypeDef definition

class CreatePluginRequestRequestTypeDef(TypedDict):
    applicationId: str,
    displayName: str,
    type: PluginTypeType,  # (1)
    authConfiguration: PluginAuthConfigurationTypeDef,  # (2)
    serverUrl: NotRequired[str],
    customPluginConfiguration: NotRequired[CustomPluginConfigurationTypeDef],  # (3)
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    clientToken: NotRequired[str],

GetPluginResponseTypeDef#

# GetPluginResponseTypeDef definition

class GetPluginResponseTypeDef(TypedDict):
    applicationId: str,
    pluginId: str,
    displayName: str,
    type: PluginTypeType,  # (1)
    serverUrl: str,
    authConfiguration: PluginAuthConfigurationOutputTypeDef,  # (2)
    customPluginConfiguration: CustomPluginConfigurationTypeDef,  # (3)
    buildStatus: PluginBuildStatusType,  # (4)
    pluginArn: str,
    state: PluginStateType,  # (5)
    createdAt: datetime,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

See PluginTypeType
See PluginAuthConfigurationOutputTypeDef
See CustomPluginConfigurationTypeDef
See PluginBuildStatusType
See PluginStateType
See ResponseMetadataTypeDef

UpdatePluginRequestRequestTypeDef#

# UpdatePluginRequestRequestTypeDef definition

class UpdatePluginRequestRequestTypeDef(TypedDict):
    applicationId: str,
    pluginId: str,
    displayName: NotRequired[str],
    state: NotRequired[PluginStateType],  # (1)
    serverUrl: NotRequired[str],
    customPluginConfiguration: NotRequired[CustomPluginConfigurationTypeDef],  # (2)
    authConfiguration: NotRequired[PluginAuthConfigurationTypeDef],  # (3)

RuleOutputTypeDef#

# RuleOutputTypeDef definition

class RuleOutputTypeDef(TypedDict):
    ruleType: RuleTypeType,  # (3)
    includedUsersAndGroups: NotRequired[UsersAndGroupsOutputTypeDef],  # (1)
    excludedUsersAndGroups: NotRequired[UsersAndGroupsOutputTypeDef],  # (1)
    ruleConfiguration: NotRequired[RuleConfigurationOutputTypeDef],  # (4)

RuleConfigurationTypeDef#

# RuleConfigurationTypeDef definition

class RuleConfigurationTypeDef(TypedDict):
    contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef],  # (1)
    contentRetrievalRule: NotRequired[ContentRetrievalRuleUnionTypeDef],  # (2)

AttachmentInputEventTypeDef#

# AttachmentInputEventTypeDef definition

class AttachmentInputEventTypeDef(TypedDict):
    attachment: NotRequired[AttachmentInputTypeDef],  # (1)

See AttachmentInputTypeDef

ListAttachmentsResponseTypeDef#

# ListAttachmentsResponseTypeDef definition

class ListAttachmentsResponseTypeDef(TypedDict):
    attachments: list[AttachmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See AttachmentTypeDef
See ResponseMetadataTypeDef

RetrieverConfigurationOutputTypeDef#

# RetrieverConfigurationOutputTypeDef definition

class RetrieverConfigurationOutputTypeDef(TypedDict):
    nativeIndexConfiguration: NotRequired[NativeIndexConfigurationOutputTypeDef],  # (1)
    kendraIndexConfiguration: NotRequired[KendraIndexConfigurationTypeDef],  # (2)

ActionFilterConfigurationOutputTypeDef#

# ActionFilterConfigurationOutputTypeDef definition

class ActionFilterConfigurationOutputTypeDef(TypedDict):
    documentAttributeFilter: AttributeFilterOutputTypeDef,  # (1)

See AttributeFilterOutputTypeDef

SearchRelevantContentResponseTypeDef#

# SearchRelevantContentResponseTypeDef definition

class SearchRelevantContentResponseTypeDef(TypedDict):
    relevantContent: list[RelevantContentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See RelevantContentTypeDef
See ResponseMetadataTypeDef

DocumentEnrichmentConfigurationOutputTypeDef#

# DocumentEnrichmentConfigurationOutputTypeDef definition

class DocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
    inlineConfigurations: NotRequired[list[InlineDocumentEnrichmentConfigurationOutputTypeDef]],  # (1)
    preExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef],  # (2)
    postExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef],  # (2)

DocumentAttributeConditionTypeDef#

# DocumentAttributeConditionTypeDef definition

class DocumentAttributeConditionTypeDef(TypedDict):
    key: str,
    operator: DocumentEnrichmentConditionOperatorType,  # (1)
    value: NotRequired[DocumentAttributeValueUnionTypeDef],  # (2)

DocumentAttributeTargetTypeDef#

# DocumentAttributeTargetTypeDef definition

class DocumentAttributeTargetTypeDef(TypedDict):
    key: str,
    value: NotRequired[DocumentAttributeValueUnionTypeDef],  # (1)
    attributeValueOperator: NotRequired[AttributeValueOperatorType],  # (2)

DocumentAttributeTypeDef#

# DocumentAttributeTypeDef definition

class DocumentAttributeTypeDef(TypedDict):
    name: str,
    value: DocumentAttributeValueUnionTypeDef,  # (1)

See DocumentAttributeValueTypeDef DocumentAttributeValueOutputTypeDef

AccessConfigurationTypeDef#

# AccessConfigurationTypeDef definition

class AccessConfigurationTypeDef(TypedDict):
    accessControls: Sequence[AccessControlTypeDef],  # (1)
    memberRelation: NotRequired[MemberRelationType],  # (2)

See AccessControlTypeDef
See MemberRelationType

ChatSyncOutputTypeDef#

# ChatSyncOutputTypeDef definition

class ChatSyncOutputTypeDef(TypedDict):
    conversationId: str,
    systemMessage: str,
    systemMessageId: str,
    userMessageId: str,
    actionReview: ActionReviewTypeDef,  # (1)
    authChallengeRequest: AuthChallengeRequestTypeDef,  # (2)
    sourceAttributions: list[SourceAttributionTypeDef],  # (3)
    failedAttachments: list[AttachmentOutputTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    messageId: NotRequired[str],
    body: NotRequired[str],
    time: NotRequired[datetime],
    type: NotRequired[MessageTypeType],  # (1)
    attachments: NotRequired[list[AttachmentOutputTypeDef]],  # (2)
    sourceAttribution: NotRequired[list[SourceAttributionTypeDef]],  # (3)
    actionReview: NotRequired[ActionReviewTypeDef],  # (4)
    actionExecution: NotRequired[ActionExecutionOutputTypeDef],  # (5)

MetadataEventTypeDef#

# MetadataEventTypeDef definition

class MetadataEventTypeDef(TypedDict):
    conversationId: NotRequired[str],
    userMessageId: NotRequired[str],
    systemMessageId: NotRequired[str],
    sourceAttributions: NotRequired[list[SourceAttributionTypeDef]],  # (1)
    finalTextMessage: NotRequired[str],

See SourceAttributionTypeDef

TopicConfigurationOutputTypeDef#

# TopicConfigurationOutputTypeDef definition

class TopicConfigurationOutputTypeDef(TypedDict):
    name: str,
    rules: list[RuleOutputTypeDef],  # (1)
    description: NotRequired[str],
    exampleChatMessages: NotRequired[list[str]],

See RuleOutputTypeDef

GetRetrieverResponseTypeDef#

# GetRetrieverResponseTypeDef definition

class GetRetrieverResponseTypeDef(TypedDict):
    applicationId: str,
    retrieverId: str,
    retrieverArn: str,
    type: RetrieverTypeType,  # (1)
    status: RetrieverStatusType,  # (2)
    displayName: str,
    configuration: RetrieverConfigurationOutputTypeDef,  # (3)
    roleArn: str,
    createdAt: datetime,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

ActionConfigurationOutputTypeDef#

# ActionConfigurationOutputTypeDef definition

class ActionConfigurationOutputTypeDef(TypedDict):
    action: str,
    filterConfiguration: NotRequired[ActionFilterConfigurationOutputTypeDef],  # (1)

See ActionFilterConfigurationOutputTypeDef

GetDataSourceResponseTypeDef#

# GetDataSourceResponseTypeDef definition

class GetDataSourceResponseTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    dataSourceId: str,
    dataSourceArn: str,
    displayName: str,
    type: str,
    configuration: dict[str, Any],
    vpcConfiguration: DataSourceVpcConfigurationOutputTypeDef,  # (1)
    createdAt: datetime,
    updatedAt: datetime,
    description: str,
    status: DataSourceStatusType,  # (2)
    syncSchedule: str,
    roleArn: str,
    error: ErrorDetailTypeDef,  # (3)
    documentEnrichmentConfiguration: DocumentEnrichmentConfigurationOutputTypeDef,  # (4)
    mediaExtractionConfiguration: MediaExtractionConfigurationTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

See DataSourceVpcConfigurationOutputTypeDef
See DataSourceStatusType
See ErrorDetailTypeDef
See DocumentEnrichmentConfigurationOutputTypeDef
See MediaExtractionConfigurationTypeDef
See ResponseMetadataTypeDef

ListMessagesResponseTypeDef#

# ListMessagesResponseTypeDef definition

class ListMessagesResponseTypeDef(TypedDict):
    messages: list[MessageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See MessageTypeDef
See ResponseMetadataTypeDef

ChatOutputStreamTypeDef#

# ChatOutputStreamTypeDef definition

class ChatOutputStreamTypeDef(TypedDict):
    textEvent: NotRequired[TextOutputEventTypeDef],  # (1)
    metadataEvent: NotRequired[MetadataEventTypeDef],  # (2)
    actionReviewEvent: NotRequired[ActionReviewEventTypeDef],  # (3)
    failedAttachmentEvent: NotRequired[FailedAttachmentEventTypeDef],  # (4)
    authChallengeRequestEvent: NotRequired[AuthChallengeRequestEventTypeDef],  # (5)

NativeIndexConfigurationTypeDef#

# NativeIndexConfigurationTypeDef definition

class NativeIndexConfigurationTypeDef(TypedDict):
    indexId: str,
    boostingOverride: NotRequired[Mapping[str, DocumentAttributeBoostingConfigurationUnionTypeDef]],  # (1)

See DocumentAttributeBoostingConfigurationTypeDef DocumentAttributeBoostingConfigurationOutputTypeDef

GetChatControlsConfigurationResponseTypeDef#

# GetChatControlsConfigurationResponseTypeDef definition

class GetChatControlsConfigurationResponseTypeDef(TypedDict):
    responseScope: ResponseScopeType,  # (1)
    blockedPhrases: BlockedPhrasesConfigurationTypeDef,  # (2)
    topicConfigurations: list[TopicConfigurationOutputTypeDef],  # (3)
    creatorModeConfiguration: AppliedCreatorModeConfigurationTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
    nextToken: NotRequired[str],

See ResponseScopeType
See BlockedPhrasesConfigurationTypeDef
See TopicConfigurationOutputTypeDef
See AppliedCreatorModeConfigurationTypeDef
See ResponseMetadataTypeDef

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    ruleType: RuleTypeType,  # (3)
    includedUsersAndGroups: NotRequired[UsersAndGroupsUnionTypeDef],  # (1)
    excludedUsersAndGroups: NotRequired[UsersAndGroupsUnionTypeDef],  # (1)
    ruleConfiguration: NotRequired[RuleConfigurationUnionTypeDef],  # (4)

GetDataAccessorResponseTypeDef#

# GetDataAccessorResponseTypeDef definition

class GetDataAccessorResponseTypeDef(TypedDict):
    displayName: str,
    dataAccessorId: str,
    dataAccessorArn: str,
    applicationId: str,
    idcApplicationArn: str,
    principal: str,
    actionConfigurations: list[ActionConfigurationOutputTypeDef],  # (1)
    createdAt: datetime,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ActionConfigurationOutputTypeDef
See ResponseMetadataTypeDef

HookConfigurationTypeDef#

# HookConfigurationTypeDef definition

class HookConfigurationTypeDef(TypedDict):
    invocationCondition: NotRequired[DocumentAttributeConditionUnionTypeDef],  # (1)
    lambdaArn: NotRequired[str],
    s3BucketName: NotRequired[str],
    roleArn: NotRequired[str],

See DocumentAttributeConditionTypeDef DocumentAttributeConditionOutputTypeDef

InlineDocumentEnrichmentConfigurationTypeDef#

# InlineDocumentEnrichmentConfigurationTypeDef definition

class InlineDocumentEnrichmentConfigurationTypeDef(TypedDict):
    condition: NotRequired[DocumentAttributeConditionUnionTypeDef],  # (1)
    target: NotRequired[DocumentAttributeTargetUnionTypeDef],  # (2)
    documentContentOperator: NotRequired[DocumentContentOperatorType],  # (3)

AttributeFilterPaginatorTypeDef#

# AttributeFilterPaginatorTypeDef definition

class AttributeFilterPaginatorTypeDef(TypedDict):
    andAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    orAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    notFilter: NotRequired[Mapping[str, Any]],
    equalsTo: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)

AttributeFilterTypeDef#

# AttributeFilterTypeDef definition

class AttributeFilterTypeDef(TypedDict):
    andAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    orAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    notFilter: NotRequired[Mapping[str, Any]],
    equalsTo: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)

ChatOutputTypeDef#

# ChatOutputTypeDef definition

class ChatOutputTypeDef(TypedDict):
    outputStream: EventStream[ChatOutputStreamTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ChatOutputStreamTypeDef
See ResponseMetadataTypeDef

SearchRelevantContentRequestPaginateTypeDef#

# SearchRelevantContentRequestPaginateTypeDef definition

class SearchRelevantContentRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    queryText: str,
    contentSource: ContentSourceTypeDef,  # (1)
    attributeFilter: NotRequired[AttributeFilterPaginatorTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)

ChatSyncInputRequestTypeDef#

# ChatSyncInputRequestTypeDef definition

class ChatSyncInputRequestTypeDef(TypedDict):
    applicationId: str,
    userId: NotRequired[str],
    userGroups: NotRequired[Sequence[str]],
    userMessage: NotRequired[str],
    attachments: NotRequired[Sequence[AttachmentInputTypeDef]],  # (1)
    actionExecution: NotRequired[ActionExecutionTypeDef],  # (2)
    authChallengeResponse: NotRequired[AuthChallengeResponseTypeDef],  # (3)
    conversationId: NotRequired[str],
    parentMessageId: NotRequired[str],
    attributeFilter: NotRequired[AttributeFilterTypeDef],  # (4)
    chatMode: NotRequired[ChatModeType],  # (5)
    chatModeConfiguration: NotRequired[ChatModeConfigurationTypeDef],  # (6)
    clientToken: NotRequired[str],

SearchRelevantContentRequestRequestTypeDef#

# SearchRelevantContentRequestRequestTypeDef definition

class SearchRelevantContentRequestRequestTypeDef(TypedDict):
    applicationId: str,
    queryText: str,
    contentSource: ContentSourceTypeDef,  # (1)
    attributeFilter: NotRequired[AttributeFilterTypeDef],  # (2)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

See ContentSourceTypeDef
See AttributeFilterTypeDef

RetrieverConfigurationTypeDef#

# RetrieverConfigurationTypeDef definition

class RetrieverConfigurationTypeDef(TypedDict):
    nativeIndexConfiguration: NotRequired[NativeIndexConfigurationUnionTypeDef],  # (1)
    kendraIndexConfiguration: NotRequired[KendraIndexConfigurationTypeDef],  # (2)

TopicConfigurationTypeDef#

# TopicConfigurationTypeDef definition

class TopicConfigurationTypeDef(TypedDict):
    name: str,
    rules: Sequence[RuleUnionTypeDef],  # (1)
    description: NotRequired[str],
    exampleChatMessages: NotRequired[Sequence[str]],

See RuleTypeDef RuleOutputTypeDef

DocumentEnrichmentConfigurationTypeDef#

# DocumentEnrichmentConfigurationTypeDef definition

class DocumentEnrichmentConfigurationTypeDef(TypedDict):
    inlineConfigurations: NotRequired[Sequence[InlineDocumentEnrichmentConfigurationUnionTypeDef]],  # (1)
    preExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef],  # (2)
    postExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef],  # (2)

ActionFilterConfigurationTypeDef#

# ActionFilterConfigurationTypeDef definition

class ActionFilterConfigurationTypeDef(TypedDict):
    documentAttributeFilter: AttributeFilterUnionTypeDef,  # (1)

See AttributeFilterTypeDef AttributeFilterOutputTypeDef

ConfigurationEventTypeDef#

# ConfigurationEventTypeDef definition

class ConfigurationEventTypeDef(TypedDict):
    chatMode: NotRequired[ChatModeType],  # (1)
    chatModeConfiguration: NotRequired[ChatModeConfigurationTypeDef],  # (2)
    attributeFilter: NotRequired[AttributeFilterUnionTypeDef],  # (3)

See ChatModeType
See ChatModeConfigurationTypeDef
See AttributeFilterTypeDef AttributeFilterOutputTypeDef

CreateRetrieverRequestRequestTypeDef#

# CreateRetrieverRequestRequestTypeDef definition

class CreateRetrieverRequestRequestTypeDef(TypedDict):
    applicationId: str,
    type: RetrieverTypeType,  # (1)
    displayName: str,
    configuration: RetrieverConfigurationTypeDef,  # (2)
    roleArn: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)

UpdateRetrieverRequestRequestTypeDef#

# UpdateRetrieverRequestRequestTypeDef definition

class UpdateRetrieverRequestRequestTypeDef(TypedDict):
    applicationId: str,
    retrieverId: str,
    configuration: NotRequired[RetrieverConfigurationTypeDef],  # (1)
    displayName: NotRequired[str],
    roleArn: NotRequired[str],

See RetrieverConfigurationTypeDef

CreateDataSourceRequestRequestTypeDef#

# CreateDataSourceRequestRequestTypeDef definition

class CreateDataSourceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    displayName: str,
    configuration: Mapping[str, Any],
    vpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (1)
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    syncSchedule: NotRequired[str],
    roleArn: NotRequired[str],
    clientToken: NotRequired[str],
    documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationTypeDef],  # (3)
    mediaExtractionConfiguration: NotRequired[MediaExtractionConfigurationTypeDef],  # (4)

See DataSourceVpcConfigurationTypeDef
See TagTypeDef
See DocumentEnrichmentConfigurationTypeDef
See MediaExtractionConfigurationTypeDef

UpdateDataSourceRequestRequestTypeDef#

# UpdateDataSourceRequestRequestTypeDef definition

class UpdateDataSourceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    dataSourceId: str,
    displayName: NotRequired[str],
    configuration: NotRequired[Mapping[str, Any]],
    vpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (1)
    description: NotRequired[str],
    syncSchedule: NotRequired[str],
    roleArn: NotRequired[str],
    documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationTypeDef],  # (2)
    mediaExtractionConfiguration: NotRequired[MediaExtractionConfigurationTypeDef],  # (3)

ChatInputStreamTypeDef#

# ChatInputStreamTypeDef definition

class ChatInputStreamTypeDef(TypedDict):
    configurationEvent: NotRequired[ConfigurationEventTypeDef],  # (1)
    textEvent: NotRequired[TextInputEventTypeDef],  # (2)
    attachmentEvent: NotRequired[AttachmentInputEventTypeDef],  # (3)
    actionExecutionEvent: NotRequired[ActionExecutionEventTypeDef],  # (4)
    endOfInputEvent: NotRequired[Mapping[str, Any]],
    authChallengeResponseEvent: NotRequired[AuthChallengeResponseEventTypeDef],  # (5)

UpdateChatControlsConfigurationRequestRequestTypeDef#

# UpdateChatControlsConfigurationRequestRequestTypeDef definition

class UpdateChatControlsConfigurationRequestRequestTypeDef(TypedDict):
    applicationId: str,
    clientToken: NotRequired[str],
    responseScope: NotRequired[ResponseScopeType],  # (1)
    blockedPhrasesConfigurationUpdate: NotRequired[BlockedPhrasesConfigurationUpdateTypeDef],  # (2)
    topicConfigurationsToCreateOrUpdate: NotRequired[Sequence[TopicConfigurationUnionTypeDef]],  # (3)
    topicConfigurationsToDelete: NotRequired[Sequence[TopicConfigurationTypeDef]],  # (4)
    creatorModeConfiguration: NotRequired[CreatorModeConfigurationTypeDef],  # (5)

DocumentTypeDef#

# DocumentTypeDef definition

class DocumentTypeDef(TypedDict):
    id: str,
    attributes: NotRequired[Sequence[DocumentAttributeUnionTypeDef]],  # (1)
    content: NotRequired[DocumentContentTypeDef],  # (2)
    contentType: NotRequired[ContentTypeType],  # (3)
    title: NotRequired[str],
    accessConfiguration: NotRequired[AccessConfigurationTypeDef],  # (4)
    documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationUnionTypeDef],  # (5)
    mediaExtractionConfiguration: NotRequired[MediaExtractionConfigurationTypeDef],  # (6)

ActionConfigurationTypeDef#

# ActionConfigurationTypeDef definition

class ActionConfigurationTypeDef(TypedDict):
    action: str,
    filterConfiguration: NotRequired[ActionFilterConfigurationUnionTypeDef],  # (1)

See ActionFilterConfigurationTypeDef ActionFilterConfigurationOutputTypeDef

ChatInputRequestTypeDef#

# ChatInputRequestTypeDef definition

class ChatInputRequestTypeDef(TypedDict):
    applicationId: str,
    userId: NotRequired[str],
    userGroups: NotRequired[Sequence[str]],
    conversationId: NotRequired[str],
    parentMessageId: NotRequired[str],
    clientToken: NotRequired[str],
    inputStream: NotRequired[EventStream[ChatInputStreamTypeDef]],  # (1)

See ChatInputStreamTypeDef

BatchPutDocumentRequestRequestTypeDef#

# BatchPutDocumentRequestRequestTypeDef definition

class BatchPutDocumentRequestRequestTypeDef(TypedDict):
    applicationId: str,
    indexId: str,
    documents: Sequence[DocumentTypeDef],  # (1)
    roleArn: NotRequired[str],
    dataSourceSyncId: NotRequired[str],

See DocumentTypeDef

UpdateDataAccessorRequestRequestTypeDef#

# UpdateDataAccessorRequestRequestTypeDef definition

class UpdateDataAccessorRequestRequestTypeDef(TypedDict):
    applicationId: str,
    dataAccessorId: str,
    actionConfigurations: Sequence[ActionConfigurationTypeDef],  # (1)
    displayName: NotRequired[str],

See ActionConfigurationTypeDef

CreateDataAccessorRequestRequestTypeDef#

# CreateDataAccessorRequestRequestTypeDef definition

class CreateDataAccessorRequestRequestTypeDef(TypedDict):
    applicationId: str,
    principal: str,
    actionConfigurations: Sequence[ActionConfigurationUnionTypeDef],  # (1)
    displayName: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)