Type definitions#
Index > AgentsforBedrock > Type definitions
Auto-generated documentation for AgentsforBedrock type annotations stubs module types-aiobotocore-bedrock-agent.
S3IdentifierTypeDef#
# S3IdentifierTypeDef definition
class S3IdentifierTypeDef(TypedDict):
s3BucketName: NotRequired[str],
s3ObjectKey: NotRequired[str],
ActionGroupExecutorTypeDef#
# ActionGroupExecutorTypeDef definition
class ActionGroupExecutorTypeDef(TypedDict):
lambda: NotRequired[str],
ActionGroupSummaryTypeDef#
# ActionGroupSummaryTypeDef definition
class ActionGroupSummaryTypeDef(TypedDict):
actionGroupId: str,
actionGroupName: str,
actionGroupState: ActionGroupStateType, # (1)
updatedAt: datetime,
description: NotRequired[str],
AgentAliasRoutingConfigurationListItemTypeDef#
# AgentAliasRoutingConfigurationListItemTypeDef definition
class AgentAliasRoutingConfigurationListItemTypeDef(TypedDict):
agentVersion: str,
AgentKnowledgeBaseSummaryTypeDef#
# AgentKnowledgeBaseSummaryTypeDef definition
class AgentKnowledgeBaseSummaryTypeDef(TypedDict):
knowledgeBaseId: str,
knowledgeBaseState: KnowledgeBaseStateType, # (1)
updatedAt: datetime,
description: NotRequired[str],
AgentKnowledgeBaseTypeDef#
# AgentKnowledgeBaseTypeDef definition
class AgentKnowledgeBaseTypeDef(TypedDict):
agentId: str,
agentVersion: str,
knowledgeBaseId: str,
description: str,
createdAt: datetime,
updatedAt: datetime,
knowledgeBaseState: KnowledgeBaseStateType, # (1)
AgentSummaryTypeDef#
# AgentSummaryTypeDef definition
class AgentSummaryTypeDef(TypedDict):
agentId: str,
agentName: str,
agentStatus: AgentStatusType, # (1)
updatedAt: datetime,
description: NotRequired[str],
latestAgentVersion: NotRequired[str],
- See AgentStatusType
AgentVersionSummaryTypeDef#
# AgentVersionSummaryTypeDef definition
class AgentVersionSummaryTypeDef(TypedDict):
agentName: str,
agentStatus: AgentStatusType, # (1)
agentVersion: str,
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
- See AgentStatusType
AssociateAgentKnowledgeBaseRequestRequestTypeDef#
# AssociateAgentKnowledgeBaseRequestRequestTypeDef definition
class AssociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
knowledgeBaseId: str,
description: str,
knowledgeBaseState: NotRequired[KnowledgeBaseStateType], # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
FixedSizeChunkingConfigurationTypeDef#
# FixedSizeChunkingConfigurationTypeDef definition
class FixedSizeChunkingConfigurationTypeDef(TypedDict):
maxTokens: int,
overlapPercentage: int,
ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
kmsKeyArn: NotRequired[str],
S3DataSourceConfigurationTypeDef#
# S3DataSourceConfigurationTypeDef definition
class S3DataSourceConfigurationTypeDef(TypedDict):
bucketArn: str,
inclusionPrefixes: NotRequired[Sequence[str]],
DataSourceSummaryTypeDef#
# DataSourceSummaryTypeDef definition
class DataSourceSummaryTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
name: str,
status: DataSourceStatusType, # (1)
updatedAt: datetime,
description: NotRequired[str],
DeleteAgentActionGroupRequestRequestTypeDef#
# DeleteAgentActionGroupRequestRequestTypeDef definition
class DeleteAgentActionGroupRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
actionGroupId: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteAgentAliasRequestRequestTypeDef#
# DeleteAgentAliasRequestRequestTypeDef definition
class DeleteAgentAliasRequestRequestTypeDef(TypedDict):
agentId: str,
agentAliasId: str,
DeleteAgentRequestRequestTypeDef#
# DeleteAgentRequestRequestTypeDef definition
class DeleteAgentRequestRequestTypeDef(TypedDict):
agentId: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteAgentVersionRequestRequestTypeDef#
# DeleteAgentVersionRequestRequestTypeDef definition
class DeleteAgentVersionRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteDataSourceRequestRequestTypeDef#
# DeleteDataSourceRequestRequestTypeDef definition
class DeleteDataSourceRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
DeleteKnowledgeBaseRequestRequestTypeDef#
# DeleteKnowledgeBaseRequestRequestTypeDef definition
class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
DisassociateAgentKnowledgeBaseRequestRequestTypeDef#
# DisassociateAgentKnowledgeBaseRequestRequestTypeDef definition
class DisassociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
knowledgeBaseId: str,
GetAgentActionGroupRequestRequestTypeDef#
# GetAgentActionGroupRequestRequestTypeDef definition
class GetAgentActionGroupRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
actionGroupId: str,
GetAgentAliasRequestRequestTypeDef#
# GetAgentAliasRequestRequestTypeDef definition
class GetAgentAliasRequestRequestTypeDef(TypedDict):
agentId: str,
agentAliasId: str,
GetAgentKnowledgeBaseRequestRequestTypeDef#
# GetAgentKnowledgeBaseRequestRequestTypeDef definition
class GetAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
knowledgeBaseId: str,
GetAgentRequestRequestTypeDef#
# GetAgentRequestRequestTypeDef definition
class GetAgentRequestRequestTypeDef(TypedDict):
agentId: str,
GetAgentVersionRequestRequestTypeDef#
# GetAgentVersionRequestRequestTypeDef definition
class GetAgentVersionRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
GetDataSourceRequestRequestTypeDef#
# GetDataSourceRequestRequestTypeDef definition
class GetDataSourceRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
GetIngestionJobRequestRequestTypeDef#
# GetIngestionJobRequestRequestTypeDef definition
class GetIngestionJobRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
ingestionJobId: str,
GetKnowledgeBaseRequestRequestTypeDef#
# GetKnowledgeBaseRequestRequestTypeDef definition
class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
InferenceConfigurationTypeDef#
# InferenceConfigurationTypeDef definition
class InferenceConfigurationTypeDef(TypedDict):
temperature: NotRequired[float],
topP: NotRequired[float],
topK: NotRequired[int],
maximumLength: NotRequired[int],
stopSequences: NotRequired[Sequence[str]],
IngestionJobFilterTypeDef#
# IngestionJobFilterTypeDef definition
class IngestionJobFilterTypeDef(TypedDict):
attribute: IngestionJobFilterAttributeType, # (1)
operator: IngestionJobFilterOperatorType, # (2)
values: Sequence[str],
IngestionJobSortByTypeDef#
# IngestionJobSortByTypeDef definition
class IngestionJobSortByTypeDef(TypedDict):
attribute: IngestionJobSortByAttributeType, # (1)
order: SortOrderType, # (2)
IngestionJobStatisticsTypeDef#
# IngestionJobStatisticsTypeDef definition
class IngestionJobStatisticsTypeDef(TypedDict):
numberOfDocumentsScanned: NotRequired[int],
numberOfNewDocumentsIndexed: NotRequired[int],
numberOfModifiedDocumentsIndexed: NotRequired[int],
numberOfDocumentsDeleted: NotRequired[int],
numberOfDocumentsFailed: NotRequired[int],
VectorKnowledgeBaseConfigurationTypeDef#
# VectorKnowledgeBaseConfigurationTypeDef definition
class VectorKnowledgeBaseConfigurationTypeDef(TypedDict):
embeddingModelArn: str,
KnowledgeBaseSummaryTypeDef#
# KnowledgeBaseSummaryTypeDef definition
class KnowledgeBaseSummaryTypeDef(TypedDict):
knowledgeBaseId: str,
name: str,
status: KnowledgeBaseStatusType, # (1)
updatedAt: datetime,
description: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAgentActionGroupsRequestRequestTypeDef#
# ListAgentActionGroupsRequestRequestTypeDef definition
class ListAgentActionGroupsRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAgentAliasesRequestRequestTypeDef#
# ListAgentAliasesRequestRequestTypeDef definition
class ListAgentAliasesRequestRequestTypeDef(TypedDict):
agentId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAgentKnowledgeBasesRequestRequestTypeDef#
# ListAgentKnowledgeBasesRequestRequestTypeDef definition
class ListAgentKnowledgeBasesRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAgentVersionsRequestRequestTypeDef#
# ListAgentVersionsRequestRequestTypeDef definition
class ListAgentVersionsRequestRequestTypeDef(TypedDict):
agentId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAgentsRequestRequestTypeDef#
# ListAgentsRequestRequestTypeDef definition
class ListAgentsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDataSourcesRequestRequestTypeDef#
# ListDataSourcesRequestRequestTypeDef definition
class ListDataSourcesRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListKnowledgeBasesRequestRequestTypeDef#
# ListKnowledgeBasesRequestRequestTypeDef definition
class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
OpenSearchServerlessFieldMappingTypeDef#
# OpenSearchServerlessFieldMappingTypeDef definition
class OpenSearchServerlessFieldMappingTypeDef(TypedDict):
vectorField: str,
textField: str,
metadataField: str,
PineconeFieldMappingTypeDef#
# PineconeFieldMappingTypeDef definition
class PineconeFieldMappingTypeDef(TypedDict):
textField: str,
metadataField: str,
PrepareAgentRequestRequestTypeDef#
# PrepareAgentRequestRequestTypeDef definition
class PrepareAgentRequestRequestTypeDef(TypedDict):
agentId: str,
RdsFieldMappingTypeDef#
# RdsFieldMappingTypeDef definition
class RdsFieldMappingTypeDef(TypedDict):
primaryKeyField: str,
vectorField: str,
textField: str,
metadataField: str,
RedisEnterpriseCloudFieldMappingTypeDef#
# RedisEnterpriseCloudFieldMappingTypeDef definition
class RedisEnterpriseCloudFieldMappingTypeDef(TypedDict):
vectorField: str,
textField: str,
metadataField: str,
StartIngestionJobRequestRequestTypeDef#
# StartIngestionJobRequestRequestTypeDef definition
class StartIngestionJobRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
clientToken: NotRequired[str],
description: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAgentKnowledgeBaseRequestRequestTypeDef#
# UpdateAgentKnowledgeBaseRequestRequestTypeDef definition
class UpdateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
knowledgeBaseId: str,
description: NotRequired[str],
knowledgeBaseState: NotRequired[KnowledgeBaseStateType], # (1)
APISchemaTypeDef#
# APISchemaTypeDef definition
class APISchemaTypeDef(TypedDict):
s3: NotRequired[S3IdentifierTypeDef], # (1)
payload: NotRequired[str],
AgentAliasHistoryEventTypeDef#
# AgentAliasHistoryEventTypeDef definition
class AgentAliasHistoryEventTypeDef(TypedDict):
routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]], # (1)
endDate: NotRequired[datetime],
startDate: NotRequired[datetime],
AgentAliasSummaryTypeDef#
# AgentAliasSummaryTypeDef definition
class AgentAliasSummaryTypeDef(TypedDict):
agentAliasId: str,
agentAliasName: str,
agentAliasStatus: AgentAliasStatusType, # (2)
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]], # (1)
CreateAgentAliasRequestRequestTypeDef#
# CreateAgentAliasRequestRequestTypeDef definition
class CreateAgentAliasRequestRequestTypeDef(TypedDict):
agentId: str,
agentAliasName: str,
clientToken: NotRequired[str],
description: NotRequired[str],
routingConfiguration: NotRequired[Sequence[AgentAliasRoutingConfigurationListItemTypeDef]], # (1)
tags: NotRequired[Mapping[str, str]],
UpdateAgentAliasRequestRequestTypeDef#
# UpdateAgentAliasRequestRequestTypeDef definition
class UpdateAgentAliasRequestRequestTypeDef(TypedDict):
agentId: str,
agentAliasId: str,
agentAliasName: str,
description: NotRequired[str],
routingConfiguration: NotRequired[Sequence[AgentAliasRoutingConfigurationListItemTypeDef]], # (1)
AssociateAgentKnowledgeBaseResponseTypeDef#
# AssociateAgentKnowledgeBaseResponseTypeDef definition
class AssociateAgentKnowledgeBaseResponseTypeDef(TypedDict):
agentKnowledgeBase: AgentKnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteAgentAliasResponseTypeDef#
# DeleteAgentAliasResponseTypeDef definition
class DeleteAgentAliasResponseTypeDef(TypedDict):
agentId: str,
agentAliasId: str,
agentAliasStatus: AgentAliasStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteAgentResponseTypeDef#
# DeleteAgentResponseTypeDef definition
class DeleteAgentResponseTypeDef(TypedDict):
agentId: str,
agentStatus: AgentStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteAgentVersionResponseTypeDef#
# DeleteAgentVersionResponseTypeDef definition
class DeleteAgentVersionResponseTypeDef(TypedDict):
agentId: str,
agentVersion: str,
agentStatus: AgentStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDataSourceResponseTypeDef#
# DeleteDataSourceResponseTypeDef definition
class DeleteDataSourceResponseTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
status: DataSourceStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteKnowledgeBaseResponseTypeDef#
# DeleteKnowledgeBaseResponseTypeDef definition
class DeleteKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBaseId: str,
status: KnowledgeBaseStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAgentKnowledgeBaseResponseTypeDef#
# GetAgentKnowledgeBaseResponseTypeDef definition
class GetAgentKnowledgeBaseResponseTypeDef(TypedDict):
agentKnowledgeBase: AgentKnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAgentActionGroupsResponseTypeDef#
# ListAgentActionGroupsResponseTypeDef definition
class ListAgentActionGroupsResponseTypeDef(TypedDict):
actionGroupSummaries: List[ActionGroupSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAgentKnowledgeBasesResponseTypeDef#
# ListAgentKnowledgeBasesResponseTypeDef definition
class ListAgentKnowledgeBasesResponseTypeDef(TypedDict):
agentKnowledgeBaseSummaries: List[AgentKnowledgeBaseSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAgentVersionsResponseTypeDef#
# ListAgentVersionsResponseTypeDef definition
class ListAgentVersionsResponseTypeDef(TypedDict):
agentVersionSummaries: List[AgentVersionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAgentsResponseTypeDef#
# ListAgentsResponseTypeDef definition
class ListAgentsResponseTypeDef(TypedDict):
agentSummaries: List[AgentSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PrepareAgentResponseTypeDef#
# PrepareAgentResponseTypeDef definition
class PrepareAgentResponseTypeDef(TypedDict):
agentId: str,
agentStatus: AgentStatusType, # (1)
agentVersion: str,
preparedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAgentKnowledgeBaseResponseTypeDef#
# UpdateAgentKnowledgeBaseResponseTypeDef definition
class UpdateAgentKnowledgeBaseResponseTypeDef(TypedDict):
agentKnowledgeBase: AgentKnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChunkingConfigurationTypeDef#
# ChunkingConfigurationTypeDef definition
class ChunkingConfigurationTypeDef(TypedDict):
chunkingStrategy: ChunkingStrategyType, # (1)
fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef], # (2)
DataSourceConfigurationTypeDef#
# DataSourceConfigurationTypeDef definition
class DataSourceConfigurationTypeDef(TypedDict):
type: DataSourceTypeType, # (1)
s3Configuration: NotRequired[S3DataSourceConfigurationTypeDef], # (2)
ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
dataSourceSummaries: List[DataSourceSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PromptConfigurationTypeDef#
# PromptConfigurationTypeDef definition
class PromptConfigurationTypeDef(TypedDict):
promptType: NotRequired[PromptTypeType], # (1)
promptCreationMode: NotRequired[CreationModeType], # (2)
promptState: NotRequired[PromptStateType], # (3)
basePromptTemplate: NotRequired[str],
inferenceConfiguration: NotRequired[InferenceConfigurationTypeDef], # (4)
parserMode: NotRequired[CreationModeType], # (2)
- See PromptTypeType
- See CreationModeType
- See PromptStateType
- See InferenceConfigurationTypeDef
- See CreationModeType
ListIngestionJobsRequestRequestTypeDef#
# ListIngestionJobsRequestRequestTypeDef definition
class ListIngestionJobsRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
filters: NotRequired[Sequence[IngestionJobFilterTypeDef]], # (1)
sortBy: NotRequired[IngestionJobSortByTypeDef], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
IngestionJobSummaryTypeDef#
# IngestionJobSummaryTypeDef definition
class IngestionJobSummaryTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
ingestionJobId: str,
status: IngestionJobStatusType, # (1)
startedAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
statistics: NotRequired[IngestionJobStatisticsTypeDef], # (2)
IngestionJobTypeDef#
# IngestionJobTypeDef definition
class IngestionJobTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
ingestionJobId: str,
status: IngestionJobStatusType, # (1)
startedAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
statistics: NotRequired[IngestionJobStatisticsTypeDef], # (2)
failureReasons: NotRequired[List[str]],
KnowledgeBaseConfigurationTypeDef#
# KnowledgeBaseConfigurationTypeDef definition
class KnowledgeBaseConfigurationTypeDef(TypedDict):
type: KnowledgeBaseTypeType, # (1)
vectorKnowledgeBaseConfiguration: NotRequired[VectorKnowledgeBaseConfigurationTypeDef], # (2)
ListKnowledgeBasesResponseTypeDef#
# ListKnowledgeBasesResponseTypeDef definition
class ListKnowledgeBasesResponseTypeDef(TypedDict):
knowledgeBaseSummaries: List[KnowledgeBaseSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef#
# ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef definition
class ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef(TypedDict):
agentId: str,
agentVersion: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAgentAliasesRequestListAgentAliasesPaginateTypeDef#
# ListAgentAliasesRequestListAgentAliasesPaginateTypeDef definition
class ListAgentAliasesRequestListAgentAliasesPaginateTypeDef(TypedDict):
agentId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef#
# ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef definition
class ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef(TypedDict):
agentId: str,
agentVersion: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAgentVersionsRequestListAgentVersionsPaginateTypeDef#
# ListAgentVersionsRequestListAgentVersionsPaginateTypeDef definition
class ListAgentVersionsRequestListAgentVersionsPaginateTypeDef(TypedDict):
agentId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAgentsRequestListAgentsPaginateTypeDef#
# ListAgentsRequestListAgentsPaginateTypeDef definition
class ListAgentsRequestListAgentsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataSourcesRequestListDataSourcesPaginateTypeDef#
# ListDataSourcesRequestListDataSourcesPaginateTypeDef definition
class ListDataSourcesRequestListDataSourcesPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIngestionJobsRequestListIngestionJobsPaginateTypeDef#
# ListIngestionJobsRequestListIngestionJobsPaginateTypeDef definition
class ListIngestionJobsRequestListIngestionJobsPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
filters: NotRequired[Sequence[IngestionJobFilterTypeDef]], # (1)
sortBy: NotRequired[IngestionJobSortByTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef#
# ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef definition
class ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
OpenSearchServerlessConfigurationTypeDef#
# OpenSearchServerlessConfigurationTypeDef definition
class OpenSearchServerlessConfigurationTypeDef(TypedDict):
collectionArn: str,
vectorIndexName: str,
fieldMapping: OpenSearchServerlessFieldMappingTypeDef, # (1)
PineconeConfigurationTypeDef#
# PineconeConfigurationTypeDef definition
class PineconeConfigurationTypeDef(TypedDict):
connectionString: str,
credentialsSecretArn: str,
fieldMapping: PineconeFieldMappingTypeDef, # (1)
namespace: NotRequired[str],
RdsConfigurationTypeDef#
# RdsConfigurationTypeDef definition
class RdsConfigurationTypeDef(TypedDict):
resourceArn: str,
credentialsSecretArn: str,
databaseName: str,
tableName: str,
fieldMapping: RdsFieldMappingTypeDef, # (1)
RedisEnterpriseCloudConfigurationTypeDef#
# RedisEnterpriseCloudConfigurationTypeDef definition
class RedisEnterpriseCloudConfigurationTypeDef(TypedDict):
endpoint: str,
vectorIndexName: str,
credentialsSecretArn: str,
fieldMapping: RedisEnterpriseCloudFieldMappingTypeDef, # (1)
AgentActionGroupTypeDef#
# AgentActionGroupTypeDef definition
class AgentActionGroupTypeDef(TypedDict):
agentId: str,
agentVersion: str,
actionGroupId: str,
actionGroupName: str,
createdAt: datetime,
updatedAt: datetime,
actionGroupState: ActionGroupStateType, # (4)
clientToken: NotRequired[str],
description: NotRequired[str],
parentActionSignature: NotRequired[ActionGroupSignatureType], # (1)
actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef], # (2)
apiSchema: NotRequired[APISchemaTypeDef], # (3)
- See ActionGroupSignatureType
- See ActionGroupExecutorTypeDef
- See APISchemaTypeDef
- See ActionGroupStateType
CreateAgentActionGroupRequestRequestTypeDef#
# CreateAgentActionGroupRequestRequestTypeDef definition
class CreateAgentActionGroupRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
actionGroupName: str,
clientToken: NotRequired[str],
description: NotRequired[str],
parentActionGroupSignature: NotRequired[ActionGroupSignatureType], # (1)
actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef], # (2)
apiSchema: NotRequired[APISchemaTypeDef], # (3)
actionGroupState: NotRequired[ActionGroupStateType], # (4)
- See ActionGroupSignatureType
- See ActionGroupExecutorTypeDef
- See APISchemaTypeDef
- See ActionGroupStateType
UpdateAgentActionGroupRequestRequestTypeDef#
# UpdateAgentActionGroupRequestRequestTypeDef definition
class UpdateAgentActionGroupRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
actionGroupId: str,
actionGroupName: str,
description: NotRequired[str],
parentActionGroupSignature: NotRequired[ActionGroupSignatureType], # (1)
actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef], # (2)
actionGroupState: NotRequired[ActionGroupStateType], # (3)
apiSchema: NotRequired[APISchemaTypeDef], # (4)
- See ActionGroupSignatureType
- See ActionGroupExecutorTypeDef
- See ActionGroupStateType
- See APISchemaTypeDef
AgentAliasTypeDef#
# AgentAliasTypeDef definition
class AgentAliasTypeDef(TypedDict):
agentId: str,
agentAliasId: str,
agentAliasName: str,
agentAliasArn: str,
routingConfiguration: List[AgentAliasRoutingConfigurationListItemTypeDef], # (1)
createdAt: datetime,
updatedAt: datetime,
agentAliasStatus: AgentAliasStatusType, # (3)
clientToken: NotRequired[str],
description: NotRequired[str],
agentAliasHistoryEvents: NotRequired[List[AgentAliasHistoryEventTypeDef]], # (2)
- See AgentAliasRoutingConfigurationListItemTypeDef
- See AgentAliasHistoryEventTypeDef
- See AgentAliasStatusType
ListAgentAliasesResponseTypeDef#
# ListAgentAliasesResponseTypeDef definition
class ListAgentAliasesResponseTypeDef(TypedDict):
agentAliasSummaries: List[AgentAliasSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VectorIngestionConfigurationTypeDef#
# VectorIngestionConfigurationTypeDef definition
class VectorIngestionConfigurationTypeDef(TypedDict):
chunkingConfiguration: NotRequired[ChunkingConfigurationTypeDef], # (1)
PromptOverrideConfigurationTypeDef#
# PromptOverrideConfigurationTypeDef definition
class PromptOverrideConfigurationTypeDef(TypedDict):
promptConfigurations: Sequence[PromptConfigurationTypeDef], # (1)
overrideLambda: NotRequired[str],
ListIngestionJobsResponseTypeDef#
# ListIngestionJobsResponseTypeDef definition
class ListIngestionJobsResponseTypeDef(TypedDict):
ingestionJobSummaries: List[IngestionJobSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIngestionJobResponseTypeDef#
# GetIngestionJobResponseTypeDef definition
class GetIngestionJobResponseTypeDef(TypedDict):
ingestionJob: IngestionJobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartIngestionJobResponseTypeDef#
# StartIngestionJobResponseTypeDef definition
class StartIngestionJobResponseTypeDef(TypedDict):
ingestionJob: IngestionJobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StorageConfigurationTypeDef#
# StorageConfigurationTypeDef definition
class StorageConfigurationTypeDef(TypedDict):
type: KnowledgeBaseStorageTypeType, # (1)
opensearchServerlessConfiguration: NotRequired[OpenSearchServerlessConfigurationTypeDef], # (2)
pineconeConfiguration: NotRequired[PineconeConfigurationTypeDef], # (3)
redisEnterpriseCloudConfiguration: NotRequired[RedisEnterpriseCloudConfigurationTypeDef], # (4)
rdsConfiguration: NotRequired[RdsConfigurationTypeDef], # (5)
- See KnowledgeBaseStorageTypeType
- See OpenSearchServerlessConfigurationTypeDef
- See PineconeConfigurationTypeDef
- See RedisEnterpriseCloudConfigurationTypeDef
- See RdsConfigurationTypeDef
CreateAgentActionGroupResponseTypeDef#
# CreateAgentActionGroupResponseTypeDef definition
class CreateAgentActionGroupResponseTypeDef(TypedDict):
agentActionGroup: AgentActionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAgentActionGroupResponseTypeDef#
# GetAgentActionGroupResponseTypeDef definition
class GetAgentActionGroupResponseTypeDef(TypedDict):
agentActionGroup: AgentActionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAgentActionGroupResponseTypeDef#
# UpdateAgentActionGroupResponseTypeDef definition
class UpdateAgentActionGroupResponseTypeDef(TypedDict):
agentActionGroup: AgentActionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAgentAliasResponseTypeDef#
# CreateAgentAliasResponseTypeDef definition
class CreateAgentAliasResponseTypeDef(TypedDict):
agentAlias: AgentAliasTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAgentAliasResponseTypeDef#
# GetAgentAliasResponseTypeDef definition
class GetAgentAliasResponseTypeDef(TypedDict):
agentAlias: AgentAliasTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAgentAliasResponseTypeDef#
# UpdateAgentAliasResponseTypeDef definition
class UpdateAgentAliasResponseTypeDef(TypedDict):
agentAlias: AgentAliasTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDataSourceRequestRequestTypeDef#
# CreateDataSourceRequestRequestTypeDef definition
class CreateDataSourceRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
name: str,
dataSourceConfiguration: DataSourceConfigurationTypeDef, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef], # (3)
- See DataSourceConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See VectorIngestionConfigurationTypeDef
DataSourceTypeDef#
# DataSourceTypeDef definition
class DataSourceTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
name: str,
status: DataSourceStatusType, # (1)
dataSourceConfiguration: DataSourceConfigurationTypeDef, # (2)
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (3)
vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef], # (4)
- See DataSourceStatusType
- See DataSourceConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See VectorIngestionConfigurationTypeDef
UpdateDataSourceRequestRequestTypeDef#
# UpdateDataSourceRequestRequestTypeDef definition
class UpdateDataSourceRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
dataSourceId: str,
name: str,
dataSourceConfiguration: DataSourceConfigurationTypeDef, # (1)
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef], # (3)
- See DataSourceConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See VectorIngestionConfigurationTypeDef
AgentTypeDef#
# AgentTypeDef definition
class AgentTypeDef(TypedDict):
agentId: str,
agentName: str,
agentArn: str,
agentVersion: str,
agentStatus: AgentStatusType, # (1)
idleSessionTTLInSeconds: int,
agentResourceRoleArn: str,
createdAt: datetime,
updatedAt: datetime,
clientToken: NotRequired[str],
instruction: NotRequired[str],
foundationModel: NotRequired[str],
description: NotRequired[str],
customerEncryptionKeyArn: NotRequired[str],
preparedAt: NotRequired[datetime],
failureReasons: NotRequired[List[str]],
recommendedActions: NotRequired[List[str]],
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (2)
AgentVersionTypeDef#
# AgentVersionTypeDef definition
class AgentVersionTypeDef(TypedDict):
agentId: str,
agentName: str,
agentArn: str,
version: str,
agentStatus: AgentStatusType, # (1)
idleSessionTTLInSeconds: int,
agentResourceRoleArn: str,
createdAt: datetime,
updatedAt: datetime,
instruction: NotRequired[str],
foundationModel: NotRequired[str],
description: NotRequired[str],
customerEncryptionKeyArn: NotRequired[str],
failureReasons: NotRequired[List[str]],
recommendedActions: NotRequired[List[str]],
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (2)
CreateAgentRequestRequestTypeDef#
# CreateAgentRequestRequestTypeDef definition
class CreateAgentRequestRequestTypeDef(TypedDict):
agentName: str,
agentResourceRoleArn: str,
clientToken: NotRequired[str],
instruction: NotRequired[str],
foundationModel: NotRequired[str],
description: NotRequired[str],
idleSessionTTLInSeconds: NotRequired[int],
customerEncryptionKeyArn: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (1)
UpdateAgentRequestRequestTypeDef#
# UpdateAgentRequestRequestTypeDef definition
class UpdateAgentRequestRequestTypeDef(TypedDict):
agentId: str,
agentName: str,
agentResourceRoleArn: str,
instruction: NotRequired[str],
foundationModel: NotRequired[str],
description: NotRequired[str],
idleSessionTTLInSeconds: NotRequired[int],
customerEncryptionKeyArn: NotRequired[str],
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (1)
CreateKnowledgeBaseRequestRequestTypeDef#
# CreateKnowledgeBaseRequestRequestTypeDef definition
class CreateKnowledgeBaseRequestRequestTypeDef(TypedDict):
name: str,
roleArn: str,
knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef, # (1)
storageConfiguration: StorageConfigurationTypeDef, # (2)
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
KnowledgeBaseTypeDef#
# KnowledgeBaseTypeDef definition
class KnowledgeBaseTypeDef(TypedDict):
knowledgeBaseId: str,
name: str,
knowledgeBaseArn: str,
roleArn: str,
knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef, # (1)
storageConfiguration: StorageConfigurationTypeDef, # (2)
status: KnowledgeBaseStatusType, # (3)
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
failureReasons: NotRequired[List[str]],
UpdateKnowledgeBaseRequestRequestTypeDef#
# UpdateKnowledgeBaseRequestRequestTypeDef definition
class UpdateKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
name: str,
roleArn: str,
knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef, # (1)
storageConfiguration: StorageConfigurationTypeDef, # (2)
description: NotRequired[str],
CreateDataSourceResponseTypeDef#
# CreateDataSourceResponseTypeDef definition
class CreateDataSourceResponseTypeDef(TypedDict):
dataSource: DataSourceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDataSourceResponseTypeDef#
# GetDataSourceResponseTypeDef definition
class GetDataSourceResponseTypeDef(TypedDict):
dataSource: DataSourceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDataSourceResponseTypeDef#
# UpdateDataSourceResponseTypeDef definition
class UpdateDataSourceResponseTypeDef(TypedDict):
dataSource: DataSourceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAgentResponseTypeDef#
# CreateAgentResponseTypeDef definition
class CreateAgentResponseTypeDef(TypedDict):
agent: AgentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AgentTypeDef
- See ResponseMetadataTypeDef
GetAgentResponseTypeDef#
# GetAgentResponseTypeDef definition
class GetAgentResponseTypeDef(TypedDict):
agent: AgentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AgentTypeDef
- See ResponseMetadataTypeDef
UpdateAgentResponseTypeDef#
# UpdateAgentResponseTypeDef definition
class UpdateAgentResponseTypeDef(TypedDict):
agent: AgentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AgentTypeDef
- See ResponseMetadataTypeDef
GetAgentVersionResponseTypeDef#
# GetAgentVersionResponseTypeDef definition
class GetAgentVersionResponseTypeDef(TypedDict):
agentVersion: AgentVersionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateKnowledgeBaseResponseTypeDef#
# CreateKnowledgeBaseResponseTypeDef definition
class CreateKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetKnowledgeBaseResponseTypeDef#
# GetKnowledgeBaseResponseTypeDef definition
class GetKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateKnowledgeBaseResponseTypeDef#
# UpdateKnowledgeBaseResponseTypeDef definition
class UpdateKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)