Skip to content

Type definitions#

Index > AgentsforBedrock > Type definitions

Auto-generated documentation for AgentsforBedrock type annotations stubs module mypy-boto3-bedrock-agent.

DataSourceConfigurationUnionTypeDef#

# DataSourceConfigurationUnionTypeDef definition

DataSourceConfigurationUnionTypeDef = Union[
    DataSourceConfigurationTypeDef,  # (1)
    DataSourceConfigurationOutputTypeDef,  # (2)
]
  1. See DataSourceConfigurationTypeDef
  2. See DataSourceConfigurationOutputTypeDef

FunctionSchemaUnionTypeDef#

# FunctionSchemaUnionTypeDef definition

FunctionSchemaUnionTypeDef = Union[
    FunctionSchemaTypeDef,  # (1)
    FunctionSchemaOutputTypeDef,  # (2)
]
  1. See FunctionSchemaTypeDef
  2. See FunctionSchemaOutputTypeDef

PromptOverrideConfigurationUnionTypeDef#

# PromptOverrideConfigurationUnionTypeDef definition

PromptOverrideConfigurationUnionTypeDef = Union[
    PromptOverrideConfigurationTypeDef,  # (1)
    PromptOverrideConfigurationOutputTypeDef,  # (2)
]
  1. See PromptOverrideConfigurationTypeDef
  2. See PromptOverrideConfigurationOutputTypeDef

S3IdentifierTypeDef#

# S3IdentifierTypeDef definition

class S3IdentifierTypeDef(TypedDict):
    s3BucketName: NotRequired[str],
    s3ObjectKey: NotRequired[str],

ActionGroupExecutorTypeDef#

# ActionGroupExecutorTypeDef definition

class ActionGroupExecutorTypeDef(TypedDict):
    customControl: NotRequired[CustomControlMethodType],  # (1)
    lambda: NotRequired[str],
  1. See CustomControlMethodType

ActionGroupSummaryTypeDef#

# ActionGroupSummaryTypeDef definition

class ActionGroupSummaryTypeDef(TypedDict):
    actionGroupId: str,
    actionGroupName: str,
    actionGroupState: ActionGroupStateType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See ActionGroupStateType

AgentAliasRoutingConfigurationListItemTypeDef#

# AgentAliasRoutingConfigurationListItemTypeDef definition

class AgentAliasRoutingConfigurationListItemTypeDef(TypedDict):
    agentVersion: str,

AgentKnowledgeBaseSummaryTypeDef#

# AgentKnowledgeBaseSummaryTypeDef definition

class AgentKnowledgeBaseSummaryTypeDef(TypedDict):
    knowledgeBaseId: str,
    knowledgeBaseState: KnowledgeBaseStateType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See KnowledgeBaseStateType

AgentKnowledgeBaseTypeDef#

# AgentKnowledgeBaseTypeDef definition

class AgentKnowledgeBaseTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    createdAt: datetime,
    description: str,
    knowledgeBaseId: str,
    knowledgeBaseState: KnowledgeBaseStateType,  # (1)
    updatedAt: datetime,
  1. See KnowledgeBaseStateType

AgentSummaryTypeDef#

# AgentSummaryTypeDef definition

class AgentSummaryTypeDef(TypedDict):
    agentId: str,
    agentName: str,
    agentStatus: AgentStatusType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
    latestAgentVersion: NotRequired[str],
  1. See AgentStatusType

AgentVersionSummaryTypeDef#

# AgentVersionSummaryTypeDef definition

class AgentVersionSummaryTypeDef(TypedDict):
    agentName: str,
    agentStatus: AgentStatusType,  # (1)
    agentVersion: str,
    createdAt: datetime,
    updatedAt: datetime,
    description: NotRequired[str],
  1. See AgentStatusType

AssociateAgentKnowledgeBaseRequestRequestTypeDef#

# AssociateAgentKnowledgeBaseRequestRequestTypeDef definition

class AssociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    description: str,
    knowledgeBaseId: str,
    knowledgeBaseState: NotRequired[KnowledgeBaseStateType],  # (1)
  1. See KnowledgeBaseStateType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

FixedSizeChunkingConfigurationTypeDef#

# FixedSizeChunkingConfigurationTypeDef definition

class FixedSizeChunkingConfigurationTypeDef(TypedDict):
    maxTokens: int,
    overlapPercentage: int,

ServerSideEncryptionConfigurationTypeDef#

# ServerSideEncryptionConfigurationTypeDef definition

class ServerSideEncryptionConfigurationTypeDef(TypedDict):
    kmsKeyArn: NotRequired[str],

S3DataSourceConfigurationOutputTypeDef#

# S3DataSourceConfigurationOutputTypeDef definition

class S3DataSourceConfigurationOutputTypeDef(TypedDict):
    bucketArn: str,
    bucketOwnerAccountId: NotRequired[str],
    inclusionPrefixes: NotRequired[List[str]],

S3DataSourceConfigurationTypeDef#

# S3DataSourceConfigurationTypeDef definition

