Skip to content

Bedrock Agent Classes

APISchemaTypeDef

payload

  • Type: typing.Optional[str]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.S3IdentifierTypeDef]

ActionGroupExecutorTypeDef

customControl

  • Type: typing.Optional[typing.Literal['RETURN_CONTROL']]

ActionGroupSummaryTypeDef

actionGroupId

  • Type:
  • Required: Yes

actionGroupName

  • Type:
  • Required: Yes

actionGroupState

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

AgentActionGroupTypeDef

actionGroupId

  • Type:
  • Required: Yes

actionGroupName

  • Type:
  • Required: Yes

actionGroupState

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

actionGroupExecutor

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ActionGroupExecutorTypeDef]

apiSchema

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.APISchemaTypeDef]

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

functionSchema

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FunctionSchemaOutputTypeDef]

parentActionSignature

  • Type: typing.Optional[typing.Literal['AMAZON.CodeInterpreter', 'AMAZON.UserInput']]

AgentAliasHistoryEventTypeDef

endDate

  • Type: typing.Optional[datetime.datetime]

routingConfiguration

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasRoutingConfigurationListItemTypeDef]]

startDate

  • Type: typing.Optional[datetime.datetime]

AgentAliasRoutingConfigurationListItemTypeDef

agentVersion

  • Type: typing.Optional[str]

provisionedThroughput

  • Type: typing.Optional[str]

AgentAliasSummaryTypeDef

agentAliasId

  • Type:
  • Required: Yes

agentAliasName

  • Type:
  • Required: Yes

agentAliasStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'PREPARED', 'UPDATING']
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

routingConfiguration

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasRoutingConfigurationListItemTypeDef]]

AgentAliasTypeDef

agentAliasArn

  • Type:
  • Required: Yes

agentAliasId

  • Type:
  • Required: Yes

agentAliasName

  • Type:
  • Required: Yes

agentAliasStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'PREPARED', 'UPDATING']
  • Required: Yes

agentId

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

agentAliasHistoryEvents

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasHistoryEventTypeDef]]

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

failureReasons

  • Type: typing.Optional[typing.List[str]]

AgentFlowNodeConfigurationTypeDef

agentAliasArn

  • Type:
  • Required: Yes

AgentKnowledgeBaseSummaryTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseState

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

AgentKnowledgeBaseTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseState

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

AgentSummaryTypeDef

agentId

  • Type:
  • Required: Yes

agentName

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

guardrailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.GuardrailConfigurationTypeDef]

latestAgentVersion

  • Type: typing.Optional[str]

AgentTypeDef

agentArn

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentName

  • Type:
  • Required: Yes

agentResourceRoleArn

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

idleSessionTTLInSeconds

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

customerEncryptionKeyArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

failureReasons

  • Type: typing.Optional[typing.List[str]]

foundationModel

  • Type: typing.Optional[str]

guardrailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.GuardrailConfigurationTypeDef]

instruction

  • Type: typing.Optional[str]

memoryConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.MemoryConfigurationOutputTypeDef]

preparedAt

  • Type: typing.Optional[datetime.datetime]

promptOverrideConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptOverrideConfigurationOutputTypeDef]

recommendedActions

  • Type: typing.Optional[typing.List[str]]

AgentVersionSummaryTypeDef

agentName

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

guardrailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.GuardrailConfigurationTypeDef]

AgentVersionTypeDef

agentArn

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentName

  • Type:
  • Required: Yes

agentResourceRoleArn

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

idleSessionTTLInSeconds

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

failureReasons

  • Type: typing.Optional[typing.List[str]]

foundationModel

  • Type: typing.Optional[str]

guardrailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.GuardrailConfigurationTypeDef]

instruction

  • Type: typing.Optional[str]

memoryConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.MemoryConfigurationOutputTypeDef]

promptOverrideConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptOverrideConfigurationOutputTypeDef]

recommendedActions

  • Type: typing.Optional[typing.List[str]]

AssociateAgentKnowledgeBaseRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseState

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

AssociateAgentKnowledgeBaseResponseTypeDef

agentKnowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BedrockEmbeddingModelConfigurationTypeDef

dimensions

  • Type: typing.Optional[int]

BedrockFoundationModelConfigurationTypeDef

modelArn

  • Type:
  • Required: Yes

parsingPrompt

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ParsingPromptTypeDef]

ChunkingConfigurationOutputTypeDef

chunkingStrategy

  • Type: typing.Literal['FIXED_SIZE', 'HIERARCHICAL', 'NONE', 'SEMANTIC']
  • Required: Yes

fixedSizeChunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FixedSizeChunkingConfigurationTypeDef]

hierarchicalChunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.HierarchicalChunkingConfigurationOutputTypeDef]

semanticChunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SemanticChunkingConfigurationTypeDef]

ChunkingConfigurationTypeDef

chunkingStrategy

  • Type: typing.Literal['FIXED_SIZE', 'HIERARCHICAL', 'NONE', 'SEMANTIC']
  • Required: Yes

fixedSizeChunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FixedSizeChunkingConfigurationTypeDef]

hierarchicalChunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.HierarchicalChunkingConfigurationTypeDef]

semanticChunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SemanticChunkingConfigurationTypeDef]

ConditionFlowNodeConfigurationOutputTypeDef

conditions

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowConditionTypeDef]
  • Required: Yes

ConditionFlowNodeConfigurationTypeDef

conditions

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowConditionTypeDef]
  • Required: Yes

ConfluenceCrawlerConfigurationOutputTypeDef

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CrawlFilterConfigurationOutputTypeDef]

ConfluenceCrawlerConfigurationTypeDef

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CrawlFilterConfigurationTypeDef]

ConfluenceDataSourceConfigurationOutputTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ConfluenceCrawlerConfigurationOutputTypeDef]

ConfluenceDataSourceConfigurationTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ConfluenceCrawlerConfigurationTypeDef]

ConfluenceSourceConfigurationTypeDef

authType

  • Type: typing.Literal['BASIC', 'OAUTH2_CLIENT_CREDENTIALS']
  • Required: Yes

credentialsSecretArn

  • Type:
  • Required: Yes

hostType

  • Type: typing.Literal['SAAS']
  • Required: Yes

hostUrl

  • Type:
  • Required: Yes

CrawlFilterConfigurationOutputTypeDef

type

  • Type: typing.Literal['PATTERN']
  • Required: Yes

patternObjectFilter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PatternObjectFilterConfigurationOutputTypeDef]

CrawlFilterConfigurationTypeDef

type

  • Type: typing.Literal['PATTERN']
  • Required: Yes

patternObjectFilter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PatternObjectFilterConfigurationTypeDef]

CreateAgentActionGroupRequestRequestTypeDef

actionGroupName

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

actionGroupExecutor

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ActionGroupExecutorTypeDef]

actionGroupState

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

apiSchema

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.APISchemaTypeDef]

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

functionSchema

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FunctionSchemaTypeDef]

parentActionGroupSignature

  • Type: typing.Optional[typing.Literal['AMAZON.CodeInterpreter', 'AMAZON.UserInput']]

CreateAgentActionGroupResponseTypeDef

agentActionGroup

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAgentAliasRequestRequestTypeDef

agentAliasName

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

routingConfiguration

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasRoutingConfigurationListItemTypeDef]]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateAgentAliasResponseTypeDef

agentAlias

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAgentRequestRequestTypeDef

agentName

  • Type:
  • Required: Yes

agentResourceRoleArn

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

customerEncryptionKeyArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

foundationModel

  • Type: typing.Optional[str]

guardrailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.GuardrailConfigurationTypeDef]

idleSessionTTLInSeconds

  • Type: typing.Optional[int]

instruction

  • Type: typing.Optional[str]

memoryConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.MemoryConfigurationTypeDef]

promptOverrideConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptOverrideConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateAgentResponseTypeDef

agent

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataSourceRequestRequestTypeDef

dataSourceConfiguration

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

dataDeletionPolicy

  • Type: typing.Optional[typing.Literal['DELETE', 'RETAIN']]

description

  • Type: typing.Optional[str]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ServerSideEncryptionConfigurationTypeDef]

vectorIngestionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.VectorIngestionConfigurationTypeDef]

CreateDataSourceResponseTypeDef

dataSource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateFlowAliasRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateFlowAliasResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

flowId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateFlowRequestRequestTypeDef

executionRoleArn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

customerEncryptionKeyArn

  • Type: typing.Optional[str]

definition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowDefinitionTypeDef]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateFlowResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateFlowVersionRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

CreateFlowVersionResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKnowledgeBaseRequestRequestTypeDef

knowledgeBaseConfiguration

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

storageConfiguration

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateKnowledgeBaseResponseTypeDef

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatePromptRequestRequestTypeDef

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

customerEncryptionKeyArn

  • Type: typing.Optional[str]

defaultVariant

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

variants

  • Type: typing.Optional[typing.Sequence[typing.Union[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantTypeDef, aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantOutputTypeDef]]]

CreatePromptResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

defaultVariant

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

variants

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantOutputTypeDef]
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatePromptVersionRequestRequestTypeDef

promptIdentifier

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreatePromptVersionResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

defaultVariant

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

variants

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantOutputTypeDef]
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CustomTransformationConfigurationOutputTypeDef

intermediateStorage

  • Type:
  • Required: Yes

transformations

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.TransformationTypeDef]
  • Required: Yes

CustomTransformationConfigurationTypeDef

intermediateStorage

  • Type:
  • Required: Yes

transformations

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.TransformationTypeDef]
  • Required: Yes

DataSourceConfigurationOutputTypeDef

type

  • Type: typing.Literal['CONFLUENCE', 'S3', 'SALESFORCE', 'SHAREPOINT', 'WEB']
  • Required: Yes

confluenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ConfluenceDataSourceConfigurationOutputTypeDef]

s3Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.S3DataSourceConfigurationOutputTypeDef]

salesforceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SalesforceDataSourceConfigurationOutputTypeDef]

sharePointConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SharePointDataSourceConfigurationOutputTypeDef]

webConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.WebDataSourceConfigurationOutputTypeDef]

DataSourceConfigurationTypeDef

type

  • Type: typing.Literal['CONFLUENCE', 'S3', 'SALESFORCE', 'SHAREPOINT', 'WEB']
  • Required: Yes

confluenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ConfluenceDataSourceConfigurationTypeDef]

s3Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.S3DataSourceConfigurationTypeDef]

salesforceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SalesforceDataSourceConfigurationTypeDef]

sharePointConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SharePointDataSourceConfigurationTypeDef]

webConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.WebDataSourceConfigurationTypeDef]

DataSourceSummaryTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['AVAILABLE', 'DELETE_UNSUCCESSFUL', 'DELETING']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

DataSourceTypeDef

createdAt

  • Type:
  • Required: Yes

dataSourceConfiguration

  • Type:
  • Required: Yes

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['AVAILABLE', 'DELETE_UNSUCCESSFUL', 'DELETING']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

dataDeletionPolicy

  • Type: typing.Optional[typing.Literal['DELETE', 'RETAIN']]

description

  • Type: typing.Optional[str]

failureReasons

  • Type: typing.Optional[typing.List[str]]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ServerSideEncryptionConfigurationTypeDef]

vectorIngestionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.VectorIngestionConfigurationOutputTypeDef]

DeleteAgentActionGroupRequestRequestTypeDef

actionGroupId

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

skipResourceInUseCheck

  • Type: typing.Optional[bool]

DeleteAgentAliasRequestRequestTypeDef

agentAliasId

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

DeleteAgentAliasResponseTypeDef

agentAliasId

  • Type:
  • Required: Yes

agentAliasStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'PREPARED', 'UPDATING']
  • Required: Yes

agentId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAgentRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

skipResourceInUseCheck

  • Type: typing.Optional[bool]

DeleteAgentResponseTypeDef

agentId

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAgentVersionRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

skipResourceInUseCheck

  • Type: typing.Optional[bool]

DeleteAgentVersionResponseTypeDef

agentId

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDataSourceRequestRequestTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteDataSourceResponseTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['AVAILABLE', 'DELETE_UNSUCCESSFUL', 'DELETING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteFlowAliasRequestRequestTypeDef

aliasIdentifier

  • Type:
  • Required: Yes

flowIdentifier

  • Type:
  • Required: Yes

DeleteFlowAliasResponseTypeDef

flowId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteFlowRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

skipResourceInUseCheck

  • Type: typing.Optional[bool]

DeleteFlowResponseTypeDef

id

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteFlowVersionRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

flowVersion

  • Type:
  • Required: Yes

skipResourceInUseCheck

  • Type: typing.Optional[bool]

DeleteFlowVersionResponseTypeDef

id

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteKnowledgeBaseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteKnowledgeBaseResponseTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETE_UNSUCCESSFUL', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeletePromptRequestRequestTypeDef

promptIdentifier

  • Type:
  • Required: Yes

promptVersion

  • Type: typing.Optional[str]

DeletePromptResponseTypeDef

id

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisassociateAgentKnowledgeBaseRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

EmbeddingModelConfigurationTypeDef

bedrockEmbeddingModelConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.BedrockEmbeddingModelConfigurationTypeDef]

FixedSizeChunkingConfigurationTypeDef

maxTokens

  • Type:
  • Required: Yes

overlapPercentage

  • Type:
  • Required: Yes

FlowAliasRoutingConfigurationListItemTypeDef

flowVersion

  • Type: typing.Optional[str]

FlowAliasSummaryTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

flowId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

FlowConditionTypeDef

name

  • Type:
  • Required: Yes

expression

  • Type: typing.Optional[str]

FlowConditionalConnectionConfigurationTypeDef

condition

  • Type:
  • Required: Yes

FlowConnectionConfigurationTypeDef

conditional

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowConditionalConnectionConfigurationTypeDef]

data

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowDataConnectionConfigurationTypeDef]

FlowConnectionTypeDef

name

  • Type:
  • Required: Yes

source

  • Type:
  • Required: Yes

target

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Conditional', 'Data']
  • Required: Yes

configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowConnectionConfigurationTypeDef]

FlowDataConnectionConfigurationTypeDef

sourceOutput

  • Type:
  • Required: Yes

targetInput

  • Type:
  • Required: Yes

FlowDefinitionOutputTypeDef

connections

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowConnectionTypeDef]]

nodes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeExtraOutputTypeDef]]

FlowDefinitionTypeDef

connections

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowConnectionTypeDef]]

nodes

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeTypeDef]]

FlowNodeConfigurationOutputTypeDef

agent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentFlowNodeConfigurationTypeDef]

collector

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

condition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ConditionFlowNodeConfigurationOutputTypeDef]

input

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

iterator

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

knowledgeBase

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.KnowledgeBaseFlowNodeConfigurationTypeDef]

lambdaFunction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.LambdaFunctionFlowNodeConfigurationTypeDef]

lex

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.LexFlowNodeConfigurationTypeDef]

output

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

prompt

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptFlowNodeConfigurationOutputTypeDef]

retrieval

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.RetrievalFlowNodeConfigurationTypeDef]

storage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.StorageFlowNodeConfigurationTypeDef]

FlowNodeConfigurationTypeDef

agent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentFlowNodeConfigurationTypeDef]

collector

  • Type: typing.Optional[typing.Mapping[str, typing.Any]]

condition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ConditionFlowNodeConfigurationTypeDef]

input

  • Type: typing.Optional[typing.Mapping[str, typing.Any]]

iterator

  • Type: typing.Optional[typing.Mapping[str, typing.Any]]

knowledgeBase

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.KnowledgeBaseFlowNodeConfigurationTypeDef]

lambdaFunction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.LambdaFunctionFlowNodeConfigurationTypeDef]

lex

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.LexFlowNodeConfigurationTypeDef]

output

  • Type: typing.Optional[typing.Mapping[str, typing.Any]]

prompt

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptFlowNodeConfigurationTypeDef]

retrieval

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.RetrievalFlowNodeConfigurationTypeDef]

storage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.StorageFlowNodeConfigurationTypeDef]

FlowNodeExtraOutputTypeDef

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Agent', 'Collector', 'Condition', 'Input', 'Iterator', 'KnowledgeBase', 'LambdaFunction', 'Lex', 'Output', 'Prompt', 'Retrieval', 'Storage']
  • Required: Yes

configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeConfigurationOutputTypeDef]

inputs

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeInputTypeDef]]

outputs

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeOutputTypeDef]]

FlowNodeInputTypeDef

expression

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Array', 'Boolean', 'Number', 'Object', 'String']
  • Required: Yes

FlowNodeOutputTypeDef

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Array', 'Boolean', 'Number', 'Object', 'String']
  • Required: Yes

FlowNodeTypeDef

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['Agent', 'Collector', 'Condition', 'Input', 'Iterator', 'KnowledgeBase', 'LambdaFunction', 'Lex', 'Output', 'Prompt', 'Retrieval', 'Storage']
  • Required: Yes

configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeConfigurationTypeDef]

inputs

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeInputTypeDef]]

outputs

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowNodeOutputTypeDef]]

FlowSummaryTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

FlowValidationTypeDef

message

  • Type:
  • Required: Yes

severity

  • Type: typing.Literal['Error', 'Warning']
  • Required: Yes

FlowVersionSummaryTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

version

  • Type:
  • Required: Yes

FunctionOutputTypeDef

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

parameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.bedrock_agent_classes.ParameterDetailTypeDef]]

FunctionSchemaOutputTypeDef

functions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FunctionOutputTypeDef]]

FunctionSchemaTypeDef

functions

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FunctionTypeDef]]

FunctionTypeDef

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

parameters

  • Type: typing.Optional[typing.Mapping[str, aws_resource_validator.pydantic_models.bedrock_agent_classes.ParameterDetailTypeDef]]

GetAgentActionGroupRequestRequestTypeDef

actionGroupId

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

GetAgentActionGroupResponseTypeDef

agentActionGroup

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAgentAliasRequestRequestTypeDef

agentAliasId

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

GetAgentAliasResponseTypeDef

agentAlias

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAgentKnowledgeBaseRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetAgentKnowledgeBaseResponseTypeDef

agentKnowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAgentRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

GetAgentResponseTypeDef

agent

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAgentVersionRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

GetAgentVersionResponseTypeDef

agentVersion

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataSourceRequestRequestTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetDataSourceResponseTypeDef

dataSource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFlowAliasRequestRequestTypeDef

aliasIdentifier

  • Type:
  • Required: Yes

flowIdentifier

  • Type:
  • Required: Yes

GetFlowAliasResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

flowId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFlowRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

GetFlowResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

validations

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowValidationTypeDef]
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFlowVersionRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

flowVersion

  • Type:
  • Required: Yes

GetFlowVersionResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIngestionJobRequestRequestTypeDef

dataSourceId

  • Type:
  • Required: Yes

ingestionJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetIngestionJobResponseTypeDef

ingestionJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKnowledgeBaseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

GetKnowledgeBaseResponseTypeDef

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPromptRequestRequestTypeDef

promptIdentifier

  • Type:
  • Required: Yes

promptVersion

  • Type: typing.Optional[str]

GetPromptResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

defaultVariant

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

variants

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantOutputTypeDef]
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GuardrailConfigurationTypeDef

guardrailIdentifier

  • Type: typing.Optional[str]

guardrailVersion

  • Type: typing.Optional[str]

HierarchicalChunkingConfigurationOutputTypeDef

levelConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.HierarchicalChunkingLevelConfigurationTypeDef]
  • Required: Yes

overlapTokens

  • Type:
  • Required: Yes

HierarchicalChunkingConfigurationTypeDef

levelConfigurations

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.HierarchicalChunkingLevelConfigurationTypeDef]
  • Required: Yes

overlapTokens

  • Type:
  • Required: Yes

HierarchicalChunkingLevelConfigurationTypeDef

maxTokens

  • Type:
  • Required: Yes

InferenceConfigurationOutputTypeDef

maximumLength

  • Type: typing.Optional[int]

stopSequences

  • Type: typing.Optional[typing.List[str]]

temperature

  • Type: typing.Optional[float]

topK

  • Type: typing.Optional[int]

topP

  • Type: typing.Optional[float]

InferenceConfigurationTypeDef

maximumLength

  • Type: typing.Optional[int]

stopSequences

  • Type: typing.Optional[typing.Sequence[str]]

temperature

  • Type: typing.Optional[float]

topK

  • Type: typing.Optional[int]

topP

  • Type: typing.Optional[float]

IngestionJobFilterTypeDef

attribute

  • Type: typing.Literal['STATUS']
  • Required: Yes

operator

  • Type: typing.Literal['EQ']
  • Required: Yes

values

  • Type: typing.Sequence[str]
  • Required: Yes

IngestionJobSortByTypeDef

attribute

  • Type: typing.Literal['STARTED_AT', 'STATUS']
  • Required: Yes

order

  • Type: typing.Literal['ASCENDING', 'DESCENDING']
  • Required: Yes

IngestionJobStatisticsTypeDef

numberOfDocumentsDeleted

  • Type: typing.Optional[int]

numberOfDocumentsFailed

  • Type: typing.Optional[int]

numberOfDocumentsScanned

  • Type: typing.Optional[int]

numberOfMetadataDocumentsModified

  • Type: typing.Optional[int]

numberOfMetadataDocumentsScanned

  • Type: typing.Optional[int]

numberOfModifiedDocumentsIndexed

  • Type: typing.Optional[int]

numberOfNewDocumentsIndexed

  • Type: typing.Optional[int]

IngestionJobSummaryTypeDef

dataSourceId

  • Type:
  • Required: Yes

ingestionJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

startedAt

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETE', 'FAILED', 'IN_PROGRESS', 'STARTING']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

statistics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobStatisticsTypeDef]

IngestionJobTypeDef

dataSourceId

  • Type:
  • Required: Yes

ingestionJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

startedAt

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETE', 'FAILED', 'IN_PROGRESS', 'STARTING']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

failureReasons

  • Type: typing.Optional[typing.List[str]]

statistics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobStatisticsTypeDef]

IntermediateStorageTypeDef

s3Location

  • Type:
  • Required: Yes

KnowledgeBaseConfigurationTypeDef

type

  • Type: typing.Literal['VECTOR']
  • Required: Yes

vectorKnowledgeBaseConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.VectorKnowledgeBaseConfigurationTypeDef]

KnowledgeBaseFlowNodeConfigurationTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

modelId

  • Type: typing.Optional[str]

KnowledgeBaseSummaryTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETE_UNSUCCESSFUL', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

KnowledgeBaseTypeDef

createdAt

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseConfiguration

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETE_UNSUCCESSFUL', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

storageConfiguration

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

failureReasons

  • Type: typing.Optional[typing.List[str]]

LambdaFunctionFlowNodeConfigurationTypeDef

lambdaArn

  • Type:
  • Required: Yes

LexFlowNodeConfigurationTypeDef

botAliasArn

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListAgentActionGroupsRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAgentActionGroupsResponseTypeDef

actionGroupSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.ActionGroupSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAgentAliasesRequestListAgentAliasesPaginateTypeDef

agentId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListAgentAliasesRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAgentAliasesResponseTypeDef

agentAliasSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListAgentKnowledgeBasesRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAgentKnowledgeBasesResponseTypeDef

agentKnowledgeBaseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentKnowledgeBaseSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAgentVersionsRequestListAgentVersionsPaginateTypeDef

agentId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListAgentVersionsRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAgentVersionsResponseTypeDef

agentVersionSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentVersionSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAgentsRequestListAgentsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListAgentsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAgentsResponseTypeDef

agentSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDataSourcesRequestListDataSourcesPaginateTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListDataSourcesRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListDataSourcesResponseTypeDef

dataSourceSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.DataSourceSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListFlowAliasesRequestListFlowAliasesPaginateTypeDef

flowIdentifier

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListFlowAliasesRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListFlowAliasesResponseTypeDef

flowAliasSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListFlowVersionsRequestListFlowVersionsPaginateTypeDef

flowIdentifier

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListFlowVersionsRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListFlowVersionsResponseTypeDef

flowVersionSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowVersionSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListFlowsRequestListFlowsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListFlowsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListFlowsResponseTypeDef

flowSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListIngestionJobsRequestListIngestionJobsPaginateTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobFilterTypeDef]]

sortBy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobSortByTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListIngestionJobsRequestRequestTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobFilterTypeDef]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

sortBy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobSortByTypeDef]

ListIngestionJobsResponseTypeDef

ingestionJobSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.IngestionJobSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListKnowledgeBasesRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListKnowledgeBasesResponseTypeDef

knowledgeBaseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.KnowledgeBaseSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListPromptsRequestListPromptsPaginateTypeDef

promptIdentifier

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PaginatorConfigTypeDef]

ListPromptsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

promptIdentifier

  • Type: typing.Optional[str]

ListPromptsResponseTypeDef

nextToken

  • Type:
  • Required: Yes

promptSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MemoryConfigurationOutputTypeDef

enabledMemoryTypes

  • Type: typing.List[typing.Literal['SESSION_SUMMARY']]
  • Required: Yes

storageDays

  • Type: typing.Optional[int]

MemoryConfigurationTypeDef

enabledMemoryTypes

  • Type: typing.Sequence[typing.Literal['SESSION_SUMMARY']]
  • Required: Yes

storageDays

  • Type: typing.Optional[int]

MongoDbAtlasConfigurationTypeDef

collectionName

  • Type:
  • Required: Yes

credentialsSecretArn

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

endpoint

  • Type:
  • Required: Yes

fieldMapping

  • Type:
  • Required: Yes

vectorIndexName

  • Type:
  • Required: Yes

endpointServiceName

  • Type: typing.Optional[str]

MongoDbAtlasFieldMappingTypeDef

metadataField

  • Type:
  • Required: Yes

textField

  • Type:
  • Required: Yes

vectorField

  • Type:
  • Required: Yes

OpenSearchServerlessConfigurationTypeDef

collectionArn

  • Type:
  • Required: Yes

fieldMapping

  • Type:
  • Required: Yes

vectorIndexName

  • Type:
  • Required: Yes

OpenSearchServerlessFieldMappingTypeDef

metadataField

  • Type:
  • Required: Yes

textField

  • Type:
  • Required: Yes

vectorField

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ParameterDetailTypeDef

type

  • Type: typing.Literal['array', 'boolean', 'integer', 'number', 'string']
  • Required: Yes

description

  • Type: typing.Optional[str]

required

  • Type: typing.Optional[bool]

ParsingConfigurationTypeDef

parsingStrategy

  • Type: typing.Literal['BEDROCK_FOUNDATION_MODEL']
  • Required: Yes

bedrockFoundationModelConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.BedrockFoundationModelConfigurationTypeDef]

ParsingPromptTypeDef

parsingPromptText

  • Type:
  • Required: Yes

PatternObjectFilterConfigurationOutputTypeDef

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PatternObjectFilterOutputTypeDef]
  • Required: Yes

PatternObjectFilterConfigurationTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.PatternObjectFilterTypeDef]
  • Required: Yes

PatternObjectFilterOutputTypeDef

objectType

  • Type:
  • Required: Yes

exclusionFilters

  • Type: typing.Optional[typing.List[str]]

inclusionFilters

  • Type: typing.Optional[typing.List[str]]

PatternObjectFilterTypeDef

objectType

  • Type:
  • Required: Yes

exclusionFilters

  • Type: typing.Optional[typing.Sequence[str]]

inclusionFilters

  • Type: typing.Optional[typing.Sequence[str]]

PineconeConfigurationTypeDef

connectionString

  • Type:
  • Required: Yes

credentialsSecretArn

  • Type:
  • Required: Yes

fieldMapping

  • Type:
  • Required: Yes

namespace

  • Type: typing.Optional[str]

PineconeFieldMappingTypeDef

metadataField

  • Type:
  • Required: Yes

