Skip to content

Type definitions#

Index > QBusiness > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ActionExecutionPayloadFieldUnionTypeDef#

# ActionExecutionPayloadFieldUnionTypeDef definition

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

StringAttributeBoostingConfigurationUnionTypeDef#

# StringAttributeBoostingConfigurationUnionTypeDef definition

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

UsersAndGroupsUnionTypeDef#

# UsersAndGroupsUnionTypeDef definition

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

ContentRetrievalRuleUnionTypeDef#

# ContentRetrievalRuleUnionTypeDef definition

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

DocumentAttributeValueUnionTypeDef#

# DocumentAttributeValueUnionTypeDef definition

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

DocumentAttributeBoostingConfigurationUnionTypeDef#

# DocumentAttributeBoostingConfigurationUnionTypeDef definition

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

RuleConfigurationUnionTypeDef#

# RuleConfigurationUnionTypeDef definition

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

DocumentAttributeConditionUnionTypeDef#

# DocumentAttributeConditionUnionTypeDef definition

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

DocumentAttributeTargetUnionTypeDef#

# DocumentAttributeTargetUnionTypeDef definition

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

NativeIndexConfigurationUnionTypeDef#

# NativeIndexConfigurationUnionTypeDef definition

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

RuleUnionTypeDef#

# RuleUnionTypeDef definition

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

HookConfigurationUnionTypeDef#

# HookConfigurationUnionTypeDef definition

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

InlineDocumentEnrichmentConfigurationUnionTypeDef#

# InlineDocumentEnrichmentConfigurationUnionTypeDef definition

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

TopicConfigurationUnionTypeDef#

# TopicConfigurationUnionTypeDef definition

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

DocumentEnrichmentConfigurationUnionTypeDef#

# DocumentEnrichmentConfigurationUnionTypeDef definition

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

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

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)
  1. See ApplicationStatusType
  2. See IdentityTypeType

AppliedAttachmentsConfigurationTypeDef#

# AppliedAttachmentsConfigurationTypeDef definition

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

AppliedCreatorModeConfigurationTypeDef#

# AppliedCreatorModeConfigurationTypeDef definition

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

ErrorDetailTypeDef#

# ErrorDetailTypeDef definition

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

AttachmentsConfigurationTypeDef#

# AttachmentsConfigurationTypeDef definition

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

AuthChallengeRequestTypeDef#

# AuthChallengeRequestTypeDef definition

class AuthChallengeRequestTypeDef(TypedDict):
    authorizationUrl: str,

AuthChallengeResponseTypeDef#

# AuthChallengeResponseTypeDef definition

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

AutoSubscriptionConfigurationTypeDef#

# AutoSubscriptionConfigurationTypeDef definition

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

BasicAuthConfigurationTypeDef#

# BasicAuthConfigurationTypeDef definition

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

DeleteDocumentTypeDef#

# DeleteDocumentTypeDef definition

class DeleteDocumentTypeDef(TypedDict):
    documentId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BlockedPhrasesConfigurationTypeDef#

# BlockedPhrasesConfigurationTypeDef definition

class BlockedPhrasesConfigurationTypeDef(TypedDict):
    blockedPhrases: NotRequired[List[str]],
    systemMessageOverride: NotRequired[str],

BlockedPhrasesConfigurationUpdateTypeDef#

# BlockedPhrasesConfigurationUpdateTypeDef definition

class BlockedPhrasesConfigurationUpdateTypeDef(TypedDict):
    blockedPhrasesToCreateOrUpdate: NotRequired[Sequence[str]],
    blockedPhrasesToDelete: NotRequired[Sequence[str]],
    systemMessageOverride: NotRequired[str],

PluginConfigurationTypeDef#

# PluginConfigurationTypeDef definition

class PluginConfigurationTypeDef(TypedDict):
    pluginId: str,

ContentBlockerRuleTypeDef#

# ContentBlockerRuleTypeDef definition

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

EligibleDataSourceTypeDef#

# EligibleDataSourceTypeDef definition

class EligibleDataSourceTypeDef(TypedDict):
    indexId: NotRequired[str],
    dataSourceId: NotRequired[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)
  1. See PersonalizationControlModeType

