Type definitions#
Index > AgentsforBedrock > Type definitions
Auto-generated documentation for AgentsforBedrock type annotations stubs module mypy-boto3-bedrock-agent.
MemoryConfigurationUnionTypeDef#
# MemoryConfigurationUnionTypeDef definition
MemoryConfigurationUnionTypeDef = Union[
MemoryConfigurationTypeDef, # (1)
MemoryConfigurationOutputTypeDef, # (2)
]FunctionSchemaUnionTypeDef#
# FunctionSchemaUnionTypeDef definition
FunctionSchemaUnionTypeDef = Union[
FunctionSchemaTypeDef, # (1)
FunctionSchemaOutputTypeDef, # (2)
]PromptOverrideConfigurationUnionTypeDef#
# PromptOverrideConfigurationUnionTypeDef definition
PromptOverrideConfigurationUnionTypeDef = Union[
PromptOverrideConfigurationTypeDef, # (1)
PromptOverrideConfigurationOutputTypeDef, # (2)
]PromptVariantUnionTypeDef#
# PromptVariantUnionTypeDef definition
PromptVariantUnionTypeDef = Union[
PromptVariantTypeDef, # (1)
PromptVariantOutputTypeDef, # (2)
]VectorIngestionConfigurationUnionTypeDef#
# VectorIngestionConfigurationUnionTypeDef definition
VectorIngestionConfigurationUnionTypeDef = Union[
VectorIngestionConfigurationTypeDef, # (1)
VectorIngestionConfigurationOutputTypeDef, # (2)
]DataSourceConfigurationUnionTypeDef#
# DataSourceConfigurationUnionTypeDef definition
DataSourceConfigurationUnionTypeDef = Union[
DataSourceConfigurationTypeDef, # (1)
DataSourceConfigurationOutputTypeDef, # (2)
]FlowDefinitionUnionTypeDef#
# FlowDefinitionUnionTypeDef definition
FlowDefinitionUnionTypeDef = Union[
FlowDefinitionTypeDef, # (1)
FlowDefinitionOutputTypeDef, # (2)
]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],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: NotRequired[str],
provisionedThroughput: NotRequired[str],AgentFlowNodeConfigurationTypeDef#
# AgentFlowNodeConfigurationTypeDef definition
class AgentFlowNodeConfigurationTypeDef(TypedDict):
agentAliasArn: 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,
createdAt: datetime,
description: str,
knowledgeBaseId: str,
knowledgeBaseState: KnowledgeBaseStateType, # (1)
updatedAt: datetime,GuardrailConfigurationTypeDef#
# GuardrailConfigurationTypeDef definition
class GuardrailConfigurationTypeDef(TypedDict):
guardrailIdentifier: NotRequired[str],
guardrailVersion: NotRequired[str],MemoryConfigurationOutputTypeDef#
# MemoryConfigurationOutputTypeDef definition
class MemoryConfigurationOutputTypeDef(TypedDict):
enabledMemoryTypes: List[MemoryTypeType], # (1)
storageDays: NotRequired[int],- See MemoryTypeType
AssociateAgentKnowledgeBaseRequestRequestTypeDef#
# AssociateAgentKnowledgeBaseRequestRequestTypeDef definition
class AssociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
description: str,
knowledgeBaseId: str,
knowledgeBaseState: NotRequired[KnowledgeBaseStateType], # (1)ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],BedrockEmbeddingModelConfigurationTypeDef#
# BedrockEmbeddingModelConfigurationTypeDef definition
class BedrockEmbeddingModelConfigurationTypeDef(TypedDict):
dimensions: NotRequired[int],ParsingPromptTypeDef#
# ParsingPromptTypeDef definition
class ParsingPromptTypeDef(TypedDict):
parsingPromptText: str,FixedSizeChunkingConfigurationTypeDef#
# FixedSizeChunkingConfigurationTypeDef definition
class FixedSizeChunkingConfigurationTypeDef(TypedDict):
maxTokens: int,
overlapPercentage: int,SemanticChunkingConfigurationTypeDef#
# SemanticChunkingConfigurationTypeDef definition
class SemanticChunkingConfigurationTypeDef(TypedDict):
breakpointPercentileThreshold: int,
bufferSize: int,
maxTokens: int,FlowConditionTypeDef#
# FlowConditionTypeDef definition
class FlowConditionTypeDef(TypedDict):
name: str,
expression: NotRequired[str],ConfluenceSourceConfigurationTypeDef#
# ConfluenceSourceConfigurationTypeDef definition
class ConfluenceSourceConfigurationTypeDef(TypedDict):
authType: ConfluenceAuthTypeType, # (1)
credentialsSecretArn: str,
hostType: ConfluenceHostTypeType, # (2)
hostUrl: str,MemoryConfigurationTypeDef#
# MemoryConfigurationTypeDef definition
class MemoryConfigurationTypeDef(TypedDict):
enabledMemoryTypes: Sequence[MemoryTypeType], # (1)
storageDays: NotRequired[int],- See MemoryTypeType
ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
kmsKeyArn: NotRequired[str],FlowAliasRoutingConfigurationListItemTypeDef#
# FlowAliasRoutingConfigurationListItemTypeDef definition
class FlowAliasRoutingConfigurationListItemTypeDef(TypedDict):
flowVersion: NotRequired[str],CreateFlowVersionRequestRequestTypeDef#
# CreateFlowVersionRequestRequestTypeDef definition
class CreateFlowVersionRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
clientToken: NotRequired[str],
description: NotRequired[str],CreatePromptVersionRequestRequestTypeDef#
# CreatePromptVersionRequestRequestTypeDef definition
class CreatePromptVersionRequestRequestTypeDef(TypedDict):
promptIdentifier: str,
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, 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],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,DeleteFlowAliasRequestRequestTypeDef#
# DeleteFlowAliasRequestRequestTypeDef definition
class DeleteFlowAliasRequestRequestTypeDef(TypedDict):
aliasIdentifier: str,
flowIdentifier: str,DeleteFlowRequestRequestTypeDef#
# DeleteFlowRequestRequestTypeDef definition
class DeleteFlowRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
skipResourceInUseCheck: NotRequired[bool],DeleteFlowVersionRequestRequestTypeDef#
# DeleteFlowVersionRequestRequestTypeDef definition
class DeleteFlowVersionRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
flowVersion: str,
skipResourceInUseCheck: NotRequired[bool],DeleteKnowledgeBaseRequestRequestTypeDef#
# DeleteKnowledgeBaseRequestRequestTypeDef definition
class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,DeletePromptRequestRequestTypeDef#
# DeletePromptRequestRequestTypeDef definition
class DeletePromptRequestRequestTypeDef(TypedDict):
promptIdentifier: str,
promptVersion: NotRequired[str],DisassociateAgentKnowledgeBaseRequestRequestTypeDef#
# DisassociateAgentKnowledgeBaseRequestRequestTypeDef definition
class DisassociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
agentId: str,
agentVersion: str,
knowledgeBaseId: str,FlowConditionalConnectionConfigurationTypeDef#
# FlowConditionalConnectionConfigurationTypeDef definition
class FlowConditionalConnectionConfigurationTypeDef(TypedDict):
condition: str,FlowDataConnectionConfigurationTypeDef#
# FlowDataConnectionConfigurationTypeDef definition
class FlowDataConnectionConfigurationTypeDef(TypedDict):
sourceOutput: str,
targetInput: str,KnowledgeBaseFlowNodeConfigurationTypeDef#
# KnowledgeBaseFlowNodeConfigurationTypeDef definition
class KnowledgeBaseFlowNodeConfigurationTypeDef(TypedDict):
knowledgeBaseId: str,
modelId: NotRequired[str],LambdaFunctionFlowNodeConfigurationTypeDef#
# LambdaFunctionFlowNodeConfigurationTypeDef definition
class LambdaFunctionFlowNodeConfigurationTypeDef(TypedDict):
lambdaArn: str,LexFlowNodeConfigurationTypeDef#
# LexFlowNodeConfigurationTypeDef definition
class LexFlowNodeConfigurationTypeDef(TypedDict):
botAliasArn: str,
localeId: str,FlowNodeInputTypeDef#
# FlowNodeInputTypeDef definition
class FlowNodeInputTypeDef(TypedDict):
expression: str,
name: str,
type: FlowNodeIODataTypeType, # (1)FlowNodeOutputTypeDef#
# FlowNodeOutputTypeDef definition
class FlowNodeOutputTypeDef(TypedDict):
name: str,
type: FlowNodeIODataTypeType, # (1)FlowSummaryTypeDef#
# FlowSummaryTypeDef definition
class FlowSummaryTypeDef(TypedDict):
arn: str,
createdAt: datetime,
id: str,
name: str,
status: FlowStatusType, # (1)
updatedAt: datetime,
version: str,
description: NotRequired[str],- See FlowStatusType
FlowValidationTypeDef#
# FlowValidationTypeDef definition
class FlowValidationTypeDef(TypedDict):
message: str,
severity: FlowValidationSeverityType, # (1)FlowVersionSummaryTypeDef#
# FlowVersionSummaryTypeDef definition
class FlowVersionSummaryTypeDef(TypedDict):
arn: str,
createdAt: datetime,
id: str,
status: FlowStatusType, # (1)
version: str,- See FlowStatusType
ParameterDetailTypeDef#
# ParameterDetailTypeDef definition
class ParameterDetailTypeDef(TypedDict):
type: TypeType, # (1)
description: NotRequired[str],
required: NotRequired[bool],- 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,GetFlowAliasRequestRequestTypeDef#
# GetFlowAliasRequestRequestTypeDef definition
class GetFlowAliasRequestRequestTypeDef(TypedDict):
aliasIdentifier: str,
flowIdentifier: str,GetFlowRequestRequestTypeDef#
# GetFlowRequestRequestTypeDef definition
class GetFlowRequestRequestTypeDef(TypedDict):
flowIdentifier: str,GetFlowVersionRequestRequestTypeDef#
# GetFlowVersionRequestRequestTypeDef definition
class GetFlowVersionRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
flowVersion: str,GetIngestionJobRequestRequestTypeDef#
# GetIngestionJobRequestRequestTypeDef definition
class GetIngestionJobRequestRequestTypeDef(TypedDict):
dataSourceId: str,
ingestionJobId: str,
knowledgeBaseId: str,GetKnowledgeBaseRequestRequestTypeDef#
# GetKnowledgeBaseRequestRequestTypeDef definition
class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,GetPromptRequestRequestTypeDef#
# GetPromptRequestRequestTypeDef definition
class GetPromptRequestRequestTypeDef(TypedDict):
promptIdentifier: str,
promptVersion: NotRequired[str],HierarchicalChunkingLevelConfigurationTypeDef#
# HierarchicalChunkingLevelConfigurationTypeDef definition
class HierarchicalChunkingLevelConfigurationTypeDef(TypedDict):
maxTokens: int,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],IngestionJobSortByTypeDef#
# IngestionJobSortByTypeDef definition
class IngestionJobSortByTypeDef(TypedDict):
attribute: IngestionJobSortByAttributeType, # (1)
order: SortOrderType, # (2)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],S3LocationTypeDef#
# S3LocationTypeDef definition
class S3LocationTypeDef(TypedDict):
uri: 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],ListFlowAliasesRequestRequestTypeDef#
# ListFlowAliasesRequestRequestTypeDef definition
class ListFlowAliasesRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListFlowVersionsRequestRequestTypeDef#
# ListFlowVersionsRequestRequestTypeDef definition
class ListFlowVersionsRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListFlowsRequestRequestTypeDef#
# ListFlowsRequestRequestTypeDef definition
class ListFlowsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListKnowledgeBasesRequestRequestTypeDef#
# ListKnowledgeBasesRequestRequestTypeDef definition
class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListPromptsRequestRequestTypeDef#
# ListPromptsRequestRequestTypeDef definition
class ListPromptsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
promptIdentifier: NotRequired[str],PromptSummaryTypeDef#
# PromptSummaryTypeDef definition
class PromptSummaryTypeDef(TypedDict):
arn: str,
createdAt: datetime,
id: str,
name: str,
updatedAt: datetime,
version: str,
description: NotRequired[str],ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,MongoDbAtlasFieldMappingTypeDef#
# MongoDbAtlasFieldMappingTypeDef definition
class MongoDbAtlasFieldMappingTypeDef(TypedDict):
metadataField: str,
textField: str,
vectorField: str,OpenSearchServerlessFieldMappingTypeDef#
# OpenSearchServerlessFieldMappingTypeDef definition
class OpenSearchServerlessFieldMappingTypeDef(TypedDict):
metadataField: str,
textField: str,
vectorField: str,PatternObjectFilterOutputTypeDef#
# PatternObjectFilterOutputTypeDef definition
class PatternObjectFilterOutputTypeDef(TypedDict):
objectType: str,
exclusionFilters: NotRequired[List[str]],
inclusionFilters: NotRequired[List[str]],PatternObjectFilterTypeDef#
# PatternObjectFilterTypeDef definition
class PatternObjectFilterTypeDef(TypedDict):
objectType: str,
exclusionFilters: NotRequired[Sequence[str]],
inclusionFilters: NotRequired[Sequence[str]],PineconeFieldMappingTypeDef#
# PineconeFieldMappingTypeDef definition
class PineconeFieldMappingTypeDef(TypedDict):
metadataField: str,
textField: str,PrepareAgentRequestRequestTypeDef#
# PrepareAgentRequestRequestTypeDef definition
class PrepareAgentRequestRequestTypeDef(TypedDict):
agentId: str,PrepareFlowRequestRequestTypeDef#
# PrepareFlowRequestRequestTypeDef definition
class PrepareFlowRequestRequestTypeDef(TypedDict):
flowIdentifier: str,PromptFlowNodeResourceConfigurationTypeDef#
# PromptFlowNodeResourceConfigurationTypeDef definition
class PromptFlowNodeResourceConfigurationTypeDef(TypedDict):
promptArn: str,PromptModelInferenceConfigurationOutputTypeDef#
# PromptModelInferenceConfigurationOutputTypeDef definition
class PromptModelInferenceConfigurationOutputTypeDef(TypedDict):
maxTokens: NotRequired[int],
stopSequences: NotRequired[List[str]],
temperature: NotRequired[float],
topK: NotRequired[int],
topP: NotRequired[float],PromptModelInferenceConfigurationTypeDef#
# PromptModelInferenceConfigurationTypeDef definition
class PromptModelInferenceConfigurationTypeDef(TypedDict):
maxTokens: NotRequired[int],
stopSequences: NotRequired[Sequence[str]],
temperature: NotRequired[float],
topK: NotRequired[int],
topP: NotRequired[float],PromptInputVariableTypeDef#
# PromptInputVariableTypeDef definition
class PromptInputVariableTypeDef(TypedDict):
name: NotRequired[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,RetrievalFlowNodeS3ConfigurationTypeDef#
# RetrievalFlowNodeS3ConfigurationTypeDef definition
class RetrievalFlowNodeS3ConfigurationTypeDef(TypedDict):
bucketName: str,SalesforceSourceConfigurationTypeDef#
# SalesforceSourceConfigurationTypeDef definition
class SalesforceSourceConfigurationTypeDef(TypedDict):
authType: SalesforceAuthTypeType, # (1)
credentialsSecretArn: str,
hostUrl: str,SeedUrlTypeDef#
# SeedUrlTypeDef definition
class SeedUrlTypeDef(TypedDict):
url: NotRequired[str],SharePointSourceConfigurationOutputTypeDef#
# SharePointSourceConfigurationOutputTypeDef definition
class SharePointSourceConfigurationOutputTypeDef(TypedDict):
authType: SharePointAuthTypeType, # (1)
credentialsSecretArn: str,
domain: str,
hostType: SharePointHostTypeType, # (2)
siteUrls: List[str],
tenantId: NotRequired[str],SharePointSourceConfigurationTypeDef#
# SharePointSourceConfigurationTypeDef definition
class SharePointSourceConfigurationTypeDef(TypedDict):
authType: SharePointAuthTypeType, # (1)
credentialsSecretArn: str,
domain: str,
hostType: SharePointHostTypeType, # (2)
siteUrls: Sequence[str],
tenantId: NotRequired[str],StartIngestionJobRequestRequestTypeDef#
# StartIngestionJobRequestRequestTypeDef definition
class StartIngestionJobRequestRequestTypeDef(TypedDict):
dataSourceId: str,
knowledgeBaseId: str,
clientToken: NotRequired[str],
description: NotRequired[str],StorageFlowNodeS3ConfigurationTypeDef#
# StorageFlowNodeS3ConfigurationTypeDef definition
class StorageFlowNodeS3ConfigurationTypeDef(TypedDict):
bucketName: str,TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],TransformationLambdaConfigurationTypeDef#
# TransformationLambdaConfigurationTypeDef definition
class TransformationLambdaConfigurationTypeDef(TypedDict):
lambdaArn: 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)WebCrawlerLimitsTypeDef#
# WebCrawlerLimitsTypeDef definition
class WebCrawlerLimitsTypeDef(TypedDict):
rateLimit: NotRequired[int],APISchemaTypeDef#
# APISchemaTypeDef definition
class APISchemaTypeDef(TypedDict):
payload: NotRequired[str],
s3: NotRequired[S3IdentifierTypeDef], # (1)AgentAliasHistoryEventTypeDef#
# AgentAliasHistoryEventTypeDef definition
class AgentAliasHistoryEventTypeDef(TypedDict):
endDate: NotRequired[datetime],
routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]], # (1)
startDate: NotRequired[datetime],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)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]],UpdateAgentAliasRequestRequestTypeDef#
# UpdateAgentAliasRequestRequestTypeDef definition
class UpdateAgentAliasRequestRequestTypeDef(TypedDict):
agentAliasId: str,
agentAliasName: str,
agentId: str,
description: NotRequired[str],
routingConfiguration: NotRequired[Sequence[AgentAliasRoutingConfigurationListItemTypeDef]], # (1)AgentSummaryTypeDef#
# AgentSummaryTypeDef definition
class AgentSummaryTypeDef(TypedDict):
agentId: str,
agentName: str,
agentStatus: AgentStatusType, # (1)
updatedAt: datetime,
description: NotRequired[str],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
latestAgentVersion: NotRequired[str],AgentVersionSummaryTypeDef#
# AgentVersionSummaryTypeDef definition
class AgentVersionSummaryTypeDef(TypedDict):
agentName: str,
agentStatus: AgentStatusType, # (1)
agentVersion: str,
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)AssociateAgentKnowledgeBaseResponseTypeDef#
# AssociateAgentKnowledgeBaseResponseTypeDef definition
class AssociateAgentKnowledgeBaseResponseTypeDef(TypedDict):
agentKnowledgeBase: AgentKnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteAgentAliasResponseTypeDef#
# DeleteAgentAliasResponseTypeDef definition
class DeleteAgentAliasResponseTypeDef(TypedDict):
agentAliasId: str,
agentAliasStatus: AgentAliasStatusType, # (1)
agentId: str,
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,
agentStatus: AgentStatusType, # (1)
agentVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteDataSourceResponseTypeDef#
# DeleteDataSourceResponseTypeDef definition
class DeleteDataSourceResponseTypeDef(TypedDict):
dataSourceId: str,
knowledgeBaseId: str,
status: DataSourceStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteFlowAliasResponseTypeDef#
# DeleteFlowAliasResponseTypeDef definition
class DeleteFlowAliasResponseTypeDef(TypedDict):
flowId: str,
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteFlowResponseTypeDef#
# DeleteFlowResponseTypeDef definition
class DeleteFlowResponseTypeDef(TypedDict):
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteFlowVersionResponseTypeDef#
# DeleteFlowVersionResponseTypeDef definition
class DeleteFlowVersionResponseTypeDef(TypedDict):
id: str,
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteKnowledgeBaseResponseTypeDef#
# DeleteKnowledgeBaseResponseTypeDef definition
class DeleteKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBaseId: str,
status: KnowledgeBaseStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeletePromptResponseTypeDef#
# DeletePromptResponseTypeDef definition
class DeletePromptResponseTypeDef(TypedDict):
id: str,
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)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)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)PrepareFlowResponseTypeDef#
# PrepareFlowResponseTypeDef definition
class PrepareFlowResponseTypeDef(TypedDict):
id: str,
status: FlowStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateAgentKnowledgeBaseResponseTypeDef#
# UpdateAgentKnowledgeBaseResponseTypeDef definition
class UpdateAgentKnowledgeBaseResponseTypeDef(TypedDict):
agentKnowledgeBase: AgentKnowledgeBaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)EmbeddingModelConfigurationTypeDef#
# EmbeddingModelConfigurationTypeDef definition
class EmbeddingModelConfigurationTypeDef(TypedDict):
bedrockEmbeddingModelConfiguration: NotRequired[BedrockEmbeddingModelConfigurationTypeDef], # (1)BedrockFoundationModelConfigurationTypeDef#
# BedrockFoundationModelConfigurationTypeDef definition
class BedrockFoundationModelConfigurationTypeDef(TypedDict):
modelArn: str,
parsingPrompt: NotRequired[ParsingPromptTypeDef], # (1)ConditionFlowNodeConfigurationOutputTypeDef#
# ConditionFlowNodeConfigurationOutputTypeDef definition
class ConditionFlowNodeConfigurationOutputTypeDef(TypedDict):
conditions: List[FlowConditionTypeDef], # (1)ConditionFlowNodeConfigurationTypeDef#
# ConditionFlowNodeConfigurationTypeDef definition
class ConditionFlowNodeConfigurationTypeDef(TypedDict):
conditions: Sequence[FlowConditionTypeDef], # (1)CreateFlowAliasRequestRequestTypeDef#
# CreateFlowAliasRequestRequestTypeDef definition
class CreateFlowAliasRequestRequestTypeDef(TypedDict):
flowIdentifier: str,
name: str,
routingConfiguration: Sequence[FlowAliasRoutingConfigurationListItemTypeDef], # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],CreateFlowAliasResponseTypeDef#
# CreateFlowAliasResponseTypeDef definition
class CreateFlowAliasResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
description: str,
flowId: str,
id: str,
name: str,
routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef], # (1)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)FlowAliasSummaryTypeDef#
# FlowAliasSummaryTypeDef definition
class FlowAliasSummaryTypeDef(TypedDict):
arn: str,
createdAt: datetime,
flowId: str,
id: str,
name: str,
routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef], # (1)
updatedAt: datetime,
description: NotRequired[str],GetFlowAliasResponseTypeDef#
# GetFlowAliasResponseTypeDef definition
class GetFlowAliasResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
description: str,
flowId: str,
id: str,
name: str,
routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef], # (1)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateFlowAliasRequestRequestTypeDef#
# UpdateFlowAliasRequestRequestTypeDef definition
class UpdateFlowAliasRequestRequestTypeDef(TypedDict):
aliasIdentifier: str,
flowIdentifier: str,
name: str,
routingConfiguration: Sequence[FlowAliasRoutingConfigurationListItemTypeDef], # (1)
description: NotRequired[str],UpdateFlowAliasResponseTypeDef#
# UpdateFlowAliasResponseTypeDef definition
class UpdateFlowAliasResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
description: str,
flowId: str,
id: str,
name: str,
routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef], # (1)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
dataSourceSummaries: List[DataSourceSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)FlowConnectionConfigurationTypeDef#
# FlowConnectionConfigurationTypeDef definition
class FlowConnectionConfigurationTypeDef(TypedDict):
conditional: NotRequired[FlowConditionalConnectionConfigurationTypeDef], # (1)
data: NotRequired[FlowDataConnectionConfigurationTypeDef], # (2)ListFlowsResponseTypeDef#
# ListFlowsResponseTypeDef definition
class ListFlowsResponseTypeDef(TypedDict):
flowSummaries: List[FlowSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListFlowVersionsResponseTypeDef#
# ListFlowVersionsResponseTypeDef definition
class ListFlowVersionsResponseTypeDef(TypedDict):
flowVersionSummaries: List[FlowVersionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)FunctionOutputTypeDef#
# FunctionOutputTypeDef definition
class FunctionOutputTypeDef(TypedDict):
name: str,
description: NotRequired[str],
parameters: NotRequired[Dict[str, ParameterDetailTypeDef]], # (1)FunctionTypeDef#
# FunctionTypeDef definition
class FunctionTypeDef(TypedDict):
name: str,
description: NotRequired[str],
parameters: NotRequired[Mapping[str, ParameterDetailTypeDef]], # (1)HierarchicalChunkingConfigurationOutputTypeDef#
# HierarchicalChunkingConfigurationOutputTypeDef definition
class HierarchicalChunkingConfigurationOutputTypeDef(TypedDict):
levelConfigurations: List[HierarchicalChunkingLevelConfigurationTypeDef], # (1)
overlapTokens: int,HierarchicalChunkingConfigurationTypeDef#
# HierarchicalChunkingConfigurationTypeDef definition
class HierarchicalChunkingConfigurationTypeDef(TypedDict):
levelConfigurations: Sequence[HierarchicalChunkingLevelConfigurationTypeDef], # (1)
overlapTokens: int,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)- See InferenceConfigurationOutputTypeDef
- See CreationModeType
- See CreationModeType
- See PromptStateType
- 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)- See InferenceConfigurationTypeDef
- See CreationModeType
- See CreationModeType
- See PromptStateType
- 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)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)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)IntermediateStorageTypeDef#
# IntermediateStorageTypeDef definition
class IntermediateStorageTypeDef(TypedDict):
s3Location: S3LocationTypeDef, # (1)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)ListFlowAliasesRequestListFlowAliasesPaginateTypeDef#
# ListFlowAliasesRequestListFlowAliasesPaginateTypeDef definition
class ListFlowAliasesRequestListFlowAliasesPaginateTypeDef(TypedDict):
flowIdentifier: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListFlowVersionsRequestListFlowVersionsPaginateTypeDef#
# ListFlowVersionsRequestListFlowVersionsPaginateTypeDef definition
class ListFlowVersionsRequestListFlowVersionsPaginateTypeDef(TypedDict):
flowIdentifier: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListFlowsRequestListFlowsPaginateTypeDef#
# ListFlowsRequestListFlowsPaginateTypeDef definition
class ListFlowsRequestListFlowsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListIngestionJobsRequestListIngestionJobsPaginateTypeDef#
# ListIngestionJobsRequestListIngestionJobsPaginateTypeDef definition
class ListIngestionJobsRequestListIngestionJobsPaginateTypeDef(TypedDict):
dataSourceId: str,
knowledgeBaseId: str,
filters: NotRequired[Sequence[IngestionJobFilterTypeDef]], # (1)
sortBy: NotRequired[IngestionJobSortByTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef#
# ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef definition
class ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPromptsRequestListPromptsPaginateTypeDef#
# ListPromptsRequestListPromptsPaginateTypeDef definition
class ListPromptsRequestListPromptsPaginateTypeDef(TypedDict):
promptIdentifier: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPromptsResponseTypeDef#
# ListPromptsResponseTypeDef definition
class ListPromptsResponseTypeDef(TypedDict):
nextToken: str,
promptSummaries: List[PromptSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)MongoDbAtlasConfigurationTypeDef#
# MongoDbAtlasConfigurationTypeDef definition
class MongoDbAtlasConfigurationTypeDef(TypedDict):
collectionName: str,
credentialsSecretArn: str,
databaseName: str,
endpoint: str,
fieldMapping: MongoDbAtlasFieldMappingTypeDef, # (1)
vectorIndexName: str,
endpointServiceName: NotRequired[str],OpenSearchServerlessConfigurationTypeDef#
# OpenSearchServerlessConfigurationTypeDef definition
class OpenSearchServerlessConfigurationTypeDef(TypedDict):
collectionArn: str,
fieldMapping: OpenSearchServerlessFieldMappingTypeDef, # (1)
vectorIndexName: str,PatternObjectFilterConfigurationOutputTypeDef#
# PatternObjectFilterConfigurationOutputTypeDef definition
class PatternObjectFilterConfigurationOutputTypeDef(TypedDict):
filters: List[PatternObjectFilterOutputTypeDef], # (1)PatternObjectFilterConfigurationTypeDef#
# PatternObjectFilterConfigurationTypeDef definition
class PatternObjectFilterConfigurationTypeDef(TypedDict):
filters: Sequence[PatternObjectFilterTypeDef], # (1)PineconeConfigurationTypeDef#
# PineconeConfigurationTypeDef definition
class PineconeConfigurationTypeDef(TypedDict):
connectionString: str,
credentialsSecretArn: str,
fieldMapping: PineconeFieldMappingTypeDef, # (1)
namespace: NotRequired[str],PromptInferenceConfigurationOutputTypeDef#
# PromptInferenceConfigurationOutputTypeDef definition
class PromptInferenceConfigurationOutputTypeDef(TypedDict):
text: NotRequired[PromptModelInferenceConfigurationOutputTypeDef], # (1)PromptInferenceConfigurationTypeDef#
# PromptInferenceConfigurationTypeDef definition
class PromptInferenceConfigurationTypeDef(TypedDict):
text: NotRequired[PromptModelInferenceConfigurationTypeDef], # (1)TextPromptTemplateConfigurationOutputTypeDef#
# TextPromptTemplateConfigurationOutputTypeDef definition
class TextPromptTemplateConfigurationOutputTypeDef(TypedDict):
text: str,
inputVariables: NotRequired[List[PromptInputVariableTypeDef]], # (1)TextPromptTemplateConfigurationTypeDef#
# TextPromptTemplateConfigurationTypeDef definition
class TextPromptTemplateConfigurationTypeDef(TypedDict):
text: str,
inputVariables: NotRequired[Sequence[PromptInputVariableTypeDef]], # (1)RdsConfigurationTypeDef#
# RdsConfigurationTypeDef definition
class RdsConfigurationTypeDef(TypedDict):
credentialsSecretArn: str,
databaseName: str,
fieldMapping: RdsFieldMappingTypeDef, # (1)
resourceArn: str,
tableName: str,RedisEnterpriseCloudConfigurationTypeDef#
# RedisEnterpriseCloudConfigurationTypeDef definition
class RedisEnterpriseCloudConfigurationTypeDef(TypedDict):
credentialsSecretArn: str,
endpoint: str,
fieldMapping: RedisEnterpriseCloudFieldMappingTypeDef, # (1)
vectorIndexName: str,RetrievalFlowNodeServiceConfigurationTypeDef#
# RetrievalFlowNodeServiceConfigurationTypeDef definition
class RetrievalFlowNodeServiceConfigurationTypeDef(TypedDict):
s3: NotRequired[RetrievalFlowNodeS3ConfigurationTypeDef], # (1)UrlConfigurationOutputTypeDef#
# UrlConfigurationOutputTypeDef definition
class UrlConfigurationOutputTypeDef(TypedDict):
seedUrls: NotRequired[List[SeedUrlTypeDef]], # (1)- See SeedUrlTypeDef
UrlConfigurationTypeDef#
# UrlConfigurationTypeDef definition
class UrlConfigurationTypeDef(TypedDict):
seedUrls: NotRequired[Sequence[SeedUrlTypeDef]], # (1)- See SeedUrlTypeDef
StorageFlowNodeServiceConfigurationTypeDef#
# StorageFlowNodeServiceConfigurationTypeDef definition
class StorageFlowNodeServiceConfigurationTypeDef(TypedDict):
s3: NotRequired[StorageFlowNodeS3ConfigurationTypeDef], # (1)TransformationFunctionTypeDef#
# TransformationFunctionTypeDef definition
class TransformationFunctionTypeDef(TypedDict):
transformationLambdaConfiguration: TransformationLambdaConfigurationTypeDef, # (1)WebCrawlerConfigurationOutputTypeDef#
# WebCrawlerConfigurationOutputTypeDef definition
class WebCrawlerConfigurationOutputTypeDef(TypedDict):
crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef], # (1)
exclusionFilters: NotRequired[List[str]],
inclusionFilters: NotRequired[List[str]],
scope: NotRequired[WebScopeTypeType], # (2)WebCrawlerConfigurationTypeDef#
# WebCrawlerConfigurationTypeDef definition
class WebCrawlerConfigurationTypeDef(TypedDict):
crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef], # (1)
exclusionFilters: NotRequired[Sequence[str]],
inclusionFilters: NotRequired[Sequence[str]],
scope: NotRequired[WebScopeTypeType], # (2)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],
failureReasons: NotRequired[List[str]],- See AgentAliasHistoryEventTypeDef
- See AgentAliasStatusType
- See AgentAliasRoutingConfigurationListItemTypeDef
ListAgentAliasesResponseTypeDef#
# ListAgentAliasesResponseTypeDef definition
class ListAgentAliasesResponseTypeDef(TypedDict):
agentAliasSummaries: List[AgentAliasSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAgentsResponseTypeDef#
# ListAgentsResponseTypeDef definition
class ListAgentsResponseTypeDef(TypedDict):
agentSummaries: List[AgentSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAgentVersionsResponseTypeDef#
# ListAgentVersionsResponseTypeDef definition
class ListAgentVersionsResponseTypeDef(TypedDict):
agentVersionSummaries: List[AgentVersionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)VectorKnowledgeBaseConfigurationTypeDef#
# VectorKnowledgeBaseConfigurationTypeDef definition
class VectorKnowledgeBaseConfigurationTypeDef(TypedDict):
embeddingModelArn: str,
embeddingModelConfiguration: NotRequired[EmbeddingModelConfigurationTypeDef], # (1)ParsingConfigurationTypeDef#
# ParsingConfigurationTypeDef definition
class ParsingConfigurationTypeDef(TypedDict):
parsingStrategy: ParsingStrategyType, # (2)
bedrockFoundationModelConfiguration: NotRequired[BedrockFoundationModelConfigurationTypeDef], # (1)ListFlowAliasesResponseTypeDef#
# ListFlowAliasesResponseTypeDef definition
class ListFlowAliasesResponseTypeDef(TypedDict):
flowAliasSummaries: List[FlowAliasSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)FlowConnectionTypeDef#
# FlowConnectionTypeDef definition
class FlowConnectionTypeDef(TypedDict):
name: str,
source: str,
target: str,
type: FlowConnectionTypeType, # (2)
configuration: NotRequired[FlowConnectionConfigurationTypeDef], # (1)FunctionSchemaOutputTypeDef#
# FunctionSchemaOutputTypeDef definition
class FunctionSchemaOutputTypeDef(TypedDict):
functions: NotRequired[List[FunctionOutputTypeDef]], # (1)FunctionSchemaTypeDef#
# FunctionSchemaTypeDef definition
class FunctionSchemaTypeDef(TypedDict):
functions: NotRequired[Sequence[FunctionTypeDef]], # (1)- See FunctionTypeDef
ChunkingConfigurationOutputTypeDef#
# ChunkingConfigurationOutputTypeDef definition
class ChunkingConfigurationOutputTypeDef(TypedDict):
chunkingStrategy: ChunkingStrategyType, # (1)
fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef], # (2)
hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationOutputTypeDef], # (3)
semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef], # (4)- See ChunkingStrategyType
- See FixedSizeChunkingConfigurationTypeDef
- See HierarchicalChunkingConfigurationOutputTypeDef
- See SemanticChunkingConfigurationTypeDef
ChunkingConfigurationTypeDef#
# ChunkingConfigurationTypeDef definition
class ChunkingConfigurationTypeDef(TypedDict):
chunkingStrategy: ChunkingStrategyType, # (1)
fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef], # (2)
hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationTypeDef], # (3)
semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef], # (4)- See ChunkingStrategyType
- See FixedSizeChunkingConfigurationTypeDef
- See HierarchicalChunkingConfigurationTypeDef
- See SemanticChunkingConfigurationTypeDef
PromptOverrideConfigurationOutputTypeDef#
# PromptOverrideConfigurationOutputTypeDef definition
class PromptOverrideConfigurationOutputTypeDef(TypedDict):
promptConfigurations: List[PromptConfigurationOutputTypeDef], # (1)
overrideLambda: NotRequired[str],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)CrawlFilterConfigurationOutputTypeDef#
# CrawlFilterConfigurationOutputTypeDef definition
class CrawlFilterConfigurationOutputTypeDef(TypedDict):
type: CrawlFilterConfigurationTypeType, # (2)
patternObjectFilter: NotRequired[PatternObjectFilterConfigurationOutputTypeDef], # (1)CrawlFilterConfigurationTypeDef#
# CrawlFilterConfigurationTypeDef definition
class CrawlFilterConfigurationTypeDef(TypedDict):
type: CrawlFilterConfigurationTypeType, # (2)
patternObjectFilter: NotRequired[PatternObjectFilterConfigurationTypeDef], # (1)PromptTemplateConfigurationOutputTypeDef#
# PromptTemplateConfigurationOutputTypeDef definition
class PromptTemplateConfigurationOutputTypeDef(TypedDict):
text: NotRequired[TextPromptTemplateConfigurationOutputTypeDef], # (1)PromptTemplateConfigurationTypeDef#
# PromptTemplateConfigurationTypeDef definition
class PromptTemplateConfigurationTypeDef(TypedDict):
text: NotRequired[TextPromptTemplateConfigurationTypeDef], # (1)StorageConfigurationTypeDef#
# StorageConfigurationTypeDef definition
class StorageConfigurationTypeDef(TypedDict):
type: KnowledgeBaseStorageTypeType, # (6)
mongoDbAtlasConfiguration: NotRequired[MongoDbAtlasConfigurationTypeDef], # (1)
opensearchServerlessConfiguration: NotRequired[OpenSearchServerlessConfigurationTypeDef], # (2)
pineconeConfiguration: NotRequired[PineconeConfigurationTypeDef], # (3)
rdsConfiguration: NotRequired[RdsConfigurationTypeDef], # (4)
redisEnterpriseCloudConfiguration: NotRequired[RedisEnterpriseCloudConfigurationTypeDef], # (5)- See MongoDbAtlasConfigurationTypeDef
- See OpenSearchServerlessConfigurationTypeDef
- See PineconeConfigurationTypeDef
- See RdsConfigurationTypeDef
- See RedisEnterpriseCloudConfigurationTypeDef
- See KnowledgeBaseStorageTypeType
RetrievalFlowNodeConfigurationTypeDef#
# RetrievalFlowNodeConfigurationTypeDef definition
class RetrievalFlowNodeConfigurationTypeDef(TypedDict):
serviceConfiguration: RetrievalFlowNodeServiceConfigurationTypeDef, # (1)WebSourceConfigurationOutputTypeDef#
# WebSourceConfigurationOutputTypeDef definition
class WebSourceConfigurationOutputTypeDef(TypedDict):
urlConfiguration: UrlConfigurationOutputTypeDef, # (1)WebSourceConfigurationTypeDef#
# WebSourceConfigurationTypeDef definition
class WebSourceConfigurationTypeDef(TypedDict):
urlConfiguration: UrlConfigurationTypeDef, # (1)StorageFlowNodeConfigurationTypeDef#
# StorageFlowNodeConfigurationTypeDef definition
class StorageFlowNodeConfigurationTypeDef(TypedDict):
serviceConfiguration: StorageFlowNodeServiceConfigurationTypeDef, # (1)TransformationTypeDef#
# TransformationTypeDef definition
class TransformationTypeDef(TypedDict):
stepToApply: StepTypeType, # (1)
transformationFunction: TransformationFunctionTypeDef, # (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)KnowledgeBaseConfigurationTypeDef#
# KnowledgeBaseConfigurationTypeDef definition
class KnowledgeBaseConfigurationTypeDef(TypedDict):
type: KnowledgeBaseTypeType, # (1)
vectorKnowledgeBaseConfiguration: NotRequired[VectorKnowledgeBaseConfigurationTypeDef], # (2)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)- See ActionGroupExecutorTypeDef
- See ActionGroupStateType
- See APISchemaTypeDef
- See FunctionSchemaOutputTypeDef
- 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)- See ActionGroupExecutorTypeDef
- See ActionGroupStateType
- See APISchemaTypeDef
- See FunctionSchemaTypeDef
- 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)- See ActionGroupExecutorTypeDef
- See ActionGroupStateType
- See APISchemaTypeDef
- See FunctionSchemaTypeDef
- 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],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
instruction: NotRequired[str],
memoryConfiguration: NotRequired[MemoryConfigurationOutputTypeDef], # (3)
preparedAt: NotRequired[datetime],
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationOutputTypeDef], # (4)
recommendedActions: NotRequired[List[str]],- See AgentStatusType
- See GuardrailConfigurationTypeDef
- See MemoryConfigurationOutputTypeDef
- 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],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
instruction: NotRequired[str],
memoryConfiguration: NotRequired[MemoryConfigurationOutputTypeDef], # (3)
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationOutputTypeDef], # (4)
recommendedActions: NotRequired[List[str]],- See AgentStatusType
- See GuardrailConfigurationTypeDef
- See MemoryConfigurationOutputTypeDef
- 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],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (1)
idleSessionTTLInSeconds: NotRequired[int],
instruction: NotRequired[str],
memoryConfiguration: NotRequired[MemoryConfigurationTypeDef], # (2)
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (3)
tags: NotRequired[Mapping[str, str]],- See GuardrailConfigurationTypeDef
- See MemoryConfigurationTypeDef
- See PromptOverrideConfigurationTypeDef
UpdateAgentRequestRequestTypeDef#
# UpdateAgentRequestRequestTypeDef definition
class UpdateAgentRequestRequestTypeDef(TypedDict):
agentId: str,
agentName: str,
agentResourceRoleArn: str,
foundationModel: str,
customerEncryptionKeyArn: NotRequired[str],
description: NotRequired[str],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (1)
idleSessionTTLInSeconds: NotRequired[int],
instruction: NotRequired[str],
memoryConfiguration: NotRequired[MemoryConfigurationTypeDef], # (2)
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (3)- See GuardrailConfigurationTypeDef
- See MemoryConfigurationTypeDef
- See PromptOverrideConfigurationTypeDef
ConfluenceCrawlerConfigurationOutputTypeDef#
# ConfluenceCrawlerConfigurationOutputTypeDef definition
class ConfluenceCrawlerConfigurationOutputTypeDef(TypedDict):
filterConfiguration: NotRequired[CrawlFilterConfigurationOutputTypeDef], # (1)SalesforceCrawlerConfigurationOutputTypeDef#
# SalesforceCrawlerConfigurationOutputTypeDef definition
class SalesforceCrawlerConfigurationOutputTypeDef(TypedDict):
filterConfiguration: NotRequired[CrawlFilterConfigurationOutputTypeDef], # (1)SharePointCrawlerConfigurationOutputTypeDef#
# SharePointCrawlerConfigurationOutputTypeDef definition
class SharePointCrawlerConfigurationOutputTypeDef(TypedDict):
filterConfiguration: NotRequired[CrawlFilterConfigurationOutputTypeDef], # (1)ConfluenceCrawlerConfigurationTypeDef#
# ConfluenceCrawlerConfigurationTypeDef definition
class ConfluenceCrawlerConfigurationTypeDef(TypedDict):
filterConfiguration: NotRequired[CrawlFilterConfigurationTypeDef], # (1)SalesforceCrawlerConfigurationTypeDef#
# SalesforceCrawlerConfigurationTypeDef definition
class SalesforceCrawlerConfigurationTypeDef(TypedDict):
filterConfiguration: NotRequired[CrawlFilterConfigurationTypeDef], # (1)SharePointCrawlerConfigurationTypeDef#
# SharePointCrawlerConfigurationTypeDef definition
class SharePointCrawlerConfigurationTypeDef(TypedDict):
filterConfiguration: NotRequired[CrawlFilterConfigurationTypeDef], # (1)PromptFlowNodeInlineConfigurationOutputTypeDef#
# PromptFlowNodeInlineConfigurationOutputTypeDef definition
class PromptFlowNodeInlineConfigurationOutputTypeDef(TypedDict):
modelId: str,
templateConfiguration: PromptTemplateConfigurationOutputTypeDef, # (2)
templateType: PromptTemplateTypeType, # (3)
inferenceConfiguration: NotRequired[PromptInferenceConfigurationOutputTypeDef], # (1)- See PromptInferenceConfigurationOutputTypeDef
- See PromptTemplateConfigurationOutputTypeDef
- See PromptTemplateTypeType
PromptVariantOutputTypeDef#
# PromptVariantOutputTypeDef definition
class PromptVariantOutputTypeDef(TypedDict):
name: str,
templateType: PromptTemplateTypeType, # (3)
inferenceConfiguration: NotRequired[PromptInferenceConfigurationOutputTypeDef], # (1)
modelId: NotRequired[str],
templateConfiguration: NotRequired[PromptTemplateConfigurationOutputTypeDef], # (2)- See PromptInferenceConfigurationOutputTypeDef
- See PromptTemplateConfigurationOutputTypeDef
- See PromptTemplateTypeType
PromptFlowNodeInlineConfigurationTypeDef#
# PromptFlowNodeInlineConfigurationTypeDef definition
class PromptFlowNodeInlineConfigurationTypeDef(TypedDict):
modelId: str,
templateConfiguration: PromptTemplateConfigurationTypeDef, # (2)
templateType: PromptTemplateTypeType, # (3)
inferenceConfiguration: NotRequired[PromptInferenceConfigurationTypeDef], # (1)- See PromptInferenceConfigurationTypeDef
- See PromptTemplateConfigurationTypeDef
- See PromptTemplateTypeType
PromptVariantTypeDef#
# PromptVariantTypeDef definition
class PromptVariantTypeDef(TypedDict):
name: str,
templateType: PromptTemplateTypeType, # (3)
inferenceConfiguration: NotRequired[PromptInferenceConfigurationTypeDef], # (1)
modelId: NotRequired[str],
templateConfiguration: NotRequired[PromptTemplateConfigurationTypeDef], # (2)- See PromptInferenceConfigurationTypeDef
- See PromptTemplateConfigurationTypeDef
- See PromptTemplateTypeType
WebDataSourceConfigurationOutputTypeDef#
# WebDataSourceConfigurationOutputTypeDef definition
class WebDataSourceConfigurationOutputTypeDef(TypedDict):
sourceConfiguration: WebSourceConfigurationOutputTypeDef, # (2)
crawlerConfiguration: NotRequired[WebCrawlerConfigurationOutputTypeDef], # (1)WebDataSourceConfigurationTypeDef#
# WebDataSourceConfigurationTypeDef definition
class WebDataSourceConfigurationTypeDef(TypedDict):
sourceConfiguration: WebSourceConfigurationTypeDef, # (2)
crawlerConfiguration: NotRequired[WebCrawlerConfigurationTypeDef], # (1)CustomTransformationConfigurationOutputTypeDef#
# CustomTransformationConfigurationOutputTypeDef definition
class CustomTransformationConfigurationOutputTypeDef(TypedDict):
intermediateStorage: IntermediateStorageTypeDef, # (1)
transformations: List[TransformationTypeDef], # (2)CustomTransformationConfigurationTypeDef#
# CustomTransformationConfigurationTypeDef definition
class CustomTransformationConfigurationTypeDef(TypedDict):
intermediateStorage: IntermediateStorageTypeDef, # (1)
transformations: Sequence[TransformationTypeDef], # (2)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]],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]],UpdateKnowledgeBaseRequestRequestTypeDef#
# UpdateKnowledgeBaseRequestRequestTypeDef definition
class UpdateKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseConfiguration: KnowledgeBaseConfigurationTypeDef, # (1)
knowledgeBaseId: str,
name: str,
roleArn: str,
storageConfiguration: StorageConfigurationTypeDef, # (2)
description: NotRequired[str],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)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)ConfluenceDataSourceConfigurationOutputTypeDef#
# ConfluenceDataSourceConfigurationOutputTypeDef definition
class ConfluenceDataSourceConfigurationOutputTypeDef(TypedDict):
sourceConfiguration: ConfluenceSourceConfigurationTypeDef, # (2)
crawlerConfiguration: NotRequired[ConfluenceCrawlerConfigurationOutputTypeDef], # (1)SalesforceDataSourceConfigurationOutputTypeDef#
# SalesforceDataSourceConfigurationOutputTypeDef definition
class SalesforceDataSourceConfigurationOutputTypeDef(TypedDict):
sourceConfiguration: SalesforceSourceConfigurationTypeDef, # (2)
crawlerConfiguration: NotRequired[SalesforceCrawlerConfigurationOutputTypeDef], # (1)SharePointDataSourceConfigurationOutputTypeDef#
# SharePointDataSourceConfigurationOutputTypeDef definition
class SharePointDataSourceConfigurationOutputTypeDef(TypedDict):
sourceConfiguration: SharePointSourceConfigurationOutputTypeDef, # (2)
crawlerConfiguration: NotRequired[SharePointCrawlerConfigurationOutputTypeDef], # (1)ConfluenceDataSourceConfigurationTypeDef#
# ConfluenceDataSourceConfigurationTypeDef definition
class ConfluenceDataSourceConfigurationTypeDef(TypedDict):
sourceConfiguration: ConfluenceSourceConfigurationTypeDef, # (2)
crawlerConfiguration: NotRequired[ConfluenceCrawlerConfigurationTypeDef], # (1)SalesforceDataSourceConfigurationTypeDef#
# SalesforceDataSourceConfigurationTypeDef definition
class SalesforceDataSourceConfigurationTypeDef(TypedDict):
sourceConfiguration: SalesforceSourceConfigurationTypeDef, # (2)
crawlerConfiguration: NotRequired[SalesforceCrawlerConfigurationTypeDef], # (1)SharePointDataSourceConfigurationTypeDef#
# SharePointDataSourceConfigurationTypeDef definition
class SharePointDataSourceConfigurationTypeDef(TypedDict):
sourceConfiguration: SharePointSourceConfigurationTypeDef, # (2)
crawlerConfiguration: NotRequired[SharePointCrawlerConfigurationTypeDef], # (1)PromptFlowNodeSourceConfigurationOutputTypeDef#
# PromptFlowNodeSourceConfigurationOutputTypeDef definition
class PromptFlowNodeSourceConfigurationOutputTypeDef(TypedDict):
inline: NotRequired[PromptFlowNodeInlineConfigurationOutputTypeDef], # (1)
resource: NotRequired[PromptFlowNodeResourceConfigurationTypeDef], # (2)CreatePromptResponseTypeDef#
# CreatePromptResponseTypeDef definition
class CreatePromptResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
defaultVariant: str,
description: str,
id: str,
name: str,
updatedAt: datetime,
variants: List[PromptVariantOutputTypeDef], # (1)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreatePromptVersionResponseTypeDef#
# CreatePromptVersionResponseTypeDef definition
class CreatePromptVersionResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
defaultVariant: str,
description: str,
id: str,
name: str,
updatedAt: datetime,
variants: List[PromptVariantOutputTypeDef], # (1)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetPromptResponseTypeDef#
# GetPromptResponseTypeDef definition
class GetPromptResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
defaultVariant: str,
description: str,
id: str,
name: str,
updatedAt: datetime,
variants: List[PromptVariantOutputTypeDef], # (1)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdatePromptResponseTypeDef#
# UpdatePromptResponseTypeDef definition
class UpdatePromptResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
defaultVariant: str,
description: str,
id: str,
name: str,
updatedAt: datetime,
variants: List[PromptVariantOutputTypeDef], # (1)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)PromptFlowNodeSourceConfigurationTypeDef#
# PromptFlowNodeSourceConfigurationTypeDef definition
class PromptFlowNodeSourceConfigurationTypeDef(TypedDict):
inline: NotRequired[PromptFlowNodeInlineConfigurationTypeDef], # (1)
resource: NotRequired[PromptFlowNodeResourceConfigurationTypeDef], # (2)VectorIngestionConfigurationOutputTypeDef#
# VectorIngestionConfigurationOutputTypeDef definition
class VectorIngestionConfigurationOutputTypeDef(TypedDict):
chunkingConfiguration: NotRequired[ChunkingConfigurationOutputTypeDef], # (1)
customTransformationConfiguration: NotRequired[CustomTransformationConfigurationOutputTypeDef], # (2)
parsingConfiguration: NotRequired[ParsingConfigurationTypeDef], # (3)- See ChunkingConfigurationOutputTypeDef
- See CustomTransformationConfigurationOutputTypeDef
- See ParsingConfigurationTypeDef
VectorIngestionConfigurationTypeDef#
# VectorIngestionConfigurationTypeDef definition
class VectorIngestionConfigurationTypeDef(TypedDict):
chunkingConfiguration: NotRequired[ChunkingConfigurationTypeDef], # (1)
customTransformationConfiguration: NotRequired[CustomTransformationConfigurationTypeDef], # (2)
parsingConfiguration: NotRequired[ParsingConfigurationTypeDef], # (3)- See ChunkingConfigurationTypeDef
- See CustomTransformationConfigurationTypeDef
- See ParsingConfigurationTypeDef
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)DataSourceConfigurationOutputTypeDef#
# DataSourceConfigurationOutputTypeDef definition
class DataSourceConfigurationOutputTypeDef(TypedDict):
type: DataSourceTypeType, # (5)
confluenceConfiguration: NotRequired[ConfluenceDataSourceConfigurationOutputTypeDef], # (1)
s3Configuration: NotRequired[S3DataSourceConfigurationOutputTypeDef], # (2)
salesforceConfiguration: NotRequired[SalesforceDataSourceConfigurationOutputTypeDef], # (3)
sharePointConfiguration: NotRequired[SharePointDataSourceConfigurationOutputTypeDef], # (4)
webConfiguration: NotRequired[WebDataSourceConfigurationOutputTypeDef], # (6)- See ConfluenceDataSourceConfigurationOutputTypeDef
- See S3DataSourceConfigurationOutputTypeDef
- See SalesforceDataSourceConfigurationOutputTypeDef
- See SharePointDataSourceConfigurationOutputTypeDef
- See DataSourceTypeType
- See WebDataSourceConfigurationOutputTypeDef
DataSourceConfigurationTypeDef#
# DataSourceConfigurationTypeDef definition
class DataSourceConfigurationTypeDef(TypedDict):
type: DataSourceTypeType, # (5)
confluenceConfiguration: NotRequired[ConfluenceDataSourceConfigurationTypeDef], # (1)
s3Configuration: NotRequired[S3DataSourceConfigurationTypeDef], # (2)
salesforceConfiguration: NotRequired[SalesforceDataSourceConfigurationTypeDef], # (3)
sharePointConfiguration: NotRequired[SharePointDataSourceConfigurationTypeDef], # (4)
webConfiguration: NotRequired[WebDataSourceConfigurationTypeDef], # (6)- See ConfluenceDataSourceConfigurationTypeDef
- See S3DataSourceConfigurationTypeDef
- See SalesforceDataSourceConfigurationTypeDef
- See SharePointDataSourceConfigurationTypeDef
- See DataSourceTypeType
- See WebDataSourceConfigurationTypeDef
PromptFlowNodeConfigurationOutputTypeDef#
# PromptFlowNodeConfigurationOutputTypeDef definition
class PromptFlowNodeConfigurationOutputTypeDef(TypedDict):
sourceConfiguration: PromptFlowNodeSourceConfigurationOutputTypeDef, # (1)PromptFlowNodeConfigurationTypeDef#
# PromptFlowNodeConfigurationTypeDef definition
class PromptFlowNodeConfigurationTypeDef(TypedDict):
sourceConfiguration: PromptFlowNodeSourceConfigurationTypeDef, # (1)CreatePromptRequestRequestTypeDef#
# CreatePromptRequestRequestTypeDef definition
class CreatePromptRequestRequestTypeDef(TypedDict):
name: str,
clientToken: NotRequired[str],
customerEncryptionKeyArn: NotRequired[str],
defaultVariant: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
variants: NotRequired[Sequence[Union[PromptVariantTypeDef, PromptVariantOutputTypeDef]]], # (1)UpdatePromptRequestRequestTypeDef#
# UpdatePromptRequestRequestTypeDef definition
class UpdatePromptRequestRequestTypeDef(TypedDict):
name: str,
promptIdentifier: str,
customerEncryptionKeyArn: NotRequired[str],
defaultVariant: NotRequired[str],
description: NotRequired[str],
variants: NotRequired[Sequence[Union[PromptVariantTypeDef, PromptVariantOutputTypeDef]]], # (1)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[VectorIngestionConfigurationOutputTypeDef], # (5)- See DataDeletionPolicyType
- See DataSourceConfigurationOutputTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See DataSourceStatusType
- See VectorIngestionConfigurationOutputTypeDef
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)- See DataSourceConfigurationTypeDef
- See DataDeletionPolicyType
- See ServerSideEncryptionConfigurationTypeDef
- 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)- See DataSourceConfigurationTypeDef
- See DataDeletionPolicyType
- See ServerSideEncryptionConfigurationTypeDef
- See VectorIngestionConfigurationTypeDef
FlowNodeConfigurationOutputTypeDef#
# FlowNodeConfigurationOutputTypeDef definition
class FlowNodeConfigurationOutputTypeDef(TypedDict):
agent: NotRequired[AgentFlowNodeConfigurationTypeDef], # (1)
collector: NotRequired[Dict[str, Any]],
condition: NotRequired[ConditionFlowNodeConfigurationOutputTypeDef], # (2)
input: NotRequired[Dict[str, Any]],
iterator: NotRequired[Dict[str, Any]],
knowledgeBase: NotRequired[KnowledgeBaseFlowNodeConfigurationTypeDef], # (3)
lambdaFunction: NotRequired[LambdaFunctionFlowNodeConfigurationTypeDef], # (4)
lex: NotRequired[LexFlowNodeConfigurationTypeDef], # (5)
output: NotRequired[Dict[str, Any]],
prompt: NotRequired[PromptFlowNodeConfigurationOutputTypeDef], # (6)
retrieval: NotRequired[RetrievalFlowNodeConfigurationTypeDef], # (7)
storage: NotRequired[StorageFlowNodeConfigurationTypeDef], # (8)- See AgentFlowNodeConfigurationTypeDef
- See ConditionFlowNodeConfigurationOutputTypeDef
- See KnowledgeBaseFlowNodeConfigurationTypeDef
- See LambdaFunctionFlowNodeConfigurationTypeDef
- See LexFlowNodeConfigurationTypeDef
- See PromptFlowNodeConfigurationOutputTypeDef
- See RetrievalFlowNodeConfigurationTypeDef
- See StorageFlowNodeConfigurationTypeDef
FlowNodeConfigurationTypeDef#
# FlowNodeConfigurationTypeDef definition
class FlowNodeConfigurationTypeDef(TypedDict):
agent: NotRequired[AgentFlowNodeConfigurationTypeDef], # (1)
collector: NotRequired[Mapping[str, Any]],
condition: NotRequired[ConditionFlowNodeConfigurationTypeDef], # (2)
input: NotRequired[Mapping[str, Any]],
iterator: NotRequired[Mapping[str, Any]],
knowledgeBase: NotRequired[KnowledgeBaseFlowNodeConfigurationTypeDef], # (3)
lambdaFunction: NotRequired[LambdaFunctionFlowNodeConfigurationTypeDef], # (4)
lex: NotRequired[LexFlowNodeConfigurationTypeDef], # (5)
output: NotRequired[Mapping[str, Any]],
prompt: NotRequired[PromptFlowNodeConfigurationTypeDef], # (6)
retrieval: NotRequired[RetrievalFlowNodeConfigurationTypeDef], # (7)
storage: NotRequired[StorageFlowNodeConfigurationTypeDef], # (8)- See AgentFlowNodeConfigurationTypeDef
- See ConditionFlowNodeConfigurationTypeDef
- See KnowledgeBaseFlowNodeConfigurationTypeDef
- See LambdaFunctionFlowNodeConfigurationTypeDef
- See LexFlowNodeConfigurationTypeDef
- See PromptFlowNodeConfigurationTypeDef
- See RetrievalFlowNodeConfigurationTypeDef
- See StorageFlowNodeConfigurationTypeDef
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)FlowNodeExtraOutputTypeDef#
# FlowNodeExtraOutputTypeDef definition
class FlowNodeExtraOutputTypeDef(TypedDict):
name: str,
type: FlowNodeTypeType, # (4)
configuration: NotRequired[FlowNodeConfigurationOutputTypeDef], # (1)
inputs: NotRequired[List[FlowNodeInputTypeDef]], # (2)
outputs: NotRequired[List[FlowNodeOutputTypeDef]], # (3)- See FlowNodeConfigurationOutputTypeDef
- See FlowNodeInputTypeDef
- See FlowNodeOutputTypeDef
- See FlowNodeTypeType
FlowNodeTypeDef#
# FlowNodeTypeDef definition
class FlowNodeTypeDef(TypedDict):
name: str,
type: FlowNodeTypeType, # (4)
configuration: NotRequired[FlowNodeConfigurationTypeDef], # (1)
inputs: NotRequired[Sequence[FlowNodeInputTypeDef]], # (2)
outputs: NotRequired[Sequence[FlowNodeOutputTypeDef]], # (3)- See FlowNodeConfigurationTypeDef
- See FlowNodeInputTypeDef
- See FlowNodeOutputTypeDef
- See FlowNodeTypeType
FlowDefinitionOutputTypeDef#
# FlowDefinitionOutputTypeDef definition
class FlowDefinitionOutputTypeDef(TypedDict):
connections: NotRequired[List[FlowConnectionTypeDef]], # (1)
nodes: NotRequired[List[FlowNodeExtraOutputTypeDef]], # (2)FlowDefinitionTypeDef#
# FlowDefinitionTypeDef definition
class FlowDefinitionTypeDef(TypedDict):
connections: NotRequired[Sequence[FlowConnectionTypeDef]], # (1)
nodes: NotRequired[Sequence[FlowNodeTypeDef]], # (2)- See FlowConnectionTypeDef
- See FlowNodeTypeDef
CreateFlowResponseTypeDef#
# CreateFlowResponseTypeDef definition
class CreateFlowResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
definition: FlowDefinitionOutputTypeDef, # (1)
description: str,
executionRoleArn: str,
id: str,
name: str,
status: FlowStatusType, # (2)
updatedAt: datetime,
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)CreateFlowVersionResponseTypeDef#
# CreateFlowVersionResponseTypeDef definition
class CreateFlowVersionResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
definition: FlowDefinitionOutputTypeDef, # (1)
description: str,
executionRoleArn: str,
id: str,
name: str,
status: FlowStatusType, # (2)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetFlowResponseTypeDef#
# GetFlowResponseTypeDef definition
class GetFlowResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
definition: FlowDefinitionOutputTypeDef, # (1)
description: str,
executionRoleArn: str,
id: str,
name: str,
status: FlowStatusType, # (2)
updatedAt: datetime,
validations: List[FlowValidationTypeDef], # (3)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See FlowDefinitionOutputTypeDef
- See FlowStatusType
- See FlowValidationTypeDef
- See ResponseMetadataTypeDef
GetFlowVersionResponseTypeDef#
# GetFlowVersionResponseTypeDef definition
class GetFlowVersionResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
definition: FlowDefinitionOutputTypeDef, # (1)
description: str,
executionRoleArn: str,
id: str,
name: str,
status: FlowStatusType, # (2)
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateFlowResponseTypeDef#
# UpdateFlowResponseTypeDef definition
class UpdateFlowResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
customerEncryptionKeyArn: str,
definition: FlowDefinitionOutputTypeDef, # (1)
description: str,
executionRoleArn: str,
id: str,
name: str,
status: FlowStatusType, # (2)
updatedAt: datetime,
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)CreateFlowRequestRequestTypeDef#
# CreateFlowRequestRequestTypeDef definition
class CreateFlowRequestRequestTypeDef(TypedDict):
executionRoleArn: str,
name: str,
clientToken: NotRequired[str],
customerEncryptionKeyArn: NotRequired[str],
definition: NotRequired[FlowDefinitionTypeDef], # (1)
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],UpdateFlowRequestRequestTypeDef#
# UpdateFlowRequestRequestTypeDef definition
class UpdateFlowRequestRequestTypeDef(TypedDict):
executionRoleArn: str,
flowIdentifier: str,
name: str,
customerEncryptionKeyArn: NotRequired[str],
definition: NotRequired[FlowDefinitionTypeDef], # (1)
description: NotRequired[str],