textField

  • Type:
  • Required: Yes

PrepareAgentRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

PrepareAgentResponseTypeDef

agentId

  • Type:
  • Required: Yes

agentStatus

  • Type: typing.Literal['CREATING', 'DELETING', 'FAILED', 'NOT_PREPARED', 'PREPARED', 'PREPARING', 'UPDATING', 'VERSIONING']
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

preparedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PrepareFlowRequestRequestTypeDef

flowIdentifier

  • Type:
  • Required: Yes

PrepareFlowResponseTypeDef

id

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PromptConfigurationOutputTypeDef

basePromptTemplate

  • Type: typing.Optional[str]

inferenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.InferenceConfigurationOutputTypeDef]

parserMode

  • Type: typing.Optional[typing.Literal['DEFAULT', 'OVERRIDDEN']]

promptCreationMode

  • Type: typing.Optional[typing.Literal['DEFAULT', 'OVERRIDDEN']]

promptState

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

promptType

  • Type: typing.Optional[typing.Literal['KNOWLEDGE_BASE_RESPONSE_GENERATION', 'ORCHESTRATION', 'POST_PROCESSING', 'PRE_PROCESSING']]

PromptConfigurationTypeDef

basePromptTemplate

  • Type: typing.Optional[str]

inferenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.InferenceConfigurationTypeDef]

parserMode

  • Type: typing.Optional[typing.Literal['DEFAULT', 'OVERRIDDEN']]

promptCreationMode

  • Type: typing.Optional[typing.Literal['DEFAULT', 'OVERRIDDEN']]

promptState

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

promptType

  • Type: typing.Optional[typing.Literal['KNOWLEDGE_BASE_RESPONSE_GENERATION', 'ORCHESTRATION', 'POST_PROCESSING', 'PRE_PROCESSING']]

PromptFlowNodeConfigurationOutputTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

PromptFlowNodeConfigurationTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

PromptFlowNodeInlineConfigurationOutputTypeDef

modelId

  • Type:
  • Required: Yes

templateConfiguration

  • Type:
  • Required: Yes

templateType

  • Type: typing.Literal['TEXT']
  • Required: Yes

inferenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptInferenceConfigurationOutputTypeDef]

PromptFlowNodeInlineConfigurationTypeDef

modelId

  • Type:
  • Required: Yes

templateConfiguration

  • Type:
  • Required: Yes

templateType

  • Type: typing.Literal['TEXT']
  • Required: Yes

inferenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptInferenceConfigurationTypeDef]

PromptFlowNodeResourceConfigurationTypeDef

promptArn

  • Type:
  • Required: Yes

PromptFlowNodeSourceConfigurationOutputTypeDef

inline

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptFlowNodeInlineConfigurationOutputTypeDef]

resource

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptFlowNodeResourceConfigurationTypeDef]

PromptFlowNodeSourceConfigurationTypeDef

inline

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptFlowNodeInlineConfigurationTypeDef]

resource

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptFlowNodeResourceConfigurationTypeDef]

PromptInferenceConfigurationOutputTypeDef

text

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptModelInferenceConfigurationOutputTypeDef]

PromptInferenceConfigurationTypeDef

text

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptModelInferenceConfigurationTypeDef]

PromptInputVariableTypeDef

name

  • Type: typing.Optional[str]

PromptModelInferenceConfigurationOutputTypeDef

maxTokens

  • Type: typing.Optional[int]

stopSequences

  • Type: typing.Optional[typing.List[str]]

temperature

  • Type: typing.Optional[float]

topK

  • Type: typing.Optional[int]

topP

  • Type: typing.Optional[float]

PromptModelInferenceConfigurationTypeDef

maxTokens

  • Type: typing.Optional[int]

stopSequences

  • Type: typing.Optional[typing.Sequence[str]]

temperature

  • Type: typing.Optional[float]

topK

  • Type: typing.Optional[int]

topP

  • Type: typing.Optional[float]

PromptOverrideConfigurationOutputTypeDef

promptConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptConfigurationOutputTypeDef]
  • Required: Yes

overrideLambda

  • Type: typing.Optional[str]

PromptOverrideConfigurationTypeDef

promptConfigurations

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptConfigurationTypeDef]
  • Required: Yes

overrideLambda

  • Type: typing.Optional[str]

PromptSummaryTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

PromptTemplateConfigurationOutputTypeDef

text

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.TextPromptTemplateConfigurationOutputTypeDef]

PromptTemplateConfigurationTypeDef

text

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.TextPromptTemplateConfigurationTypeDef]

PromptVariantOutputTypeDef

name

  • Type:
  • Required: Yes

templateType

  • Type: typing.Literal['TEXT']
  • Required: Yes

inferenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptInferenceConfigurationOutputTypeDef]

modelId

  • Type: typing.Optional[str]

templateConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptTemplateConfigurationOutputTypeDef]

PromptVariantTypeDef

name

  • Type:
  • Required: Yes

templateType

  • Type: typing.Literal['TEXT']
  • Required: Yes

inferenceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptInferenceConfigurationTypeDef]

modelId

  • Type: typing.Optional[str]

templateConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptTemplateConfigurationTypeDef]

RdsConfigurationTypeDef

credentialsSecretArn

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

fieldMapping

  • Type:
  • Required: Yes

resourceArn

  • Type:
  • Required: Yes

tableName

  • Type:
  • Required: Yes

RdsFieldMappingTypeDef

metadataField

  • Type:
  • Required: Yes

primaryKeyField

  • Type:
  • Required: Yes

textField

  • Type:
  • Required: Yes

vectorField

  • Type:
  • Required: Yes

RedisEnterpriseCloudConfigurationTypeDef

credentialsSecretArn

  • Type:
  • Required: Yes