QAppsConfigurationTypeDef#

# QAppsConfigurationTypeDef definition

class QAppsConfigurationTypeDef(TypedDict):
    qAppsControlMode: QAppsControlModeType,  # (1)
  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],

CreatorModeConfigurationTypeDef#

# CreatorModeConfigurationTypeDef definition

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

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)
  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],
  1. 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],

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,

NumberAttributeBoostingConfigurationTypeDef#

# NumberAttributeBoostingConfigurationTypeDef definition

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

StringAttributeBoostingConfigurationOutputTypeDef#

# StringAttributeBoostingConfigurationOutputTypeDef definition

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

StringListAttributeBoostingConfigurationTypeDef#

# StringListAttributeBoostingConfigurationTypeDef definition

class StringListAttributeBoostingConfigurationTypeDef(TypedDict):
    boostingLevel: DocumentAttributeBoostingLevelType,  # (1)
  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)
  1. See AttributeTypeType
  2. 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],

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,

GetPluginRequestRequestTypeDef#

# GetPluginRequestRequestTypeDef definition

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

GetRetrieverRequestRequestTypeDef#

# GetRetrieverRequestRequestTypeDef definition

class GetRetrieverRequestRequestTypeDef(TypedDict):
    applicationId: str,
    retrieverId: str,

GetUserRequestRequestTypeDef#

# GetUserRequestRequestTypeDef definition

class GetUserRequestRequestTypeDef(TypedDict):
    applicationId: str,
    userId: str,

GetWebExperienceRequestRequestTypeDef#

# GetWebExperienceRequestRequestTypeDef definition

class GetWebExperienceRequestRequestTypeDef(TypedDict):
    applicationId: str,
    webExperienceId: str,

MemberGroupTypeDef#

# MemberGroupTypeDef definition

class MemberGroupTypeDef(TypedDict):
    groupName: str,
    type: NotRequired[MembershipTypeType],  # (1)
  1. See MembershipTypeType

MemberUserTypeDef#

# MemberUserTypeDef definition

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

GroupSummaryTypeDef#

# GroupSummaryTypeDef definition

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

OpenIDConnectProviderConfigurationTypeDef#

# OpenIDConnectProviderConfigurationTypeDef definition

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

SamlProviderConfigurationTypeDef#

# SamlProviderConfigurationTypeDef definition

class SamlProviderConfigurationTypeDef(TypedDict):
    authenticationUrl: str,

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)
  1. See IndexStatusType

KendraIndexConfigurationTypeDef#

# KendraIndexConfigurationTypeDef definition

class KendraIndexConfigurationTypeDef(TypedDict):
    indexId: str,

ListApplicationsRequestRequestTypeDef#

# ListApplicationsRequestRequestTypeDef definition

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

ListConversationsRequestRequestTypeDef#

# ListConversationsRequestRequestTypeDef definition

class ListConversationsRequestRequestTypeDef(TypedDict):
    applicationId: str,
    userId: NotRequired[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],

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],
  1. See PluginTypeType
  2. See PluginStateType
  3. See PluginBuildStatusType

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],
  1. See RetrieverTypeType
  2. 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)
  1. See WebExperienceStatusType

OAuth2ClientCredentialConfigurationTypeDef#

# OAuth2ClientCredentialConfigurationTypeDef definition

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

PrincipalGroupTypeDef#

# PrincipalGroupTypeDef definition

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

PrincipalUserTypeDef#

# PrincipalUserTypeDef definition

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

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)
  1. See DocumentAttributeBoostingLevelType
  2. See StringAttributeValueBoostingLevelType

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)
  1. See S3TypeDef

ActionExecutionOutputTypeDef#

# ActionExecutionOutputTypeDef definition

class ActionExecutionOutputTypeDef(TypedDict):
    pluginId: str,
    payload: Dict[str, ActionExecutionPayloadFieldOutputTypeDef],  # (1)
    payloadFieldNameSeparator: str,
  1. 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],
  1. See ActionPayloadFieldTypeType
  2. See ActionReviewPayloadFieldAllowedValueTypeDef

AttachmentInputTypeDef#

# AttachmentInputTypeDef definition