class S3DataSourceConfigurationTypeDef(TypedDict):
    bucketArn: str,
    bucketOwnerAccountId: NotRequired[str],
    inclusionPrefixes: NotRequired[Sequence[str]],

DataSourceSummaryTypeDef#

# DataSourceSummaryTypeDef definition

class DataSourceSummaryTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,
    name: str,
    status: DataSourceStatusType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See DataSourceStatusType

DeleteAgentActionGroupRequestRequestTypeDef#

# DeleteAgentActionGroupRequestRequestTypeDef definition

class DeleteAgentActionGroupRequestRequestTypeDef(TypedDict):
    actionGroupId: str,
    agentId: str,
    agentVersion: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteAgentAliasRequestRequestTypeDef#

# DeleteAgentAliasRequestRequestTypeDef definition

class DeleteAgentAliasRequestRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: 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):
    dataSourceId: str,
    knowledgeBaseId: str,

DeleteKnowledgeBaseRequestRequestTypeDef#

# DeleteKnowledgeBaseRequestRequestTypeDef definition

class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

DisassociateAgentKnowledgeBaseRequestRequestTypeDef#

# DisassociateAgentKnowledgeBaseRequestRequestTypeDef definition

class DisassociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,

ParameterDetailTypeDef#

# ParameterDetailTypeDef definition

class ParameterDetailTypeDef(TypedDict):
    type: TypeType,  # (1)
    description: NotRequired[str],
    required: NotRequired[bool],
  1. See TypeType

GetAgentActionGroupRequestRequestTypeDef#

# GetAgentActionGroupRequestRequestTypeDef definition

class GetAgentActionGroupRequestRequestTypeDef(TypedDict):
    actionGroupId: str,
    agentId: str,
    agentVersion: str,

GetAgentAliasRequestRequestTypeDef#

# GetAgentAliasRequestRequestTypeDef definition

class GetAgentAliasRequestRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: 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):
    dataSourceId: str,
    knowledgeBaseId: str,

GetIngestionJobRequestRequestTypeDef#

# GetIngestionJobRequestRequestTypeDef definition

class GetIngestionJobRequestRequestTypeDef(TypedDict):
    dataSourceId: str,
    ingestionJobId: str,
    knowledgeBaseId: str,

GetKnowledgeBaseRequestRequestTypeDef#

# GetKnowledgeBaseRequestRequestTypeDef definition

class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

InferenceConfigurationOutputTypeDef#

# InferenceConfigurationOutputTypeDef definition

class InferenceConfigurationOutputTypeDef(TypedDict):
    maximumLength: NotRequired[int],
    stopSequences: NotRequired[List[str]],
    temperature: NotRequired[float],
    topK: NotRequired[int],
    topP: NotRequired[float],

InferenceConfigurationTypeDef#

# InferenceConfigurationTypeDef definition

class InferenceConfigurationTypeDef(TypedDict):
    maximumLength: NotRequired[int],
    stopSequences: NotRequired[Sequence[str]],
    temperature: NotRequired[float],
    topK: NotRequired[int],
    topP: NotRequired[float],

IngestionJobFilterTypeDef#

# IngestionJobFilterTypeDef definition

class IngestionJobFilterTypeDef(TypedDict):
    attribute: IngestionJobFilterAttributeType,  # (1)
    operator: IngestionJobFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See IngestionJobFilterAttributeType
  2. See IngestionJobFilterOperatorType

IngestionJobSortByTypeDef#

# IngestionJobSortByTypeDef definition

class IngestionJobSortByTypeDef(TypedDict):
    attribute: IngestionJobSortByAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See IngestionJobSortByAttributeType
  2. See SortOrderType

IngestionJobStatisticsTypeDef#

# IngestionJobStatisticsTypeDef definition

class IngestionJobStatisticsTypeDef(TypedDict):
    numberOfDocumentsDeleted: NotRequired[int],
    numberOfDocumentsFailed: NotRequired[int],
    numberOfDocumentsScanned: NotRequired[int],
    numberOfMetadataDocumentsModified: NotRequired[int],
    numberOfMetadataDocumentsScanned: NotRequired[int],
    numberOfModifiedDocumentsIndexed: NotRequired[int],
    numberOfNewDocumentsIndexed: 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],
  1. See KnowledgeBaseStatusType

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):
    metadataField: str,
    textField: str,
    vectorField: str,

PineconeFieldMappingTypeDef#

# PineconeFieldMappingTypeDef definition

class PineconeFieldMappingTypeDef(TypedDict):
    metadataField: str,
    textField: str,

PrepareAgentRequestRequestTypeDef#

# PrepareAgentRequestRequestTypeDef definition

class PrepareAgentRequestRequestTypeDef(TypedDict):
    agentId: str,

RdsFieldMappingTypeDef#

# RdsFieldMappingTypeDef definition

class RdsFieldMappingTypeDef(TypedDict):
    metadataField: str,
    primaryKeyField: str,
    textField: str,
    vectorField: str,

RedisEnterpriseCloudFieldMappingTypeDef#

# RedisEnterpriseCloudFieldMappingTypeDef definition

class RedisEnterpriseCloudFieldMappingTypeDef(TypedDict):
    metadataField: str,
    textField: str,
    vectorField: str,