endpoint

  • Type:
  • Required: Yes

fieldMapping

  • Type:
  • Required: Yes

vectorIndexName

  • Type:
  • Required: Yes

RedisEnterpriseCloudFieldMappingTypeDef

metadataField

  • Type:
  • Required: Yes

textField

  • Type:
  • Required: Yes

vectorField

  • Type:
  • Required: Yes

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RetrievalFlowNodeConfigurationTypeDef

serviceConfiguration

  • Type:
  • Required: Yes

RetrievalFlowNodeS3ConfigurationTypeDef

bucketName

  • Type:
  • Required: Yes

RetrievalFlowNodeServiceConfigurationTypeDef

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.RetrievalFlowNodeS3ConfigurationTypeDef]

S3DataSourceConfigurationOutputTypeDef

bucketArn

  • Type:
  • Required: Yes

bucketOwnerAccountId

  • Type: typing.Optional[str]

inclusionPrefixes

  • Type: typing.Optional[typing.List[str]]

S3DataSourceConfigurationTypeDef

bucketArn

  • Type:
  • Required: Yes

bucketOwnerAccountId

  • Type: typing.Optional[str]

inclusionPrefixes

  • Type: typing.Optional[typing.Sequence[str]]

S3IdentifierTypeDef

s3BucketName

  • Type: typing.Optional[str]

s3ObjectKey

  • Type: typing.Optional[str]

S3LocationTypeDef

uri

  • Type:
  • Required: Yes

SalesforceCrawlerConfigurationOutputTypeDef

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CrawlFilterConfigurationOutputTypeDef]

SalesforceCrawlerConfigurationTypeDef

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CrawlFilterConfigurationTypeDef]

SalesforceDataSourceConfigurationOutputTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SalesforceCrawlerConfigurationOutputTypeDef]

SalesforceDataSourceConfigurationTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SalesforceCrawlerConfigurationTypeDef]

SalesforceSourceConfigurationTypeDef

authType

  • Type: typing.Literal['OAUTH2_CLIENT_CREDENTIALS']
  • Required: Yes

credentialsSecretArn

  • Type:
  • Required: Yes

hostUrl

  • Type:
  • Required: Yes

SeedUrlTypeDef

url

  • Type: typing.Optional[str]

SemanticChunkingConfigurationTypeDef

breakpointPercentileThreshold

  • Type:
  • Required: Yes

bufferSize

  • Type:
  • Required: Yes

maxTokens

  • Type:
  • Required: Yes

ServerSideEncryptionConfigurationTypeDef

kmsKeyArn

  • Type: typing.Optional[str]

SharePointCrawlerConfigurationOutputTypeDef

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CrawlFilterConfigurationOutputTypeDef]

SharePointCrawlerConfigurationTypeDef

filterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CrawlFilterConfigurationTypeDef]

SharePointDataSourceConfigurationOutputTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SharePointCrawlerConfigurationOutputTypeDef]

SharePointDataSourceConfigurationTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.SharePointCrawlerConfigurationTypeDef]

SharePointSourceConfigurationOutputTypeDef

authType

  • Type: typing.Literal['OAUTH2_CLIENT_CREDENTIALS']
  • Required: Yes

credentialsSecretArn

  • Type:
  • Required: Yes

domain

  • Type:
  • Required: Yes

hostType

  • Type: typing.Literal['ONLINE']
  • Required: Yes

siteUrls

  • Type: typing.List[str]
  • Required: Yes

tenantId

  • Type: typing.Optional[str]

SharePointSourceConfigurationTypeDef

authType

  • Type: typing.Literal['OAUTH2_CLIENT_CREDENTIALS']
  • Required: Yes

credentialsSecretArn

  • Type:
  • Required: Yes

domain

  • Type:
  • Required: Yes

hostType

  • Type: typing.Literal['ONLINE']
  • Required: Yes

siteUrls

  • Type: typing.Sequence[str]
  • Required: Yes

tenantId

  • Type: typing.Optional[str]

StartIngestionJobRequestRequestTypeDef

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

StartIngestionJobResponseTypeDef

ingestionJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StorageConfigurationTypeDef

type

  • Type: typing.Literal['MONGO_DB_ATLAS', 'OPENSEARCH_SERVERLESS', 'PINECONE', 'RDS', 'REDIS_ENTERPRISE_CLOUD']
  • Required: Yes

mongoDbAtlasConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.MongoDbAtlasConfigurationTypeDef]

opensearchServerlessConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.OpenSearchServerlessConfigurationTypeDef]

pineconeConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PineconeConfigurationTypeDef]

rdsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.RdsConfigurationTypeDef]

redisEnterpriseCloudConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.RedisEnterpriseCloudConfigurationTypeDef]

StorageFlowNodeConfigurationTypeDef

serviceConfiguration

  • Type:
  • Required: Yes

StorageFlowNodeS3ConfigurationTypeDef

bucketName

  • Type:
  • Required: Yes

StorageFlowNodeServiceConfigurationTypeDef

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.StorageFlowNodeS3ConfigurationTypeDef]

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

TextPromptTemplateConfigurationOutputTypeDef

text

  • Type:
  • Required: Yes

inputVariables

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptInputVariableTypeDef]]

TextPromptTemplateConfigurationTypeDef

text

  • Type:
  • Required: Yes

inputVariables

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptInputVariableTypeDef]]

TransformationFunctionTypeDef

transformationLambdaConfiguration

  • Type:
  • Required: Yes

TransformationLambdaConfigurationTypeDef

lambdaArn

  • Type:
  • Required: Yes

TransformationTypeDef

stepToApply

  • Type: typing.Literal['POST_CHUNKING']
  • Required: Yes