class AttachmentInputTypeDef(TypedDict):
    name: str,
    data: BlobTypeDef,

DocumentContentTypeDef#

# DocumentContentTypeDef definition

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

AttachmentOutputTypeDef#

# AttachmentOutputTypeDef definition

class AttachmentOutputTypeDef(TypedDict):
    name: NotRequired[str],
    status: NotRequired[AttachmentStatusType],  # (1)
    error: NotRequired[ErrorDetailTypeDef],  # (2)
  1. See AttachmentStatusType
  2. 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],
  1. See DocumentStatusType
  2. See ErrorDetailTypeDef

FailedDocumentTypeDef#

# FailedDocumentTypeDef definition

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

GroupStatusDetailTypeDef#

# GroupStatusDetailTypeDef definition

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

BatchDeleteDocumentRequestRequestTypeDef#

# BatchDeleteDocumentRequestRequestTypeDef definition

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

CreateApplicationResponseTypeDef#

# CreateApplicationResponseTypeDef definition

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

CreateDataSourceResponseTypeDef#

# CreateDataSourceResponseTypeDef definition

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

CreateIndexResponseTypeDef#

# CreateIndexResponseTypeDef definition

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

CreatePluginResponseTypeDef#

# CreatePluginResponseTypeDef definition

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

CreateRetrieverResponseTypeDef#

# CreateRetrieverResponseTypeDef definition

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

CreateWebExperienceResponseTypeDef#

# CreateWebExperienceResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListApplicationsResponseTypeDef#

# ListApplicationsResponseTypeDef definition

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

StartDataSourceSyncJobResponseTypeDef#

# StartDataSourceSyncJobResponseTypeDef definition

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

ChatModeConfigurationTypeDef#

# ChatModeConfigurationTypeDef definition

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

ContentRetrievalRuleOutputTypeDef#

# ContentRetrievalRuleOutputTypeDef definition

class ContentRetrievalRuleOutputTypeDef(TypedDict):
    eligibleDataSources: NotRequired[List[EligibleDataSourceTypeDef]],  # (1)
  1. See EligibleDataSourceTypeDef

ContentRetrievalRuleTypeDef#

# ContentRetrievalRuleTypeDef definition

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

ListConversationsResponseTypeDef#

# ListConversationsResponseTypeDef definition

class ListConversationsResponseTypeDef(TypedDict):
    conversations: List[ConversationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ConversationTypeDef
  2. 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],
    ResponseMetadata: ResponseMetadataTypeDef,  # (9)
  1. See IdentityTypeType
  2. See ApplicationStatusType
  3. See EncryptionConfigurationTypeDef
  4. See ErrorDetailTypeDef
  5. See AppliedAttachmentsConfigurationTypeDef
  6. See QAppsConfigurationTypeDef
  7. See PersonalizationConfigurationTypeDef
  8. See AutoSubscriptionConfigurationTypeDef
  9. 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)
  1. See AttachmentsConfigurationTypeDef
  2. See QAppsConfigurationTypeDef
  3. See PersonalizationConfigurationTypeDef
  4. See AutoSubscriptionConfigurationTypeDef

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)
  1. See IdentityTypeType
  2. See EncryptionConfigurationTypeDef
  3. See TagTypeDef
  4. See AttachmentsConfigurationTypeDef
  5. See QAppsConfigurationTypeDef
  6. See PersonalizationConfigurationTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateIndexRequestRequestTypeDef#

# CreateIndexRequestRequestTypeDef definition

class CreateIndexRequestRequestTypeDef(TypedDict):
    applicationId: str,
    displayName: str,
    type: NotRequired[IndexTypeType],  # (1)
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef],  # (3)
    clientToken: NotRequired[str],
  1. See IndexTypeType
  2. See TagTypeDef
  3. See IndexCapacityConfigurationTypeDef

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

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

GetUserResponseTypeDef#

# GetUserResponseTypeDef definition

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

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

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

UpdateUserResponseTypeDef#

# UpdateUserResponseTypeDef definition