StartIngestionJobRequestRequestTypeDef#

# StartIngestionJobRequestRequestTypeDef definition

class StartIngestionJobRequestRequestTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: 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)
  1. See KnowledgeBaseStateType

APISchemaTypeDef#

# APISchemaTypeDef definition

class APISchemaTypeDef(TypedDict):
    payload: NotRequired[str],
    s3: NotRequired[S3IdentifierTypeDef],  # (1)
  1. See S3IdentifierTypeDef

AgentAliasHistoryEventTypeDef#

# AgentAliasHistoryEventTypeDef definition

class AgentAliasHistoryEventTypeDef(TypedDict):
    endDate: NotRequired[datetime],
    routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]],  # (1)
    startDate: NotRequired[datetime],
  1. See AgentAliasRoutingConfigurationListItemTypeDef

AgentAliasSummaryTypeDef#

# AgentAliasSummaryTypeDef definition

class AgentAliasSummaryTypeDef(TypedDict):
    agentAliasId: str,
    agentAliasName: str,
    agentAliasStatus: AgentAliasStatusType,  # (1)
    createdAt: datetime,
    updatedAt: datetime,
    description: NotRequired[str],
    routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]],  # (2)
  1. See AgentAliasStatusType
  2. See AgentAliasRoutingConfigurationListItemTypeDef

CreateAgentAliasRequestRequestTypeDef#

# CreateAgentAliasRequestRequestTypeDef definition