transformationFunction

  • Type:
  • Required: Yes

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateAgentActionGroupRequestRequestTypeDef

actionGroupId

  • Type:
  • Required: Yes

actionGroupName

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

actionGroupExecutor

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ActionGroupExecutorTypeDef]

actionGroupState

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

apiSchema

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.APISchemaTypeDef]

description

  • Type: typing.Optional[str]

functionSchema

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FunctionSchemaTypeDef]

parentActionGroupSignature

  • Type: typing.Optional[typing.Literal['AMAZON.CodeInterpreter', 'AMAZON.UserInput']]

UpdateAgentActionGroupResponseTypeDef

agentActionGroup

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAgentAliasRequestRequestTypeDef

agentAliasId

  • Type:
  • Required: Yes

agentAliasName

  • Type:
  • Required: Yes

agentId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

routingConfiguration

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.AgentAliasRoutingConfigurationListItemTypeDef]]

UpdateAgentAliasResponseTypeDef

agentAlias

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAgentKnowledgeBaseRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentVersion

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

knowledgeBaseState

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

UpdateAgentKnowledgeBaseResponseTypeDef

agentKnowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAgentRequestRequestTypeDef

agentId

  • Type:
  • Required: Yes

agentName

  • Type:
  • Required: Yes

agentResourceRoleArn

  • Type:
  • Required: Yes

foundationModel

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

guardrailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.GuardrailConfigurationTypeDef]

idleSessionTTLInSeconds

  • Type: typing.Optional[int]

instruction

  • Type: typing.Optional[str]

memoryConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.MemoryConfigurationTypeDef]

promptOverrideConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptOverrideConfigurationTypeDef]

UpdateAgentResponseTypeDef

agent

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDataSourceRequestRequestTypeDef

dataSourceConfiguration

  • Type:
  • Required: Yes

dataSourceId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

dataDeletionPolicy

  • Type: typing.Optional[typing.Literal['DELETE', 'RETAIN']]

description

  • Type: typing.Optional[str]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ServerSideEncryptionConfigurationTypeDef]

vectorIngestionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.VectorIngestionConfigurationTypeDef]

UpdateDataSourceResponseTypeDef

dataSource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateFlowAliasRequestRequestTypeDef

aliasIdentifier

  • Type:
  • Required: Yes

flowIdentifier

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

description

  • Type: typing.Optional[str]

UpdateFlowAliasResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

flowId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

routingConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowAliasRoutingConfigurationListItemTypeDef]
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateFlowRequestRequestTypeDef

executionRoleArn

  • Type:
  • Required: Yes

flowIdentifier

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type: typing.Optional[str]

definition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.FlowDefinitionTypeDef]

description

  • Type: typing.Optional[str]

UpdateFlowResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Failed', 'NotPrepared', 'Prepared', 'Preparing']
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKnowledgeBaseRequestRequestTypeDef

knowledgeBaseConfiguration

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

storageConfiguration

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

UpdateKnowledgeBaseResponseTypeDef

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdatePromptRequestRequestTypeDef

name

  • Type:
  • Required: Yes

promptIdentifier

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type: typing.Optional[str]

defaultVariant

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

variants

  • Type: typing.Optional[typing.Sequence[typing.Union[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantTypeDef, aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantOutputTypeDef]]]

UpdatePromptResponseTypeDef

arn

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

customerEncryptionKeyArn

  • Type:
  • Required: Yes

defaultVariant

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

variants

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.PromptVariantOutputTypeDef]
  • Required: Yes

version

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UrlConfigurationOutputTypeDef

seedUrls

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_agent_classes.SeedUrlTypeDef]]

UrlConfigurationTypeDef

seedUrls

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.bedrock_agent_classes.SeedUrlTypeDef]]

VectorIngestionConfigurationOutputTypeDef

chunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ChunkingConfigurationOutputTypeDef]

customTransformationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CustomTransformationConfigurationOutputTypeDef]

parsingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ParsingConfigurationTypeDef]

VectorIngestionConfigurationTypeDef

chunkingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ChunkingConfigurationTypeDef]

customTransformationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.CustomTransformationConfigurationTypeDef]

parsingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.ParsingConfigurationTypeDef]

VectorKnowledgeBaseConfigurationTypeDef

embeddingModelArn

  • Type:
  • Required: Yes

embeddingModelConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.EmbeddingModelConfigurationTypeDef]

WebCrawlerConfigurationOutputTypeDef

crawlerLimits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.WebCrawlerLimitsTypeDef]

exclusionFilters

  • Type: typing.Optional[typing.List[str]]

inclusionFilters

  • Type: typing.Optional[typing.List[str]]

scope

  • Type: typing.Optional[typing.Literal['HOST_ONLY', 'SUBDOMAINS']]

WebCrawlerConfigurationTypeDef

crawlerLimits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.WebCrawlerLimitsTypeDef]

exclusionFilters

  • Type: typing.Optional[typing.Sequence[str]]

inclusionFilters

  • Type: typing.Optional[typing.Sequence[str]]

scope

  • Type: typing.Optional[typing.Literal['HOST_ONLY', 'SUBDOMAINS']]

WebCrawlerLimitsTypeDef

rateLimit

  • Type: typing.Optional[int]

WebDataSourceConfigurationOutputTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.WebCrawlerConfigurationOutputTypeDef]

WebDataSourceConfigurationTypeDef

sourceConfiguration

  • Type:
  • Required: Yes

crawlerConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_agent_classes.WebCrawlerConfigurationTypeDef]

WebSourceConfigurationOutputTypeDef

urlConfiguration

  • Type:
  • Required: Yes

WebSourceConfigurationTypeDef

urlConfiguration

  • Type:
  • Required: Yes