class UpdateUserResponseTypeDef(TypedDict):
    userAliasesAdded: List[UserAliasTypeDef],  # (1)
    userAliasesUpdated: List[UserAliasTypeDef],  # (1)
    userAliasesDeleted: List[UserAliasTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See UserAliasTypeDef
  2. See UserAliasTypeDef
  3. See UserAliasTypeDef
  4. 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)
  1. See DataSourceSyncJobStatusType
  2. See ErrorDetailTypeDef
  3. See DataSourceSyncJobMetricsTypeDef

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef definition

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

DocumentAttributeBoostingConfigurationOutputTypeDef#

# DocumentAttributeBoostingConfigurationOutputTypeDef definition

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

DocumentAttributeConditionOutputTypeDef#

# DocumentAttributeConditionOutputTypeDef definition

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

DocumentAttributeTargetOutputTypeDef#

# DocumentAttributeTargetOutputTypeDef definition

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

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)
  1. See IndexCapacityConfigurationTypeDef
  2. See DocumentAttributeConfigurationTypeDef

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)
  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],
  1. See MessageUsefulnessType
  2. See MessageUsefulnessReasonType

GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef#

# GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef definition

class GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListApplicationsRequestListApplicationsPaginateTypeDef#

# ListApplicationsRequestListApplicationsPaginateTypeDef definition

class ListApplicationsRequestListApplicationsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConversationsRequestListConversationsPaginateTypeDef#

# ListConversationsRequestListConversationsPaginateTypeDef definition

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

ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef#

# ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef definition

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

ListDataSourcesRequestListDataSourcesPaginateTypeDef#

# ListDataSourcesRequestListDataSourcesPaginateTypeDef definition

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

ListDocumentsRequestListDocumentsPaginateTypeDef#

# ListDocumentsRequestListDocumentsPaginateTypeDef definition

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

ListGroupsRequestListGroupsPaginateTypeDef#

# ListGroupsRequestListGroupsPaginateTypeDef definition

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

ListIndicesRequestListIndicesPaginateTypeDef#

# ListIndicesRequestListIndicesPaginateTypeDef definition

class ListIndicesRequestListIndicesPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMessagesRequestListMessagesPaginateTypeDef#

# ListMessagesRequestListMessagesPaginateTypeDef definition

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

ListPluginsRequestListPluginsPaginateTypeDef#

# ListPluginsRequestListPluginsPaginateTypeDef definition

class ListPluginsRequestListPluginsPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRetrieversRequestListRetrieversPaginateTypeDef#

# ListRetrieversRequestListRetrieversPaginateTypeDef definition

class ListRetrieversRequestListRetrieversPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWebExperiencesRequestListWebExperiencesPaginateTypeDef#

# ListWebExperiencesRequestListWebExperiencesPaginateTypeDef definition

class ListWebExperiencesRequestListWebExperiencesPaginateTypeDef(TypedDict):
    applicationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GroupMembersTypeDef#

# GroupMembersTypeDef definition

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

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef definition

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

IdentityProviderConfigurationTypeDef#

# IdentityProviderConfigurationTypeDef definition

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

IndexStatisticsTypeDef#

# IndexStatisticsTypeDef definition

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

ListIndicesResponseTypeDef#

# ListIndicesResponseTypeDef definition

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

ListPluginsResponseTypeDef#

# ListPluginsResponseTypeDef definition

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

ListRetrieversResponseTypeDef#

# ListRetrieversResponseTypeDef definition

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

ListWebExperiencesResponseTypeDef#

# ListWebExperiencesResponseTypeDef definition

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

PluginAuthConfigurationOutputTypeDef#

# PluginAuthConfigurationOutputTypeDef definition

class PluginAuthConfigurationOutputTypeDef(TypedDict):
    basicAuthConfiguration: NotRequired[BasicAuthConfigurationTypeDef],  # (1)
    oAuth2ClientCredentialConfiguration: NotRequired[OAuth2ClientCredentialConfigurationTypeDef],  # (2)
    noAuthConfiguration: NotRequired[Dict[str, Any]],
  1. See BasicAuthConfigurationTypeDef
  2. See OAuth2ClientCredentialConfigurationTypeDef

PluginAuthConfigurationTypeDef#

# PluginAuthConfigurationTypeDef definition

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

PrincipalTypeDef#

# PrincipalTypeDef definition

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

WebExperienceAuthConfigurationTypeDef#