class CreateAgentAliasRequestRequestTypeDef(TypedDict):
    agentAliasName: str,
    agentId: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    routingConfiguration: NotRequired[Sequence[AgentAliasRoutingConfigurationListItemTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See AgentAliasRoutingConfigurationListItemTypeDef

UpdateAgentAliasRequestRequestTypeDef#

# UpdateAgentAliasRequestRequestTypeDef definition

class UpdateAgentAliasRequestRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentAliasName: str,
    agentId: str,
    description: NotRequired[str],
    routingConfiguration: NotRequired[Sequence[AgentAliasRoutingConfigurationListItemTypeDef]],  # (1)
  1. See AgentAliasRoutingConfigurationListItemTypeDef

AssociateAgentKnowledgeBaseResponseTypeDef#

# AssociateAgentKnowledgeBaseResponseTypeDef definition

class AssociateAgentKnowledgeBaseResponseTypeDef(TypedDict):
    agentKnowledgeBase: AgentKnowledgeBaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentKnowledgeBaseTypeDef
  2. See ResponseMetadataTypeDef

DeleteAgentAliasResponseTypeDef#

# DeleteAgentAliasResponseTypeDef definition

class DeleteAgentAliasResponseTypeDef(TypedDict):
    agentAliasId: str,
    agentAliasStatus: AgentAliasStatusType,  # (1)
    agentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentAliasStatusType
  2. See ResponseMetadataTypeDef

DeleteAgentResponseTypeDef#

# DeleteAgentResponseTypeDef definition

class DeleteAgentResponseTypeDef(TypedDict):
    agentId: str,
    agentStatus: AgentStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentStatusType
  2. See ResponseMetadataTypeDef

DeleteAgentVersionResponseTypeDef#

# DeleteAgentVersionResponseTypeDef definition

class DeleteAgentVersionResponseTypeDef(TypedDict):
    agentId: str,
    agentStatus: AgentStatusType,  # (1)
    agentVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentStatusType
  2. See ResponseMetadataTypeDef

DeleteDataSourceResponseTypeDef#

# DeleteDataSourceResponseTypeDef definition

class DeleteDataSourceResponseTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,
    status: DataSourceStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceStatusType
  2. See ResponseMetadataTypeDef

DeleteKnowledgeBaseResponseTypeDef#

# DeleteKnowledgeBaseResponseTypeDef definition

class DeleteKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBaseId: str,
    status: KnowledgeBaseStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseStatusType
  2. See ResponseMetadataTypeDef

GetAgentKnowledgeBaseResponseTypeDef#

# GetAgentKnowledgeBaseResponseTypeDef definition

class GetAgentKnowledgeBaseResponseTypeDef(TypedDict):
    agentKnowledgeBase: AgentKnowledgeBaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentKnowledgeBaseTypeDef
  2. See ResponseMetadataTypeDef

ListAgentActionGroupsResponseTypeDef#

# ListAgentActionGroupsResponseTypeDef definition

class ListAgentActionGroupsResponseTypeDef(TypedDict):
    actionGroupSummaries: List[ActionGroupSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ActionGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAgentKnowledgeBasesResponseTypeDef#

# ListAgentKnowledgeBasesResponseTypeDef definition

class ListAgentKnowledgeBasesResponseTypeDef(TypedDict):
    agentKnowledgeBaseSummaries: List[AgentKnowledgeBaseSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentKnowledgeBaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAgentVersionsResponseTypeDef#

# ListAgentVersionsResponseTypeDef definition

class ListAgentVersionsResponseTypeDef(TypedDict):
    agentVersionSummaries: List[AgentVersionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAgentsResponseTypeDef#

# ListAgentsResponseTypeDef definition

class ListAgentsResponseTypeDef(TypedDict):
    agentSummaries: List[AgentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PrepareAgentResponseTypeDef#

# PrepareAgentResponseTypeDef definition

class PrepareAgentResponseTypeDef(TypedDict):
    agentId: str,
    agentStatus: AgentStatusType,  # (1)
    agentVersion: str,
    preparedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentStatusType
  2. See ResponseMetadataTypeDef

UpdateAgentKnowledgeBaseResponseTypeDef#

# UpdateAgentKnowledgeBaseResponseTypeDef definition

class UpdateAgentKnowledgeBaseResponseTypeDef(TypedDict):
    agentKnowledgeBase: AgentKnowledgeBaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentKnowledgeBaseTypeDef
  2. See ResponseMetadataTypeDef

ChunkingConfigurationTypeDef#

# ChunkingConfigurationTypeDef definition

class ChunkingConfigurationTypeDef(TypedDict):
    chunkingStrategy: ChunkingStrategyType,  # (1)
    fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef],  # (2)
  1. See ChunkingStrategyType
  2. See FixedSizeChunkingConfigurationTypeDef

DataSourceConfigurationOutputTypeDef#

# DataSourceConfigurationOutputTypeDef definition

class DataSourceConfigurationOutputTypeDef(TypedDict):
    type: DataSourceTypeType,  # (2)
    s3Configuration: NotRequired[S3DataSourceConfigurationOutputTypeDef],  # (1)
  1. See S3DataSourceConfigurationOutputTypeDef
  2. See DataSourceTypeType

DataSourceConfigurationTypeDef#

# DataSourceConfigurationTypeDef definition

class DataSourceConfigurationTypeDef(TypedDict):
    type: DataSourceTypeType,  # (2)
    s3Configuration: NotRequired[S3DataSourceConfigurationTypeDef],  # (1)
  1. See S3DataSourceConfigurationTypeDef
  2. See DataSourceTypeType

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef definition

class ListDataSourcesResponseTypeDef(TypedDict):
    dataSourceSummaries: List[DataSourceSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceSummaryTypeDef
  2. See ResponseMetadataTypeDef

FunctionOutputTypeDef#

# FunctionOutputTypeDef definition

class FunctionOutputTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    parameters: NotRequired[Dict[str, ParameterDetailTypeDef]],  # (1)
  1. See ParameterDetailTypeDef

FunctionTypeDef#

# FunctionTypeDef definition

class FunctionTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    parameters: NotRequired[Mapping[str, ParameterDetailTypeDef]],  # (1)
  1. See ParameterDetailTypeDef

PromptConfigurationOutputTypeDef#

# PromptConfigurationOutputTypeDef definition

class PromptConfigurationOutputTypeDef(TypedDict):
    basePromptTemplate: NotRequired[str],
    inferenceConfiguration: NotRequired[InferenceConfigurationOutputTypeDef],  # (1)
    parserMode: NotRequired[CreationModeType],  # (2)
    promptCreationMode: NotRequired[CreationModeType],  # (2)
    promptState: NotRequired[PromptStateType],  # (4)
    promptType: NotRequired[PromptTypeType],  # (5)
  1. See InferenceConfigurationOutputTypeDef
  2. See CreationModeType
  3. See CreationModeType
  4. See PromptStateType
  5. See PromptTypeType

PromptConfigurationTypeDef#

# PromptConfigurationTypeDef definition

class PromptConfigurationTypeDef(TypedDict):
    basePromptTemplate: NotRequired[str],
    inferenceConfiguration: NotRequired[InferenceConfigurationTypeDef],  # (1)
    parserMode: NotRequired[CreationModeType],  # (2)
    promptCreationMode: NotRequired[CreationModeType],  # (2)
    promptState: NotRequired[PromptStateType],  # (4)
    promptType: NotRequired[PromptTypeType],  # (5)
  1. See InferenceConfigurationTypeDef
  2. See CreationModeType
  3. See CreationModeType
  4. See PromptStateType
  5. See PromptTypeType

ListIngestionJobsRequestRequestTypeDef#

# ListIngestionJobsRequestRequestTypeDef definition

class ListIngestionJobsRequestRequestTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,
    filters: NotRequired[Sequence[IngestionJobFilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[IngestionJobSortByTypeDef],  # (2)
  1. See IngestionJobFilterTypeDef
  2. See IngestionJobSortByTypeDef

IngestionJobSummaryTypeDef#

# IngestionJobSummaryTypeDef definition

class IngestionJobSummaryTypeDef(TypedDict):
    dataSourceId: str,
    ingestionJobId: str,
    knowledgeBaseId: str,
    startedAt: datetime,
    status: IngestionJobStatusType,  # (2)
    updatedAt: datetime,
    description: NotRequired[str],
    statistics: NotRequired[IngestionJobStatisticsTypeDef],  # (1)
  1. See IngestionJobStatisticsTypeDef
  2. See IngestionJobStatusType

IngestionJobTypeDef#

# IngestionJobTypeDef definition

class IngestionJobTypeDef(TypedDict):
    dataSourceId: str,
    ingestionJobId: str,
    knowledgeBaseId: str,
    startedAt: datetime,
    status: IngestionJobStatusType,  # (2)
    updatedAt: datetime,
    description: NotRequired[str],
    failureReasons: NotRequired[List[str]],
    statistics: NotRequired[IngestionJobStatisticsTypeDef],  # (1)
  1. See IngestionJobStatisticsTypeDef
  2. See IngestionJobStatusType

KnowledgeBaseConfigurationTypeDef#

# KnowledgeBaseConfigurationTypeDef definition

class KnowledgeBaseConfigurationTypeDef(TypedDict):
    type: KnowledgeBaseTypeType,  # (1)
    vectorKnowledgeBaseConfiguration: NotRequired[VectorKnowledgeBaseConfigurationTypeDef],  # (2)
  1. See KnowledgeBaseTypeType
  2. See VectorKnowledgeBaseConfigurationTypeDef

ListKnowledgeBasesResponseTypeDef#

# ListKnowledgeBasesResponseTypeDef definition

class ListKnowledgeBasesResponseTypeDef(TypedDict):
    knowledgeBaseSummaries: List[KnowledgeBaseSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef#

# ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef definition

class ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAgentAliasesRequestListAgentAliasesPaginateTypeDef#

# ListAgentAliasesRequestListAgentAliasesPaginateTypeDef definition

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

ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef#

# ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef definition

class ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAgentVersionsRequestListAgentVersionsPaginateTypeDef#

# ListAgentVersionsRequestListAgentVersionsPaginateTypeDef definition

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

ListAgentsRequestListAgentsPaginateTypeDef#

# ListAgentsRequestListAgentsPaginateTypeDef definition

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

ListDataSourcesRequestListDataSourcesPaginateTypeDef#

# ListDataSourcesRequestListDataSourcesPaginateTypeDef definition

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

ListIngestionJobsRequestListIngestionJobsPaginateTypeDef#

# ListIngestionJobsRequestListIngestionJobsPaginateTypeDef definition

class ListIngestionJobsRequestListIngestionJobsPaginateTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,
    filters: NotRequired[Sequence[IngestionJobFilterTypeDef]],  # (1)
    sortBy: NotRequired[IngestionJobSortByTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See IngestionJobFilterTypeDef
  2. See IngestionJobSortByTypeDef
  3. See PaginatorConfigTypeDef

ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef#

# ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef definition

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

OpenSearchServerlessConfigurationTypeDef#

# OpenSearchServerlessConfigurationTypeDef definition

class OpenSearchServerlessConfigurationTypeDef(TypedDict):
    collectionArn: str,
    fieldMapping: OpenSearchServerlessFieldMappingTypeDef,  # (1)
    vectorIndexName: str,
  1. See OpenSearchServerlessFieldMappingTypeDef

PineconeConfigurationTypeDef#

# PineconeConfigurationTypeDef definition

class PineconeConfigurationTypeDef(TypedDict):
    connectionString: str,
    credentialsSecretArn: str,
    fieldMapping: PineconeFieldMappingTypeDef,  # (1)
    namespace: NotRequired[str],
  1. See PineconeFieldMappingTypeDef

RdsConfigurationTypeDef#

# RdsConfigurationTypeDef definition

class RdsConfigurationTypeDef(TypedDict):
    credentialsSecretArn: str,
    databaseName: str,
    fieldMapping: RdsFieldMappingTypeDef,  # (1)
    resourceArn: str,
    tableName: str,
  1. See RdsFieldMappingTypeDef

RedisEnterpriseCloudConfigurationTypeDef#

# RedisEnterpriseCloudConfigurationTypeDef definition

class RedisEnterpriseCloudConfigurationTypeDef(TypedDict):
    credentialsSecretArn: str,
    endpoint: str,
    fieldMapping: RedisEnterpriseCloudFieldMappingTypeDef,  # (1)
    vectorIndexName: str,
  1. See RedisEnterpriseCloudFieldMappingTypeDef

AgentAliasTypeDef#

# AgentAliasTypeDef definition

class AgentAliasTypeDef(TypedDict):
    agentAliasArn: str,
    agentAliasId: str,
    agentAliasName: str,
    agentAliasStatus: AgentAliasStatusType,  # (2)
    agentId: str,
    createdAt: datetime,
    routingConfiguration: List[AgentAliasRoutingConfigurationListItemTypeDef],  # (3)
    updatedAt: datetime,
    agentAliasHistoryEvents: NotRequired[List[AgentAliasHistoryEventTypeDef]],  # (1)
    clientToken: NotRequired[str],
    description: NotRequired[str],
  1. See AgentAliasHistoryEventTypeDef
  2. See AgentAliasStatusType
  3. See AgentAliasRoutingConfigurationListItemTypeDef

ListAgentAliasesResponseTypeDef#

# ListAgentAliasesResponseTypeDef definition

class ListAgentAliasesResponseTypeDef(TypedDict):
    agentAliasSummaries: List[AgentAliasSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentAliasSummaryTypeDef
  2. See ResponseMetadataTypeDef

VectorIngestionConfigurationTypeDef#

# VectorIngestionConfigurationTypeDef definition

class VectorIngestionConfigurationTypeDef(TypedDict):
    chunkingConfiguration: NotRequired[ChunkingConfigurationTypeDef],  # (1)
  1. See ChunkingConfigurationTypeDef

FunctionSchemaOutputTypeDef#

# FunctionSchemaOutputTypeDef definition

class FunctionSchemaOutputTypeDef(TypedDict):
    functions: NotRequired[List[FunctionOutputTypeDef]],  # (1)
  1. See FunctionOutputTypeDef

FunctionSchemaTypeDef#

# FunctionSchemaTypeDef definition

class FunctionSchemaTypeDef(TypedDict):
    functions: NotRequired[Sequence[FunctionTypeDef]],  # (1)
  1. See FunctionTypeDef

PromptOverrideConfigurationOutputTypeDef#

# PromptOverrideConfigurationOutputTypeDef definition

class PromptOverrideConfigurationOutputTypeDef(TypedDict):
    promptConfigurations: List[PromptConfigurationOutputTypeDef],  # (1)
    overrideLambda: NotRequired[str],
  1. See PromptConfigurationOutputTypeDef

PromptOverrideConfigurationTypeDef#

# PromptOverrideConfigurationTypeDef definition

class PromptOverrideConfigurationTypeDef(TypedDict):
    promptConfigurations: Sequence[PromptConfigurationTypeDef],  # (1)
    overrideLambda: NotRequired[str],
  1. See PromptConfigurationTypeDef

ListIngestionJobsResponseTypeDef#

# ListIngestionJobsResponseTypeDef definition

class ListIngestionJobsResponseTypeDef(TypedDict):
    ingestionJobSummaries: List[IngestionJobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IngestionJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetIngestionJobResponseTypeDef#

# GetIngestionJobResponseTypeDef definition

class GetIngestionJobResponseTypeDef(TypedDict):
    ingestionJob: IngestionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IngestionJobTypeDef
  2. See ResponseMetadataTypeDef

StartIngestionJobResponseTypeDef#

# StartIngestionJobResponseTypeDef definition

class StartIngestionJobResponseTypeDef(TypedDict):
    ingestionJob: IngestionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IngestionJobTypeDef
  2. See ResponseMetadataTypeDef

StorageConfigurationTypeDef#

# StorageConfigurationTypeDef definition

class StorageConfigurationTypeDef(TypedDict):
    type: KnowledgeBaseStorageTypeType,  # (5)
    opensearchServerlessConfiguration: NotRequired[OpenSearchServerlessConfigurationTypeDef],  # (1)
    pineconeConfiguration: NotRequired[PineconeConfigurationTypeDef],  # (2)
    rdsConfiguration: NotRequired[RdsConfigurationTypeDef],  # (3)
    redisEnterpriseCloudConfiguration: NotRequired[RedisEnterpriseCloudConfigurationTypeDef],  # (4)
  1. See OpenSearchServerlessConfigurationTypeDef
  2. See PineconeConfigurationTypeDef
  3. See RdsConfigurationTypeDef
  4. See RedisEnterpriseCloudConfigurationTypeDef
  5. See KnowledgeBaseStorageTypeType

CreateAgentAliasResponseTypeDef#

# CreateAgentAliasResponseTypeDef definition

class CreateAgentAliasResponseTypeDef(TypedDict):
    agentAlias: AgentAliasTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentAliasTypeDef
  2. See ResponseMetadataTypeDef

GetAgentAliasResponseTypeDef#

# GetAgentAliasResponseTypeDef definition

class GetAgentAliasResponseTypeDef(TypedDict):
    agentAlias: AgentAliasTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentAliasTypeDef
  2. See ResponseMetadataTypeDef

UpdateAgentAliasResponseTypeDef#

# UpdateAgentAliasResponseTypeDef definition

class UpdateAgentAliasResponseTypeDef(TypedDict):
    agentAlias: AgentAliasTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentAliasTypeDef
  2. See ResponseMetadataTypeDef

CreateDataSourceRequestRequestTypeDef#

# CreateDataSourceRequestRequestTypeDef definition

class CreateDataSourceRequestRequestTypeDef(TypedDict):
    dataSourceConfiguration: DataSourceConfigurationTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    clientToken: NotRequired[str],
    dataDeletionPolicy: NotRequired[DataDeletionPolicyType],  # (2)
    description: NotRequired[str],
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef],  # (4)
  1. See DataSourceConfigurationTypeDef
  2. See DataDeletionPolicyType
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See VectorIngestionConfigurationTypeDef

DataSourceTypeDef#

# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    createdAt: datetime,
    dataSourceConfiguration: DataSourceConfigurationOutputTypeDef,  # (2)
    dataSourceId: str,
    knowledgeBaseId: str,
    name: str,
    status: DataSourceStatusType,  # (4)
    updatedAt: datetime,
    dataDeletionPolicy: NotRequired[DataDeletionPolicyType],  # (1)
    description: NotRequired[str],
    failureReasons: NotRequired[List[str]],
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef],  # (5)
  1. See DataDeletionPolicyType
  2. See DataSourceConfigurationOutputTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See DataSourceStatusType
  5. See VectorIngestionConfigurationTypeDef

UpdateDataSourceRequestRequestTypeDef#

# UpdateDataSourceRequestRequestTypeDef definition

class UpdateDataSourceRequestRequestTypeDef(TypedDict):
    dataSourceConfiguration: DataSourceConfigurationTypeDef,  # (1)
    dataSourceId: str,
    knowledgeBaseId: str,
    name: str,
    dataDeletionPolicy: NotRequired[DataDeletionPolicyType],  # (2)
    description: NotRequired[str],
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef],  # (4)
  1. See DataSourceConfigurationTypeDef
  2. See DataDeletionPolicyType
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See VectorIngestionConfigurationTypeDef

AgentActionGroupTypeDef#

# AgentActionGroupTypeDef definition

class AgentActionGroupTypeDef(TypedDict):
    actionGroupId: str,
    actionGroupName: str,
    actionGroupState: ActionGroupStateType,  # (2)
    agentId: str,
    agentVersion: str,
    createdAt: datetime,
    updatedAt: datetime,
    actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef],  # (1)
    apiSchema: NotRequired[APISchemaTypeDef],  # (3)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    functionSchema: NotRequired[FunctionSchemaOutputTypeDef],  # (4)
    parentActionSignature: NotRequired[ActionGroupSignatureType],  # (5)
  1. See ActionGroupExecutorTypeDef
  2. See ActionGroupStateType
  3. See APISchemaTypeDef
  4. See FunctionSchemaOutputTypeDef
  5. See ActionGroupSignatureType

CreateAgentActionGroupRequestRequestTypeDef#

# CreateAgentActionGroupRequestRequestTypeDef definition

class CreateAgentActionGroupRequestRequestTypeDef(TypedDict):
    actionGroupName: str,
    agentId: str,
    agentVersion: str,
    actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef],  # (1)
    actionGroupState: NotRequired[ActionGroupStateType],  # (2)
    apiSchema: NotRequired[APISchemaTypeDef],  # (3)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    functionSchema: NotRequired[FunctionSchemaTypeDef],  # (4)
    parentActionGroupSignature: NotRequired[ActionGroupSignatureType],  # (5)
  1. See ActionGroupExecutorTypeDef
  2. See ActionGroupStateType
  3. See APISchemaTypeDef
  4. See FunctionSchemaTypeDef
  5. See ActionGroupSignatureType

UpdateAgentActionGroupRequestRequestTypeDef#

# UpdateAgentActionGroupRequestRequestTypeDef definition

class UpdateAgentActionGroupRequestRequestTypeDef(TypedDict):
    actionGroupId: str,
    actionGroupName: str,
    agentId: str,
    agentVersion: str,
    actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef],  # (1)
    actionGroupState: NotRequired[ActionGroupStateType],  # (2)
    apiSchema: NotRequired[APISchemaTypeDef],  # (3)
    description: NotRequired[str],
    functionSchema: NotRequired[FunctionSchemaTypeDef],  # (4)
    parentActionGroupSignature: NotRequired[ActionGroupSignatureType],  # (5)
  1. See ActionGroupExecutorTypeDef
  2. See ActionGroupStateType
  3. See APISchemaTypeDef
  4. See FunctionSchemaTypeDef
  5. See ActionGroupSignatureType

AgentTypeDef#

# AgentTypeDef definition

class AgentTypeDef(TypedDict):
    agentArn: str,
    agentId: str,
    agentName: str,
    agentResourceRoleArn: str,
    agentStatus: AgentStatusType,  # (1)
    agentVersion: str,
    createdAt: datetime,
    idleSessionTTLInSeconds: int,
    updatedAt: datetime,
    clientToken: NotRequired[str],
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    failureReasons: NotRequired[List[str]],
    foundationModel: NotRequired[str],
    instruction: NotRequired[str],
    preparedAt: NotRequired[datetime],
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationOutputTypeDef],  # (2)
    recommendedActions: NotRequired[List[str]],
  1. See AgentStatusType
  2. See PromptOverrideConfigurationOutputTypeDef

AgentVersionTypeDef#

# AgentVersionTypeDef definition

class AgentVersionTypeDef(TypedDict):
    agentArn: str,
    agentId: str,
    agentName: str,
    agentResourceRoleArn: str,
    agentStatus: AgentStatusType,  # (1)
    createdAt: datetime,
    idleSessionTTLInSeconds: int,
    updatedAt: datetime,
    version: str,
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    failureReasons: NotRequired[List[str]],
    foundationModel: NotRequired[str],
    instruction: NotRequired[str],
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationOutputTypeDef],  # (2)
    recommendedActions: NotRequired[List[str]],
  1. See AgentStatusType
  2. See PromptOverrideConfigurationOutputTypeDef

CreateAgentRequestRequestTypeDef#

# CreateAgentRequestRequestTypeDef definition

class CreateAgentRequestRequestTypeDef(TypedDict):
    agentName: str,
    agentResourceRoleArn: NotRequired[str],
    clientToken: NotRequired[str],
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    foundationModel: NotRequired[str],
    idleSessionTTLInSeconds: NotRequired[int],
    instruction: NotRequired[str],
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See PromptOverrideConfigurationTypeDef

UpdateAgentRequestRequestTypeDef#

# UpdateAgentRequestRequestTypeDef definition

class UpdateAgentRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentName: str,
    agentResourceRoleArn: str,
    foundationModel: str,
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    idleSessionTTLInSeconds: NotRequired[int],
    instruction: NotRequired[str],
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef],  # (1)
  1. See PromptOverrideConfigurationTypeDef

CreateKnowledgeBaseRequestRequestTypeDef#

# CreateKnowledgeBaseRequestRequestTypeDef definition

class CreateKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    name: str,
    roleArn: str,
    storageConfiguration: StorageConfigurationTypeDef,  # (2)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See KnowledgeBaseConfigurationTypeDef
  2. See StorageConfigurationTypeDef

KnowledgeBaseTypeDef#

# KnowledgeBaseTypeDef definition

class KnowledgeBaseTypeDef(TypedDict):
    createdAt: datetime,
    knowledgeBaseArn: str,
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    roleArn: str,
    status: KnowledgeBaseStatusType,  # (2)
    storageConfiguration: StorageConfigurationTypeDef,  # (3)
    updatedAt: datetime,
    description: NotRequired[str],
    failureReasons: NotRequired[List[str]],
  1. See KnowledgeBaseConfigurationTypeDef
  2. See KnowledgeBaseStatusType
  3. See StorageConfigurationTypeDef

UpdateKnowledgeBaseRequestRequestTypeDef#

# UpdateKnowledgeBaseRequestRequestTypeDef definition

class UpdateKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    roleArn: str,
    storageConfiguration: StorageConfigurationTypeDef,  # (2)
    description: NotRequired[str],
  1. See KnowledgeBaseConfigurationTypeDef
  2. See StorageConfigurationTypeDef

CreateDataSourceResponseTypeDef#

# CreateDataSourceResponseTypeDef definition

class CreateDataSourceResponseTypeDef(TypedDict):
    dataSource: DataSourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceTypeDef
  2. See ResponseMetadataTypeDef

GetDataSourceResponseTypeDef#

# GetDataSourceResponseTypeDef definition

class GetDataSourceResponseTypeDef(TypedDict):
    dataSource: DataSourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceTypeDef
  2. See ResponseMetadataTypeDef

UpdateDataSourceResponseTypeDef#

# UpdateDataSourceResponseTypeDef definition

class UpdateDataSourceResponseTypeDef(TypedDict):
    dataSource: DataSourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceTypeDef
  2. See ResponseMetadataTypeDef

CreateAgentActionGroupResponseTypeDef#

# CreateAgentActionGroupResponseTypeDef definition

class CreateAgentActionGroupResponseTypeDef(TypedDict):
    agentActionGroup: AgentActionGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentActionGroupTypeDef
  2. See ResponseMetadataTypeDef

GetAgentActionGroupResponseTypeDef#

# GetAgentActionGroupResponseTypeDef definition

class GetAgentActionGroupResponseTypeDef(TypedDict):
    agentActionGroup: AgentActionGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentActionGroupTypeDef
  2. See ResponseMetadataTypeDef

UpdateAgentActionGroupResponseTypeDef#

# UpdateAgentActionGroupResponseTypeDef definition

class UpdateAgentActionGroupResponseTypeDef(TypedDict):
    agentActionGroup: AgentActionGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentActionGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateAgentResponseTypeDef#

# CreateAgentResponseTypeDef definition

class CreateAgentResponseTypeDef(TypedDict):
    agent: AgentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentTypeDef
  2. See ResponseMetadataTypeDef

GetAgentResponseTypeDef#

# GetAgentResponseTypeDef definition

class GetAgentResponseTypeDef(TypedDict):
    agent: AgentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentTypeDef
  2. See ResponseMetadataTypeDef

UpdateAgentResponseTypeDef#

# UpdateAgentResponseTypeDef definition

class UpdateAgentResponseTypeDef(TypedDict):
    agent: AgentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentTypeDef
  2. See ResponseMetadataTypeDef

GetAgentVersionResponseTypeDef#

# GetAgentVersionResponseTypeDef definition

class GetAgentVersionResponseTypeDef(TypedDict):
    agentVersion: AgentVersionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentVersionTypeDef
  2. See ResponseMetadataTypeDef

CreateKnowledgeBaseResponseTypeDef#

# CreateKnowledgeBaseResponseTypeDef definition

class CreateKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseTypeDef
  2. See ResponseMetadataTypeDef

GetKnowledgeBaseResponseTypeDef#

# GetKnowledgeBaseResponseTypeDef definition

class GetKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseTypeDef
  2. See ResponseMetadataTypeDef

UpdateKnowledgeBaseResponseTypeDef#

# UpdateKnowledgeBaseResponseTypeDef definition

class UpdateKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseTypeDef
  2. See ResponseMetadataTypeDef