# WebExperienceAuthConfigurationTypeDef definition

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

TextSegmentTypeDef#

# TextSegmentTypeDef definition

class TextSegmentTypeDef(TypedDict):
    beginOffset: NotRequired[int],
    endOffset: NotRequired[int],
    snippetExcerpt: NotRequired[SnippetExcerptTypeDef],  # (1)
  1. See SnippetExcerptTypeDef

CustomPluginConfigurationTypeDef#

# CustomPluginConfigurationTypeDef definition

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

ActionExecutionTypeDef#

# ActionExecutionTypeDef definition

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

ActionReviewTypeDef#

# ActionReviewTypeDef definition

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

ListDocumentsResponseTypeDef#

# ListDocumentsResponseTypeDef definition

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

BatchDeleteDocumentResponseTypeDef#

# BatchDeleteDocumentResponseTypeDef definition

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

BatchPutDocumentResponseTypeDef#

# BatchPutDocumentResponseTypeDef definition

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

GetGroupResponseTypeDef#

# GetGroupResponseTypeDef definition

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

RuleConfigurationOutputTypeDef#

# RuleConfigurationOutputTypeDef definition

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

ListDataSourceSyncJobsResponseTypeDef#

# ListDataSourceSyncJobsResponseTypeDef definition

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

NativeIndexConfigurationOutputTypeDef#

# NativeIndexConfigurationOutputTypeDef definition

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

HookConfigurationOutputTypeDef#

# HookConfigurationOutputTypeDef definition

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

InlineDocumentEnrichmentConfigurationOutputTypeDef#

# InlineDocumentEnrichmentConfigurationOutputTypeDef definition

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

PutFeedbackRequestRequestTypeDef#

# PutFeedbackRequestRequestTypeDef definition

class PutFeedbackRequestRequestTypeDef(TypedDict):
    applicationId: str,
    conversationId: str,
    messageId: str,
    userId: NotRequired[str],
    messageCopiedAt: NotRequired[TimestampTypeDef],
    messageUsefulness: NotRequired[MessageUsefulnessFeedbackTypeDef],  # (1)
  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],
  1. See MembershipTypeType
  2. 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)
  1. See WebExperienceSamplePromptsControlModeType
  2. See TagTypeDef
  3. See IdentityProviderConfigurationTypeDef

GetIndexResponseTypeDef#

# GetIndexResponseTypeDef definition

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

AccessControlTypeDef#

# AccessControlTypeDef definition

class AccessControlTypeDef(TypedDict):
    principals: Sequence[PrincipalTypeDef],  # (1)
    memberRelation: NotRequired[MemberRelationType],  # (2)
  1. See PrincipalTypeDef
  2. 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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See WebExperienceStatusType
  2. See WebExperienceSamplePromptsControlModeType
  3. See IdentityProviderConfigurationTypeDef
  4. See WebExperienceAuthConfigurationTypeDef
  5. See ErrorDetailTypeDef
  6. 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]],
  1. See WebExperienceAuthConfigurationTypeDef
  2. See WebExperienceSamplePromptsControlModeType
  3. See IdentityProviderConfigurationTypeDef

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)
  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)
  1. See NumberAttributeBoostingConfigurationTypeDef
  2. See StringAttributeBoostingConfigurationTypeDef StringAttributeBoostingConfigurationOutputTypeDef
  3. See DateAttributeBoostingConfigurationTypeDef
  4. See StringListAttributeBoostingConfigurationTypeDef

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],
  1. See PluginTypeType
  2. See PluginAuthConfigurationTypeDef
  3. See CustomPluginConfigurationTypeDef
  4. See TagTypeDef

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)
  1. See PluginTypeType
  2. See PluginAuthConfigurationOutputTypeDef
  3. See CustomPluginConfigurationTypeDef
  4. See PluginBuildStatusType
  5. See PluginStateType
  6. 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)
  1. See PluginStateType
  2. See CustomPluginConfigurationTypeDef
  3. See PluginAuthConfigurationTypeDef

RuleOutputTypeDef#

# RuleOutputTypeDef definition

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

RuleConfigurationTypeDef#

# RuleConfigurationTypeDef definition

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

RetrieverConfigurationOutputTypeDef#

# RetrieverConfigurationOutputTypeDef definition

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

DocumentEnrichmentConfigurationOutputTypeDef#

# DocumentEnrichmentConfigurationOutputTypeDef definition

class DocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
    inlineConfigurations: NotRequired[List[InlineDocumentEnrichmentConfigurationOutputTypeDef]],  # (1)
    preExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef],  # (2)
    postExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef],  # (2)
  1. See InlineDocumentEnrichmentConfigurationOutputTypeDef
  2. See HookConfigurationOutputTypeDef
  3. See HookConfigurationOutputTypeDef

DocumentAttributeConditionTypeDef#

# DocumentAttributeConditionTypeDef definition

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

DocumentAttributeTargetTypeDef#

# DocumentAttributeTargetTypeDef definition

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

DocumentAttributeTypeDef#

# DocumentAttributeTypeDef definition

class DocumentAttributeTypeDef(TypedDict):
    name: str,
    value: DocumentAttributeValueUnionTypeDef,  # (1)
  1. See DocumentAttributeValueTypeDef DocumentAttributeValueOutputTypeDef

AccessConfigurationTypeDef#

# AccessConfigurationTypeDef definition

class AccessConfigurationTypeDef(TypedDict):
    accessControls: Sequence[AccessControlTypeDef],  # (1)
    memberRelation: NotRequired[MemberRelationType],  # (2)
  1. See AccessControlTypeDef
  2. 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)
  1. See ActionReviewTypeDef
  2. See AuthChallengeRequestTypeDef
  3. See SourceAttributionTypeDef
  4. See AttachmentOutputTypeDef
  5. See ResponseMetadataTypeDef

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)
  1. See MessageTypeType
  2. See AttachmentOutputTypeDef
  3. See SourceAttributionTypeDef
  4. See ActionReviewTypeDef
  5. See ActionExecutionOutputTypeDef

TopicConfigurationOutputTypeDef#

# TopicConfigurationOutputTypeDef definition

class TopicConfigurationOutputTypeDef(TypedDict):
    name: str,
    rules: List[RuleOutputTypeDef],  # (1)
    description: NotRequired[str],
    exampleChatMessages: NotRequired[List[str]],
  1. 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)
  1. See RetrieverTypeType
  2. See RetrieverStatusType
  3. See RetrieverConfigurationOutputTypeDef
  4. See ResponseMetadataTypeDef

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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See DataSourceVpcConfigurationOutputTypeDef
  2. See DataSourceStatusType
  3. See ErrorDetailTypeDef
  4. See DocumentEnrichmentConfigurationOutputTypeDef
  5. See ResponseMetadataTypeDef

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[DocumentAttributeTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeTypeDef],  # (1)
  1. See DocumentAttributeTypeDef
  2. See DocumentAttributeTypeDef
  3. See DocumentAttributeTypeDef
  4. See DocumentAttributeTypeDef
  5. See DocumentAttributeTypeDef
  6. See DocumentAttributeTypeDef
  7. See DocumentAttributeTypeDef

ListMessagesResponseTypeDef#

# ListMessagesResponseTypeDef definition

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

NativeIndexConfigurationTypeDef#

# NativeIndexConfigurationTypeDef definition

class NativeIndexConfigurationTypeDef(TypedDict):
    indexId: str,
    boostingOverride: NotRequired[Mapping[str, DocumentAttributeBoostingConfigurationUnionTypeDef]],  # (1)
  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],
  1. See ResponseScopeType
  2. See BlockedPhrasesConfigurationTypeDef
  3. See TopicConfigurationOutputTypeDef
  4. See AppliedCreatorModeConfigurationTypeDef
  5. See ResponseMetadataTypeDef

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    ruleType: RuleTypeType,  # (3)
    includedUsersAndGroups: NotRequired[UsersAndGroupsUnionTypeDef],  # (1)
    excludedUsersAndGroups: NotRequired[UsersAndGroupsUnionTypeDef],  # (1)
    ruleConfiguration: NotRequired[RuleConfigurationUnionTypeDef],  # (4)
  1. See UsersAndGroupsTypeDef UsersAndGroupsOutputTypeDef
  2. See UsersAndGroupsTypeDef UsersAndGroupsOutputTypeDef
  3. See RuleTypeType
  4. See RuleConfigurationTypeDef RuleConfigurationOutputTypeDef

HookConfigurationTypeDef#

# HookConfigurationTypeDef definition

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

InlineDocumentEnrichmentConfigurationTypeDef#

# InlineDocumentEnrichmentConfigurationTypeDef definition

class InlineDocumentEnrichmentConfigurationTypeDef(TypedDict):
    condition: NotRequired[DocumentAttributeConditionUnionTypeDef],  # (1)
    target: NotRequired[DocumentAttributeTargetUnionTypeDef],  # (2)
    documentContentOperator: NotRequired[DocumentContentOperatorType],  # (3)
  1. See DocumentAttributeConditionTypeDef DocumentAttributeConditionOutputTypeDef
  2. See DocumentAttributeTargetTypeDef DocumentAttributeTargetOutputTypeDef
  3. See DocumentContentOperatorType

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],
  1. See AttachmentInputTypeDef
  2. See ActionExecutionTypeDef
  3. See AuthChallengeResponseTypeDef
  4. See AttributeFilterTypeDef
  5. See ChatModeType
  6. See ChatModeConfigurationTypeDef

RetrieverConfigurationTypeDef#

# RetrieverConfigurationTypeDef definition

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

TopicConfigurationTypeDef#

# TopicConfigurationTypeDef definition

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

DocumentEnrichmentConfigurationTypeDef#

# DocumentEnrichmentConfigurationTypeDef definition

class DocumentEnrichmentConfigurationTypeDef(TypedDict):
    inlineConfigurations: NotRequired[Sequence[InlineDocumentEnrichmentConfigurationUnionTypeDef]],  # (1)
    preExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef],  # (2)
    postExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef],  # (2)
  1. See InlineDocumentEnrichmentConfigurationTypeDef InlineDocumentEnrichmentConfigurationOutputTypeDef
  2. See HookConfigurationTypeDef HookConfigurationOutputTypeDef
  3. See HookConfigurationTypeDef HookConfigurationOutputTypeDef

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)
  1. See RetrieverTypeType
  2. See RetrieverConfigurationTypeDef
  3. See TagTypeDef

UpdateRetrieverRequestRequestTypeDef#

# UpdateRetrieverRequestRequestTypeDef definition

class UpdateRetrieverRequestRequestTypeDef(TypedDict):
    applicationId: str,
    retrieverId: str,
    configuration: NotRequired[RetrieverConfigurationTypeDef],  # (1)
    displayName: NotRequired[str],
    roleArn: NotRequired[str],
  1. 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)
  1. See DataSourceVpcConfigurationTypeDef
  2. See TagTypeDef
  3. See DocumentEnrichmentConfigurationTypeDef

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)
  1. See DataSourceVpcConfigurationTypeDef
  2. See DocumentEnrichmentConfigurationTypeDef

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)
  1. See ResponseScopeType
  2. See BlockedPhrasesConfigurationUpdateTypeDef
  3. See TopicConfigurationTypeDef TopicConfigurationOutputTypeDef
  4. See TopicConfigurationTypeDef
  5. See CreatorModeConfigurationTypeDef

DocumentTypeDef#

# DocumentTypeDef definition

class DocumentTypeDef(TypedDict):
    id: str,
    attributes: NotRequired[Sequence[DocumentAttributeTypeDef]],  # (1)
    content: NotRequired[DocumentContentTypeDef],  # (2)
    contentType: NotRequired[ContentTypeType],  # (3)
    title: NotRequired[str],
    accessConfiguration: NotRequired[AccessConfigurationTypeDef],  # (4)
    documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationUnionTypeDef],  # (5)
  1. See DocumentAttributeTypeDef
  2. See DocumentContentTypeDef
  3. See ContentTypeType
  4. See AccessConfigurationTypeDef
  5. See DocumentEnrichmentConfigurationTypeDef DocumentEnrichmentConfigurationOutputTypeDef

BatchPutDocumentRequestRequestTypeDef#

# BatchPutDocumentRequestRequestTypeDef definition

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