Skip to content

Type definitions#

Index > AgentsforBedrock > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

PromptModelInferenceConfigurationUnionTypeDef#

# PromptModelInferenceConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import PromptModelInferenceConfigurationUnionTypeDef


def get_value() -> PromptModelInferenceConfigurationUnionTypeDef:
    return ...


# PromptModelInferenceConfigurationUnionTypeDef definition

PromptModelInferenceConfigurationUnionTypeDef = Union[
    PromptModelInferenceConfigurationTypeDef,  # (1)
    PromptModelInferenceConfigurationOutputTypeDef,  # (2)
]
  1. See PromptModelInferenceConfigurationTypeDef
  2. See PromptModelInferenceConfigurationOutputTypeDef

ToolInputSchemaUnionTypeDef#

# ToolInputSchemaUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import ToolInputSchemaUnionTypeDef


def get_value() -> ToolInputSchemaUnionTypeDef:
    return ...


# ToolInputSchemaUnionTypeDef definition

ToolInputSchemaUnionTypeDef = Union[
    ToolInputSchemaTypeDef,  # (1)
    ToolInputSchemaOutputTypeDef,  # (2)
]
  1. See ToolInputSchemaTypeDef
  2. See ToolInputSchemaOutputTypeDef

TextPromptTemplateConfigurationUnionTypeDef#

# TextPromptTemplateConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import TextPromptTemplateConfigurationUnionTypeDef


def get_value() -> TextPromptTemplateConfigurationUnionTypeDef:
    return ...


# TextPromptTemplateConfigurationUnionTypeDef definition

TextPromptTemplateConfigurationUnionTypeDef = Union[
    TextPromptTemplateConfigurationTypeDef,  # (1)
    TextPromptTemplateConfigurationOutputTypeDef,  # (2)
]
  1. See TextPromptTemplateConfigurationTypeDef
  2. See TextPromptTemplateConfigurationOutputTypeDef

MemoryConfigurationUnionTypeDef#

# MemoryConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import MemoryConfigurationUnionTypeDef


def get_value() -> MemoryConfigurationUnionTypeDef:
    return ...


# MemoryConfigurationUnionTypeDef definition

MemoryConfigurationUnionTypeDef = Union[
    MemoryConfigurationTypeDef,  # (1)
    MemoryConfigurationOutputTypeDef,  # (2)
]
  1. See MemoryConfigurationTypeDef
  2. See MemoryConfigurationOutputTypeDef

ToolChoiceUnionTypeDef#

# ToolChoiceUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import ToolChoiceUnionTypeDef


def get_value() -> ToolChoiceUnionTypeDef:
    return ...


# ToolChoiceUnionTypeDef definition

ToolChoiceUnionTypeDef = Union[
    ToolChoiceTypeDef,  # (1)
    ToolChoiceOutputTypeDef,  # (2)
]
  1. See ToolChoiceTypeDef
  2. See ToolChoiceOutputTypeDef

MessageUnionTypeDef#

# MessageUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import MessageUnionTypeDef


def get_value() -> MessageUnionTypeDef:
    return ...


# MessageUnionTypeDef definition

MessageUnionTypeDef = Union[
    MessageTypeDef,  # (1)
    MessageOutputTypeDef,  # (2)
]
  1. See MessageTypeDef
  2. See MessageOutputTypeDef

FunctionSchemaUnionTypeDef#

# FunctionSchemaUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import FunctionSchemaUnionTypeDef


def get_value() -> FunctionSchemaUnionTypeDef:
    return ...


# FunctionSchemaUnionTypeDef definition

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

PromptOverrideConfigurationUnionTypeDef#

# PromptOverrideConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import PromptOverrideConfigurationUnionTypeDef


def get_value() -> PromptOverrideConfigurationUnionTypeDef:
    return ...


# PromptOverrideConfigurationUnionTypeDef definition

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

PromptInferenceConfigurationUnionTypeDef#

# PromptInferenceConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import PromptInferenceConfigurationUnionTypeDef


def get_value() -> PromptInferenceConfigurationUnionTypeDef:
    return ...


# PromptInferenceConfigurationUnionTypeDef definition

PromptInferenceConfigurationUnionTypeDef = Union[
    PromptInferenceConfigurationTypeDef,  # (1)
    PromptInferenceConfigurationOutputTypeDef,  # (2)
]
  1. See PromptInferenceConfigurationTypeDef
  2. See PromptInferenceConfigurationOutputTypeDef

ToolSpecificationUnionTypeDef#

# ToolSpecificationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import ToolSpecificationUnionTypeDef


def get_value() -> ToolSpecificationUnionTypeDef:
    return ...


# ToolSpecificationUnionTypeDef definition

ToolSpecificationUnionTypeDef = Union[
    ToolSpecificationTypeDef,  # (1)
    ToolSpecificationOutputTypeDef,  # (2)
]
  1. See ToolSpecificationTypeDef
  2. See ToolSpecificationOutputTypeDef

ToolUnionTypeDef#

# ToolUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import ToolUnionTypeDef


def get_value() -> ToolUnionTypeDef:
    return ...


# ToolUnionTypeDef definition

ToolUnionTypeDef = Union[
    ToolTypeDef,  # (1)
    ToolOutputTypeDef,  # (2)
]
  1. See ToolTypeDef
  2. See ToolOutputTypeDef

VectorIngestionConfigurationUnionTypeDef#

# VectorIngestionConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import VectorIngestionConfigurationUnionTypeDef


def get_value() -> VectorIngestionConfigurationUnionTypeDef:
    return ...


# VectorIngestionConfigurationUnionTypeDef definition

VectorIngestionConfigurationUnionTypeDef = Union[
    VectorIngestionConfigurationTypeDef,  # (1)
    VectorIngestionConfigurationOutputTypeDef,  # (2)
]
  1. See VectorIngestionConfigurationTypeDef
  2. See VectorIngestionConfigurationOutputTypeDef

DataSourceConfigurationUnionTypeDef#

# DataSourceConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import DataSourceConfigurationUnionTypeDef


def get_value() -> DataSourceConfigurationUnionTypeDef:
    return ...


# DataSourceConfigurationUnionTypeDef definition

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

KnowledgeBaseConfigurationUnionTypeDef#

# KnowledgeBaseConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseConfigurationUnionTypeDef


def get_value() -> KnowledgeBaseConfigurationUnionTypeDef:
    return ...


# KnowledgeBaseConfigurationUnionTypeDef definition

KnowledgeBaseConfigurationUnionTypeDef = Union[
    KnowledgeBaseConfigurationTypeDef,  # (1)
    KnowledgeBaseConfigurationOutputTypeDef,  # (2)
]
  1. See KnowledgeBaseConfigurationTypeDef
  2. See KnowledgeBaseConfigurationOutputTypeDef

ToolConfigurationUnionTypeDef#

# ToolConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import ToolConfigurationUnionTypeDef


def get_value() -> ToolConfigurationUnionTypeDef:
    return ...


# ToolConfigurationUnionTypeDef definition

ToolConfigurationUnionTypeDef = Union[
    ToolConfigurationTypeDef,  # (1)
    ToolConfigurationOutputTypeDef,  # (2)
]
  1. See ToolConfigurationTypeDef
  2. See ToolConfigurationOutputTypeDef

ChatPromptTemplateConfigurationUnionTypeDef#

# ChatPromptTemplateConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import ChatPromptTemplateConfigurationUnionTypeDef


def get_value() -> ChatPromptTemplateConfigurationUnionTypeDef:
    return ...


# ChatPromptTemplateConfigurationUnionTypeDef definition

ChatPromptTemplateConfigurationUnionTypeDef = Union[
    ChatPromptTemplateConfigurationTypeDef,  # (1)
    ChatPromptTemplateConfigurationOutputTypeDef,  # (2)
]
  1. See ChatPromptTemplateConfigurationTypeDef
  2. See ChatPromptTemplateConfigurationOutputTypeDef

PromptTemplateConfigurationUnionTypeDef#

# PromptTemplateConfigurationUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import PromptTemplateConfigurationUnionTypeDef


def get_value() -> PromptTemplateConfigurationUnionTypeDef:
    return ...


# PromptTemplateConfigurationUnionTypeDef definition

PromptTemplateConfigurationUnionTypeDef = Union[
    PromptTemplateConfigurationTypeDef,  # (1)
    PromptTemplateConfigurationOutputTypeDef,  # (2)
]
  1. See PromptTemplateConfigurationTypeDef
  2. See PromptTemplateConfigurationOutputTypeDef

PromptVariantUnionTypeDef#

# PromptVariantUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import PromptVariantUnionTypeDef


def get_value() -> PromptVariantUnionTypeDef:
    return ...


# PromptVariantUnionTypeDef definition

PromptVariantUnionTypeDef = Union[
    PromptVariantTypeDef,  # (1)
    PromptVariantOutputTypeDef,  # (2)
]
  1. See PromptVariantTypeDef
  2. See PromptVariantOutputTypeDef

FlowDefinitionUnionTypeDef#

# FlowDefinitionUnionTypeDef Union usage example

from mypy_boto3_bedrock_agent.type_defs import FlowDefinitionUnionTypeDef


def get_value() -> FlowDefinitionUnionTypeDef:
    return ...


# FlowDefinitionUnionTypeDef definition

FlowDefinitionUnionTypeDef = Union[
    FlowDefinitionTypeDef,  # (1)
    FlowDefinitionOutputTypeDef,  # (2)
]
  1. See FlowDefinitionTypeDef
  2. See FlowDefinitionOutputTypeDef

S3IdentifierTypeDef#

# S3IdentifierTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import S3IdentifierTypeDef


def get_value() -> S3IdentifierTypeDef:
    return {
        "s3BucketName": ...,
    }


# S3IdentifierTypeDef definition

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

ActionGroupExecutorTypeDef#

# ActionGroupExecutorTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ActionGroupExecutorTypeDef


def get_value() -> ActionGroupExecutorTypeDef:
    return {
        "customControl": ...,
    }


# ActionGroupExecutorTypeDef definition

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

ActionGroupSummaryTypeDef#

# ActionGroupSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ActionGroupSummaryTypeDef


def get_value() -> ActionGroupSummaryTypeDef:
    return {
        "actionGroupId": ...,
    }


# ActionGroupSummaryTypeDef definition

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

AgentAliasRoutingConfigurationListItemTypeDef#

# AgentAliasRoutingConfigurationListItemTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentAliasRoutingConfigurationListItemTypeDef


def get_value() -> AgentAliasRoutingConfigurationListItemTypeDef:
    return {
        "agentVersion": ...,
    }


# AgentAliasRoutingConfigurationListItemTypeDef definition

class AgentAliasRoutingConfigurationListItemTypeDef(TypedDict):
    agentVersion: NotRequired[str],
    provisionedThroughput: NotRequired[str],

AgentDescriptorTypeDef#

# AgentDescriptorTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentDescriptorTypeDef


def get_value() -> AgentDescriptorTypeDef:
    return {
        "aliasArn": ...,
    }


# AgentDescriptorTypeDef definition

class AgentDescriptorTypeDef(TypedDict):
    aliasArn: NotRequired[str],

AgentFlowNodeConfigurationTypeDef#

# AgentFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentFlowNodeConfigurationTypeDef


def get_value() -> AgentFlowNodeConfigurationTypeDef:
    return {
        "agentAliasArn": ...,
    }


# AgentFlowNodeConfigurationTypeDef definition

class AgentFlowNodeConfigurationTypeDef(TypedDict):
    agentAliasArn: str,

AgentKnowledgeBaseSummaryTypeDef#

# AgentKnowledgeBaseSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentKnowledgeBaseSummaryTypeDef


def get_value() -> AgentKnowledgeBaseSummaryTypeDef:
    return {
        "description": ...,
    }


# AgentKnowledgeBaseSummaryTypeDef definition

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

AgentKnowledgeBaseTypeDef#

# AgentKnowledgeBaseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentKnowledgeBaseTypeDef


def get_value() -> AgentKnowledgeBaseTypeDef:
    return {
        "agentId": ...,
    }


# AgentKnowledgeBaseTypeDef definition

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

GuardrailConfigurationTypeDef#

# GuardrailConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GuardrailConfigurationTypeDef


def get_value() -> GuardrailConfigurationTypeDef:
    return {
        "guardrailIdentifier": ...,
    }


# GuardrailConfigurationTypeDef definition

class GuardrailConfigurationTypeDef(TypedDict):
    guardrailIdentifier: NotRequired[str],
    guardrailVersion: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

AssociateAgentKnowledgeBaseRequestTypeDef#

# AssociateAgentKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AssociateAgentKnowledgeBaseRequestTypeDef


def get_value() -> AssociateAgentKnowledgeBaseRequestTypeDef:
    return {
        "agentId": ...,
    }


# AssociateAgentKnowledgeBaseRequestTypeDef definition

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

BedrockDataAutomationConfigurationTypeDef#

# BedrockDataAutomationConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import BedrockDataAutomationConfigurationTypeDef


def get_value() -> BedrockDataAutomationConfigurationTypeDef:
    return {
        "parsingModality": ...,
    }


# BedrockDataAutomationConfigurationTypeDef definition

class BedrockDataAutomationConfigurationTypeDef(TypedDict):
    parsingModality: NotRequired[ParsingModalityType],  # (1)
  1. See ParsingModalityType

BedrockEmbeddingModelConfigurationTypeDef#

# BedrockEmbeddingModelConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import BedrockEmbeddingModelConfigurationTypeDef


def get_value() -> BedrockEmbeddingModelConfigurationTypeDef:
    return {
        "dimensions": ...,
    }


# BedrockEmbeddingModelConfigurationTypeDef definition

class BedrockEmbeddingModelConfigurationTypeDef(TypedDict):
    dimensions: NotRequired[int],
    embeddingDataType: NotRequired[EmbeddingDataTypeType],  # (1)
  1. See EmbeddingDataTypeType

ParsingPromptTypeDef#

# ParsingPromptTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ParsingPromptTypeDef


def get_value() -> ParsingPromptTypeDef:
    return {
        "parsingPromptText": ...,
    }


# ParsingPromptTypeDef definition

class ParsingPromptTypeDef(TypedDict):
    parsingPromptText: str,

EnrichmentStrategyConfigurationTypeDef#

# EnrichmentStrategyConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import EnrichmentStrategyConfigurationTypeDef


def get_value() -> EnrichmentStrategyConfigurationTypeDef:
    return {
        "method": ...,
    }


# EnrichmentStrategyConfigurationTypeDef definition

class EnrichmentStrategyConfigurationTypeDef(TypedDict):
    method: EnrichmentStrategyMethodType,  # (1)
  1. See EnrichmentStrategyMethodType

CachePointBlockTypeDef#

# CachePointBlockTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CachePointBlockTypeDef


def get_value() -> CachePointBlockTypeDef:
    return {
        "type": ...,
    }


# CachePointBlockTypeDef definition

class CachePointBlockTypeDef(TypedDict):
    type: CachePointTypeType,  # (1)
  1. See CachePointTypeType

PromptInputVariableTypeDef#

# PromptInputVariableTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptInputVariableTypeDef


def get_value() -> PromptInputVariableTypeDef:
    return {
        "name": ...,
    }


# PromptInputVariableTypeDef definition

class PromptInputVariableTypeDef(TypedDict):
    name: NotRequired[str],

FixedSizeChunkingConfigurationTypeDef#

# FixedSizeChunkingConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FixedSizeChunkingConfigurationTypeDef


def get_value() -> FixedSizeChunkingConfigurationTypeDef:
    return {
        "maxTokens": ...,
    }


# FixedSizeChunkingConfigurationTypeDef definition

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

SemanticChunkingConfigurationTypeDef#

# SemanticChunkingConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SemanticChunkingConfigurationTypeDef


def get_value() -> SemanticChunkingConfigurationTypeDef:
    return {
        "breakpointPercentileThreshold": ...,
    }


# SemanticChunkingConfigurationTypeDef definition

class SemanticChunkingConfigurationTypeDef(TypedDict):
    breakpointPercentileThreshold: int,
    bufferSize: int,
    maxTokens: int,

FlowConditionTypeDef#

# FlowConditionTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowConditionTypeDef


def get_value() -> FlowConditionTypeDef:
    return {
        "expression": ...,
    }


# FlowConditionTypeDef definition

class FlowConditionTypeDef(TypedDict):
    name: str,
    expression: NotRequired[str],

ConfluenceSourceConfigurationTypeDef#

# ConfluenceSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConfluenceSourceConfigurationTypeDef


def get_value() -> ConfluenceSourceConfigurationTypeDef:
    return {
        "authType": ...,
    }


# ConfluenceSourceConfigurationTypeDef definition

class ConfluenceSourceConfigurationTypeDef(TypedDict):
    authType: ConfluenceAuthTypeType,  # (1)
    credentialsSecretArn: str,
    hostType: ConfluenceHostTypeType,  # (2)
    hostUrl: str,
  1. See ConfluenceAuthTypeType
  2. See ConfluenceHostTypeType

ServerSideEncryptionConfigurationTypeDef#

# ServerSideEncryptionConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ServerSideEncryptionConfigurationTypeDef


def get_value() -> ServerSideEncryptionConfigurationTypeDef:
    return {
        "kmsKeyArn": ...,
    }


# ServerSideEncryptionConfigurationTypeDef definition

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

FlowAliasRoutingConfigurationListItemTypeDef#

# FlowAliasRoutingConfigurationListItemTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowAliasRoutingConfigurationListItemTypeDef


def get_value() -> FlowAliasRoutingConfigurationListItemTypeDef:
    return {
        "flowVersion": ...,
    }


# FlowAliasRoutingConfigurationListItemTypeDef definition

class FlowAliasRoutingConfigurationListItemTypeDef(TypedDict):
    flowVersion: NotRequired[str],

CreateFlowVersionRequestTypeDef#

# CreateFlowVersionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateFlowVersionRequestTypeDef


def get_value() -> CreateFlowVersionRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# CreateFlowVersionRequestTypeDef definition

class CreateFlowVersionRequestTypeDef(TypedDict):
    flowIdentifier: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],

CreatePromptVersionRequestTypeDef#

# CreatePromptVersionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreatePromptVersionRequestTypeDef


def get_value() -> CreatePromptVersionRequestTypeDef:
    return {
        "promptIdentifier": ...,
    }


# CreatePromptVersionRequestTypeDef definition

class CreatePromptVersionRequestTypeDef(TypedDict):
    promptIdentifier: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CuratedQueryTypeDef#

# CuratedQueryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CuratedQueryTypeDef


def get_value() -> CuratedQueryTypeDef:
    return {
        "naturalLanguage": ...,
    }


# CuratedQueryTypeDef definition

class CuratedQueryTypeDef(TypedDict):
    naturalLanguage: str,
    sql: str,

CustomDocumentIdentifierTypeDef#

# CustomDocumentIdentifierTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CustomDocumentIdentifierTypeDef


def get_value() -> CustomDocumentIdentifierTypeDef:
    return {
        "id": ...,
    }


# CustomDocumentIdentifierTypeDef definition

class CustomDocumentIdentifierTypeDef(TypedDict):
    id: str,

CustomS3LocationTypeDef#

# CustomS3LocationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CustomS3LocationTypeDef


def get_value() -> CustomS3LocationTypeDef:
    return {
        "bucketOwnerAccountId": ...,
    }


# CustomS3LocationTypeDef definition

class CustomS3LocationTypeDef(TypedDict):
    uri: str,
    bucketOwnerAccountId: NotRequired[str],

OrchestrationExecutorTypeDef#

# OrchestrationExecutorTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import OrchestrationExecutorTypeDef


def get_value() -> OrchestrationExecutorTypeDef:
    return {
        "lambda": ...,
    }


# OrchestrationExecutorTypeDef definition

class OrchestrationExecutorTypeDef(TypedDict):
    lambda: NotRequired[str],

CyclicConnectionFlowValidationDetailsTypeDef#

# CyclicConnectionFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CyclicConnectionFlowValidationDetailsTypeDef


def get_value() -> CyclicConnectionFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# CyclicConnectionFlowValidationDetailsTypeDef definition

class CyclicConnectionFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

S3DataSourceConfigurationOutputTypeDef#

# S3DataSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import S3DataSourceConfigurationOutputTypeDef


def get_value() -> S3DataSourceConfigurationOutputTypeDef:
    return {
        "bucketArn": ...,
    }


# S3DataSourceConfigurationOutputTypeDef definition

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

S3DataSourceConfigurationTypeDef#

# S3DataSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import S3DataSourceConfigurationTypeDef


def get_value() -> S3DataSourceConfigurationTypeDef:
    return {
        "bucketArn": ...,
    }


# S3DataSourceConfigurationTypeDef definition

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

DataSourceSummaryTypeDef#

# DataSourceSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DataSourceSummaryTypeDef


def get_value() -> DataSourceSummaryTypeDef:
    return {
        "dataSourceId": ...,
    }


# DataSourceSummaryTypeDef definition

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

DeleteAgentActionGroupRequestTypeDef#

# DeleteAgentActionGroupRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentActionGroupRequestTypeDef


def get_value() -> DeleteAgentActionGroupRequestTypeDef:
    return {
        "actionGroupId": ...,
    }


# DeleteAgentActionGroupRequestTypeDef definition

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

DeleteAgentAliasRequestTypeDef#

# DeleteAgentAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentAliasRequestTypeDef


def get_value() -> DeleteAgentAliasRequestTypeDef:
    return {
        "agentAliasId": ...,
    }


# DeleteAgentAliasRequestTypeDef definition

class DeleteAgentAliasRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: str,

DeleteAgentRequestTypeDef#

# DeleteAgentRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentRequestTypeDef


def get_value() -> DeleteAgentRequestTypeDef:
    return {
        "agentId": ...,
    }


# DeleteAgentRequestTypeDef definition

class DeleteAgentRequestTypeDef(TypedDict):
    agentId: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteAgentVersionRequestTypeDef#

# DeleteAgentVersionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentVersionRequestTypeDef


def get_value() -> DeleteAgentVersionRequestTypeDef:
    return {
        "agentId": ...,
    }


# DeleteAgentVersionRequestTypeDef definition

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

DeleteDataSourceRequestTypeDef#

# DeleteDataSourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteDataSourceRequestTypeDef


def get_value() -> DeleteDataSourceRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# DeleteDataSourceRequestTypeDef definition

class DeleteDataSourceRequestTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,

DeleteFlowAliasRequestTypeDef#

# DeleteFlowAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteFlowAliasRequestTypeDef


def get_value() -> DeleteFlowAliasRequestTypeDef:
    return {
        "aliasIdentifier": ...,
    }


# DeleteFlowAliasRequestTypeDef definition

class DeleteFlowAliasRequestTypeDef(TypedDict):
    aliasIdentifier: str,
    flowIdentifier: str,

DeleteFlowRequestTypeDef#

# DeleteFlowRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteFlowRequestTypeDef


def get_value() -> DeleteFlowRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# DeleteFlowRequestTypeDef definition

class DeleteFlowRequestTypeDef(TypedDict):
    flowIdentifier: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteFlowVersionRequestTypeDef#

# DeleteFlowVersionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteFlowVersionRequestTypeDef


def get_value() -> DeleteFlowVersionRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# DeleteFlowVersionRequestTypeDef definition

class DeleteFlowVersionRequestTypeDef(TypedDict):
    flowIdentifier: str,
    flowVersion: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteKnowledgeBaseRequestTypeDef#

# DeleteKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteKnowledgeBaseRequestTypeDef


def get_value() -> DeleteKnowledgeBaseRequestTypeDef:
    return {
        "knowledgeBaseId": ...,
    }


# DeleteKnowledgeBaseRequestTypeDef definition

class DeleteKnowledgeBaseRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

DeletePromptRequestTypeDef#

# DeletePromptRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeletePromptRequestTypeDef


def get_value() -> DeletePromptRequestTypeDef:
    return {
        "promptIdentifier": ...,
    }


# DeletePromptRequestTypeDef definition

class DeletePromptRequestTypeDef(TypedDict):
    promptIdentifier: str,
    promptVersion: NotRequired[str],

DisassociateAgentCollaboratorRequestTypeDef#

# DisassociateAgentCollaboratorRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DisassociateAgentCollaboratorRequestTypeDef


def get_value() -> DisassociateAgentCollaboratorRequestTypeDef:
    return {
        "agentId": ...,
    }


# DisassociateAgentCollaboratorRequestTypeDef definition

class DisassociateAgentCollaboratorRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    collaboratorId: str,

DisassociateAgentKnowledgeBaseRequestTypeDef#

# DisassociateAgentKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DisassociateAgentKnowledgeBaseRequestTypeDef


def get_value() -> DisassociateAgentKnowledgeBaseRequestTypeDef:
    return {
        "agentId": ...,
    }


# DisassociateAgentKnowledgeBaseRequestTypeDef definition

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

S3LocationTypeDef#

# S3LocationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import S3LocationTypeDef


def get_value() -> S3LocationTypeDef:
    return {
        "uri": ...,
    }


# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    uri: str,

DuplicateConditionExpressionFlowValidationDetailsTypeDef#

# DuplicateConditionExpressionFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DuplicateConditionExpressionFlowValidationDetailsTypeDef


def get_value() -> DuplicateConditionExpressionFlowValidationDetailsTypeDef:
    return {
        "expression": ...,
    }


# DuplicateConditionExpressionFlowValidationDetailsTypeDef definition

class DuplicateConditionExpressionFlowValidationDetailsTypeDef(TypedDict):
    expression: str,
    node: str,

DuplicateConnectionsFlowValidationDetailsTypeDef#

# DuplicateConnectionsFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DuplicateConnectionsFlowValidationDetailsTypeDef


def get_value() -> DuplicateConnectionsFlowValidationDetailsTypeDef:
    return {
        "source": ...,
    }


# DuplicateConnectionsFlowValidationDetailsTypeDef definition

class DuplicateConnectionsFlowValidationDetailsTypeDef(TypedDict):
    source: str,
    target: str,

FlowConditionalConnectionConfigurationTypeDef#

# FlowConditionalConnectionConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowConditionalConnectionConfigurationTypeDef


def get_value() -> FlowConditionalConnectionConfigurationTypeDef:
    return {
        "condition": ...,
    }


# FlowConditionalConnectionConfigurationTypeDef definition

class FlowConditionalConnectionConfigurationTypeDef(TypedDict):
    condition: str,

FlowDataConnectionConfigurationTypeDef#

# FlowDataConnectionConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowDataConnectionConfigurationTypeDef


def get_value() -> FlowDataConnectionConfigurationTypeDef:
    return {
        "sourceOutput": ...,
    }


# FlowDataConnectionConfigurationTypeDef definition

class FlowDataConnectionConfigurationTypeDef(TypedDict):
    sourceOutput: str,
    targetInput: str,

LambdaFunctionFlowNodeConfigurationTypeDef#

# LambdaFunctionFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import LambdaFunctionFlowNodeConfigurationTypeDef


def get_value() -> LambdaFunctionFlowNodeConfigurationTypeDef:
    return {
        "lambdaArn": ...,
    }


# LambdaFunctionFlowNodeConfigurationTypeDef definition

class LambdaFunctionFlowNodeConfigurationTypeDef(TypedDict):
    lambdaArn: str,

LexFlowNodeConfigurationTypeDef#

# LexFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import LexFlowNodeConfigurationTypeDef


def get_value() -> LexFlowNodeConfigurationTypeDef:
    return {
        "botAliasArn": ...,
    }


# LexFlowNodeConfigurationTypeDef definition

class LexFlowNodeConfigurationTypeDef(TypedDict):
    botAliasArn: str,
    localeId: str,

FlowNodeInputTypeDef#

# FlowNodeInputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowNodeInputTypeDef


def get_value() -> FlowNodeInputTypeDef:
    return {
        "expression": ...,
    }


# FlowNodeInputTypeDef definition

class FlowNodeInputTypeDef(TypedDict):
    expression: str,
    name: str,
    type: FlowNodeIODataTypeType,  # (1)
  1. See FlowNodeIODataTypeType

FlowNodeOutputTypeDef#

# FlowNodeOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowNodeOutputTypeDef


def get_value() -> FlowNodeOutputTypeDef:
    return {
        "name": ...,
    }


# FlowNodeOutputTypeDef definition

class FlowNodeOutputTypeDef(TypedDict):
    name: str,
    type: FlowNodeIODataTypeType,  # (1)
  1. See FlowNodeIODataTypeType

FlowSummaryTypeDef#

# FlowSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowSummaryTypeDef


def get_value() -> FlowSummaryTypeDef:
    return {
        "arn": ...,
    }


# FlowSummaryTypeDef definition

class FlowSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    id: str,
    name: str,
    status: FlowStatusType,  # (1)
    updatedAt: datetime.datetime,
    version: str,
    description: NotRequired[str],
  1. See FlowStatusType

IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef#

# IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef


def get_value() -> IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef definition

class IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

MalformedConditionExpressionFlowValidationDetailsTypeDef#

# MalformedConditionExpressionFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MalformedConditionExpressionFlowValidationDetailsTypeDef


def get_value() -> MalformedConditionExpressionFlowValidationDetailsTypeDef:
    return {
        "cause": ...,
    }


# MalformedConditionExpressionFlowValidationDetailsTypeDef definition

class MalformedConditionExpressionFlowValidationDetailsTypeDef(TypedDict):
    cause: str,
    condition: str,
    node: str,

MalformedNodeInputExpressionFlowValidationDetailsTypeDef#

# MalformedNodeInputExpressionFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MalformedNodeInputExpressionFlowValidationDetailsTypeDef


def get_value() -> MalformedNodeInputExpressionFlowValidationDetailsTypeDef:
    return {
        "cause": ...,
    }


# MalformedNodeInputExpressionFlowValidationDetailsTypeDef definition

class MalformedNodeInputExpressionFlowValidationDetailsTypeDef(TypedDict):
    cause: str,
    input: str,
    node: str,

MismatchedNodeInputTypeFlowValidationDetailsTypeDef#

# MismatchedNodeInputTypeFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MismatchedNodeInputTypeFlowValidationDetailsTypeDef


def get_value() -> MismatchedNodeInputTypeFlowValidationDetailsTypeDef:
    return {
        "expectedType": ...,
    }


# MismatchedNodeInputTypeFlowValidationDetailsTypeDef definition

class MismatchedNodeInputTypeFlowValidationDetailsTypeDef(TypedDict):
    expectedType: FlowNodeIODataTypeType,  # (1)
    input: str,
    node: str,
  1. See FlowNodeIODataTypeType

MismatchedNodeOutputTypeFlowValidationDetailsTypeDef#

# MismatchedNodeOutputTypeFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MismatchedNodeOutputTypeFlowValidationDetailsTypeDef


def get_value() -> MismatchedNodeOutputTypeFlowValidationDetailsTypeDef:
    return {
        "expectedType": ...,
    }


# MismatchedNodeOutputTypeFlowValidationDetailsTypeDef definition

class MismatchedNodeOutputTypeFlowValidationDetailsTypeDef(TypedDict):
    expectedType: FlowNodeIODataTypeType,  # (1)
    node: str,
    output: str,
  1. See FlowNodeIODataTypeType

MissingConnectionConfigurationFlowValidationDetailsTypeDef#

# MissingConnectionConfigurationFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MissingConnectionConfigurationFlowValidationDetailsTypeDef


def get_value() -> MissingConnectionConfigurationFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# MissingConnectionConfigurationFlowValidationDetailsTypeDef definition

class MissingConnectionConfigurationFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

MissingDefaultConditionFlowValidationDetailsTypeDef#

# MissingDefaultConditionFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MissingDefaultConditionFlowValidationDetailsTypeDef


def get_value() -> MissingDefaultConditionFlowValidationDetailsTypeDef:
    return {
        "node": ...,
    }


# MissingDefaultConditionFlowValidationDetailsTypeDef definition

class MissingDefaultConditionFlowValidationDetailsTypeDef(TypedDict):
    node: str,

MissingNodeConfigurationFlowValidationDetailsTypeDef#

# MissingNodeConfigurationFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MissingNodeConfigurationFlowValidationDetailsTypeDef


def get_value() -> MissingNodeConfigurationFlowValidationDetailsTypeDef:
    return {
        "node": ...,
    }


# MissingNodeConfigurationFlowValidationDetailsTypeDef definition

class MissingNodeConfigurationFlowValidationDetailsTypeDef(TypedDict):
    node: str,

MissingNodeInputFlowValidationDetailsTypeDef#

# MissingNodeInputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MissingNodeInputFlowValidationDetailsTypeDef


def get_value() -> MissingNodeInputFlowValidationDetailsTypeDef:
    return {
        "input": ...,
    }


# MissingNodeInputFlowValidationDetailsTypeDef definition

class MissingNodeInputFlowValidationDetailsTypeDef(TypedDict):
    input: str,
    node: str,

MissingNodeOutputFlowValidationDetailsTypeDef#

# MissingNodeOutputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MissingNodeOutputFlowValidationDetailsTypeDef


def get_value() -> MissingNodeOutputFlowValidationDetailsTypeDef:
    return {
        "node": ...,
    }


# MissingNodeOutputFlowValidationDetailsTypeDef definition

class MissingNodeOutputFlowValidationDetailsTypeDef(TypedDict):
    node: str,
    output: str,

MultipleNodeInputConnectionsFlowValidationDetailsTypeDef#

# MultipleNodeInputConnectionsFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MultipleNodeInputConnectionsFlowValidationDetailsTypeDef


def get_value() -> MultipleNodeInputConnectionsFlowValidationDetailsTypeDef:
    return {
        "input": ...,
    }


# MultipleNodeInputConnectionsFlowValidationDetailsTypeDef definition

class MultipleNodeInputConnectionsFlowValidationDetailsTypeDef(TypedDict):
    input: str,
    node: str,

UnfulfilledNodeInputFlowValidationDetailsTypeDef#

# UnfulfilledNodeInputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnfulfilledNodeInputFlowValidationDetailsTypeDef


def get_value() -> UnfulfilledNodeInputFlowValidationDetailsTypeDef:
    return {
        "input": ...,
    }


# UnfulfilledNodeInputFlowValidationDetailsTypeDef definition

class UnfulfilledNodeInputFlowValidationDetailsTypeDef(TypedDict):
    input: str,
    node: str,

UnknownConnectionConditionFlowValidationDetailsTypeDef#

# UnknownConnectionConditionFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownConnectionConditionFlowValidationDetailsTypeDef


def get_value() -> UnknownConnectionConditionFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# UnknownConnectionConditionFlowValidationDetailsTypeDef definition

class UnknownConnectionConditionFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

UnknownConnectionSourceFlowValidationDetailsTypeDef#

# UnknownConnectionSourceFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownConnectionSourceFlowValidationDetailsTypeDef


def get_value() -> UnknownConnectionSourceFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# UnknownConnectionSourceFlowValidationDetailsTypeDef definition

class UnknownConnectionSourceFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

UnknownConnectionSourceOutputFlowValidationDetailsTypeDef#

# UnknownConnectionSourceOutputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownConnectionSourceOutputFlowValidationDetailsTypeDef


def get_value() -> UnknownConnectionSourceOutputFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# UnknownConnectionSourceOutputFlowValidationDetailsTypeDef definition

class UnknownConnectionSourceOutputFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

UnknownConnectionTargetFlowValidationDetailsTypeDef#

# UnknownConnectionTargetFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownConnectionTargetFlowValidationDetailsTypeDef


def get_value() -> UnknownConnectionTargetFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# UnknownConnectionTargetFlowValidationDetailsTypeDef definition

class UnknownConnectionTargetFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

UnknownConnectionTargetInputFlowValidationDetailsTypeDef#

# UnknownConnectionTargetInputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownConnectionTargetInputFlowValidationDetailsTypeDef


def get_value() -> UnknownConnectionTargetInputFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# UnknownConnectionTargetInputFlowValidationDetailsTypeDef definition

class UnknownConnectionTargetInputFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

UnknownNodeInputFlowValidationDetailsTypeDef#

# UnknownNodeInputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownNodeInputFlowValidationDetailsTypeDef


def get_value() -> UnknownNodeInputFlowValidationDetailsTypeDef:
    return {
        "input": ...,
    }


# UnknownNodeInputFlowValidationDetailsTypeDef definition

class UnknownNodeInputFlowValidationDetailsTypeDef(TypedDict):
    input: str,
    node: str,

UnknownNodeOutputFlowValidationDetailsTypeDef#

# UnknownNodeOutputFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnknownNodeOutputFlowValidationDetailsTypeDef


def get_value() -> UnknownNodeOutputFlowValidationDetailsTypeDef:
    return {
        "node": ...,
    }


# UnknownNodeOutputFlowValidationDetailsTypeDef definition

class UnknownNodeOutputFlowValidationDetailsTypeDef(TypedDict):
    node: str,
    output: str,

UnreachableNodeFlowValidationDetailsTypeDef#

# UnreachableNodeFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnreachableNodeFlowValidationDetailsTypeDef


def get_value() -> UnreachableNodeFlowValidationDetailsTypeDef:
    return {
        "node": ...,
    }


# UnreachableNodeFlowValidationDetailsTypeDef definition

class UnreachableNodeFlowValidationDetailsTypeDef(TypedDict):
    node: str,

UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef#

# UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef


def get_value() -> UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef:
    return {
        "connection": ...,
    }


# UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef definition

class UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef(TypedDict):
    connection: str,

FlowVersionSummaryTypeDef#

# FlowVersionSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowVersionSummaryTypeDef


def get_value() -> FlowVersionSummaryTypeDef:
    return {
        "arn": ...,
    }


# FlowVersionSummaryTypeDef definition

class FlowVersionSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    id: str,
    status: FlowStatusType,  # (1)
    version: str,
  1. See FlowStatusType

ParameterDetailTypeDef#

# ParameterDetailTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ParameterDetailTypeDef


def get_value() -> ParameterDetailTypeDef:
    return {
        "description": ...,
    }


# ParameterDetailTypeDef definition

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

GetAgentActionGroupRequestTypeDef#

# GetAgentActionGroupRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentActionGroupRequestTypeDef


def get_value() -> GetAgentActionGroupRequestTypeDef:
    return {
        "actionGroupId": ...,
    }


# GetAgentActionGroupRequestTypeDef definition

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

GetAgentAliasRequestTypeDef#

# GetAgentAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentAliasRequestTypeDef


def get_value() -> GetAgentAliasRequestTypeDef:
    return {
        "agentAliasId": ...,
    }


# GetAgentAliasRequestTypeDef definition

class GetAgentAliasRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: str,

GetAgentCollaboratorRequestTypeDef#

# GetAgentCollaboratorRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentCollaboratorRequestTypeDef


def get_value() -> GetAgentCollaboratorRequestTypeDef:
    return {
        "agentId": ...,
    }


# GetAgentCollaboratorRequestTypeDef definition

class GetAgentCollaboratorRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    collaboratorId: str,

GetAgentKnowledgeBaseRequestTypeDef#

# GetAgentKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentKnowledgeBaseRequestTypeDef


def get_value() -> GetAgentKnowledgeBaseRequestTypeDef:
    return {
        "agentId": ...,
    }


# GetAgentKnowledgeBaseRequestTypeDef definition

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

GetAgentRequestTypeDef#

# GetAgentRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentRequestTypeDef


def get_value() -> GetAgentRequestTypeDef:
    return {
        "agentId": ...,
    }


# GetAgentRequestTypeDef definition

class GetAgentRequestTypeDef(TypedDict):
    agentId: str,

GetAgentVersionRequestTypeDef#

# GetAgentVersionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentVersionRequestTypeDef


def get_value() -> GetAgentVersionRequestTypeDef:
    return {
        "agentId": ...,
    }


# GetAgentVersionRequestTypeDef definition

class GetAgentVersionRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,

GetDataSourceRequestTypeDef#

# GetDataSourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetDataSourceRequestTypeDef


def get_value() -> GetDataSourceRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# GetDataSourceRequestTypeDef definition

class GetDataSourceRequestTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,

GetFlowAliasRequestTypeDef#

# GetFlowAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetFlowAliasRequestTypeDef


def get_value() -> GetFlowAliasRequestTypeDef:
    return {
        "aliasIdentifier": ...,
    }


# GetFlowAliasRequestTypeDef definition

class GetFlowAliasRequestTypeDef(TypedDict):
    aliasIdentifier: str,
    flowIdentifier: str,

GetFlowRequestTypeDef#

# GetFlowRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetFlowRequestTypeDef


def get_value() -> GetFlowRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# GetFlowRequestTypeDef definition

class GetFlowRequestTypeDef(TypedDict):
    flowIdentifier: str,

GetFlowVersionRequestTypeDef#

# GetFlowVersionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetFlowVersionRequestTypeDef


def get_value() -> GetFlowVersionRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# GetFlowVersionRequestTypeDef definition

class GetFlowVersionRequestTypeDef(TypedDict):
    flowIdentifier: str,
    flowVersion: str,

GetIngestionJobRequestTypeDef#

# GetIngestionJobRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetIngestionJobRequestTypeDef


def get_value() -> GetIngestionJobRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# GetIngestionJobRequestTypeDef definition

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

GetKnowledgeBaseRequestTypeDef#

# GetKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetKnowledgeBaseRequestTypeDef


def get_value() -> GetKnowledgeBaseRequestTypeDef:
    return {
        "knowledgeBaseId": ...,
    }


# GetKnowledgeBaseRequestTypeDef definition

class GetKnowledgeBaseRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

GetPromptRequestTypeDef#

# GetPromptRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetPromptRequestTypeDef


def get_value() -> GetPromptRequestTypeDef:
    return {
        "promptIdentifier": ...,
    }


# GetPromptRequestTypeDef definition

class GetPromptRequestTypeDef(TypedDict):
    promptIdentifier: str,
    promptVersion: NotRequired[str],

HierarchicalChunkingLevelConfigurationTypeDef#

# HierarchicalChunkingLevelConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import HierarchicalChunkingLevelConfigurationTypeDef


def get_value() -> HierarchicalChunkingLevelConfigurationTypeDef:
    return {
        "maxTokens": ...,
    }


# HierarchicalChunkingLevelConfigurationTypeDef definition

class HierarchicalChunkingLevelConfigurationTypeDef(TypedDict):
    maxTokens: int,

InferenceConfigurationOutputTypeDef#

# InferenceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import InferenceConfigurationOutputTypeDef


def get_value() -> InferenceConfigurationOutputTypeDef:
    return {
        "maximumLength": ...,
    }


# InferenceConfigurationOutputTypeDef definition

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

InferenceConfigurationTypeDef#

# InferenceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import InferenceConfigurationTypeDef


def get_value() -> InferenceConfigurationTypeDef:
    return {
        "maximumLength": ...,
    }


# InferenceConfigurationTypeDef definition

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

IngestionJobFilterTypeDef#

# IngestionJobFilterTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestionJobFilterTypeDef


def get_value() -> IngestionJobFilterTypeDef:
    return {
        "attribute": ...,
    }


# IngestionJobFilterTypeDef definition

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

IngestionJobSortByTypeDef#

# IngestionJobSortByTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestionJobSortByTypeDef


def get_value() -> IngestionJobSortByTypeDef:
    return {
        "attribute": ...,
    }


# IngestionJobSortByTypeDef definition

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

IngestionJobStatisticsTypeDef#

# IngestionJobStatisticsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestionJobStatisticsTypeDef


def get_value() -> IngestionJobStatisticsTypeDef:
    return {
        "numberOfDocumentsDeleted": ...,
    }


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

TextContentDocTypeDef#

# TextContentDocTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TextContentDocTypeDef


def get_value() -> TextContentDocTypeDef:
    return {
        "data": ...,
    }


# TextContentDocTypeDef definition

class TextContentDocTypeDef(TypedDict):
    data: str,

KendraKnowledgeBaseConfigurationTypeDef#

# KendraKnowledgeBaseConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KendraKnowledgeBaseConfigurationTypeDef


def get_value() -> KendraKnowledgeBaseConfigurationTypeDef:
    return {
        "kendraIndexArn": ...,
    }


# KendraKnowledgeBaseConfigurationTypeDef definition

class KendraKnowledgeBaseConfigurationTypeDef(TypedDict):
    kendraIndexArn: str,

KnowledgeBaseSummaryTypeDef#

# KnowledgeBaseSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseSummaryTypeDef


def get_value() -> KnowledgeBaseSummaryTypeDef:
    return {
        "description": ...,
    }


# KnowledgeBaseSummaryTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAgentActionGroupsRequestTypeDef#

# ListAgentActionGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentActionGroupsRequestTypeDef


def get_value() -> ListAgentActionGroupsRequestTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentActionGroupsRequestTypeDef definition

class ListAgentActionGroupsRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentAliasesRequestTypeDef#

# ListAgentAliasesRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentAliasesRequestTypeDef


def get_value() -> ListAgentAliasesRequestTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentAliasesRequestTypeDef definition

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

ListAgentCollaboratorsRequestTypeDef#

# ListAgentCollaboratorsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentCollaboratorsRequestTypeDef


def get_value() -> ListAgentCollaboratorsRequestTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentCollaboratorsRequestTypeDef definition

class ListAgentCollaboratorsRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentKnowledgeBasesRequestTypeDef#

# ListAgentKnowledgeBasesRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentKnowledgeBasesRequestTypeDef


def get_value() -> ListAgentKnowledgeBasesRequestTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentKnowledgeBasesRequestTypeDef definition

class ListAgentKnowledgeBasesRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentVersionsRequestTypeDef#

# ListAgentVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentVersionsRequestTypeDef


def get_value() -> ListAgentVersionsRequestTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentVersionsRequestTypeDef definition

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

ListAgentsRequestTypeDef#

# ListAgentsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentsRequestTypeDef


def get_value() -> ListAgentsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListAgentsRequestTypeDef definition

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

ListDataSourcesRequestTypeDef#

# ListDataSourcesRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListDataSourcesRequestTypeDef


def get_value() -> ListDataSourcesRequestTypeDef:
    return {
        "knowledgeBaseId": ...,
    }


# ListDataSourcesRequestTypeDef definition

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

ListFlowAliasesRequestTypeDef#

# ListFlowAliasesRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowAliasesRequestTypeDef


def get_value() -> ListFlowAliasesRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# ListFlowAliasesRequestTypeDef definition

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

ListFlowVersionsRequestTypeDef#

# ListFlowVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowVersionsRequestTypeDef


def get_value() -> ListFlowVersionsRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# ListFlowVersionsRequestTypeDef definition

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

ListFlowsRequestTypeDef#

# ListFlowsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowsRequestTypeDef


def get_value() -> ListFlowsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListFlowsRequestTypeDef definition

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

ListKnowledgeBaseDocumentsRequestTypeDef#

# ListKnowledgeBaseDocumentsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListKnowledgeBaseDocumentsRequestTypeDef


def get_value() -> ListKnowledgeBaseDocumentsRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# ListKnowledgeBaseDocumentsRequestTypeDef definition

class ListKnowledgeBaseDocumentsRequestTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListKnowledgeBasesRequestTypeDef#

# ListKnowledgeBasesRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListKnowledgeBasesRequestTypeDef


def get_value() -> ListKnowledgeBasesRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListKnowledgeBasesRequestTypeDef definition

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

ListPromptsRequestTypeDef#

# ListPromptsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListPromptsRequestTypeDef


def get_value() -> ListPromptsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListPromptsRequestTypeDef definition

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

PromptSummaryTypeDef#

# PromptSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptSummaryTypeDef


def get_value() -> PromptSummaryTypeDef:
    return {
        "arn": ...,
    }


# PromptSummaryTypeDef definition

class PromptSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    id: str,
    name: str,
    updatedAt: datetime.datetime,
    version: str,
    description: NotRequired[str],

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

SessionSummaryConfigurationTypeDef#

# SessionSummaryConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SessionSummaryConfigurationTypeDef


def get_value() -> SessionSummaryConfigurationTypeDef:
    return {
        "maxRecentSessions": ...,
    }


# SessionSummaryConfigurationTypeDef definition

class SessionSummaryConfigurationTypeDef(TypedDict):
    maxRecentSessions: NotRequired[int],

MetadataAttributeValueTypeDef#

# MetadataAttributeValueTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MetadataAttributeValueTypeDef


def get_value() -> MetadataAttributeValueTypeDef:
    return {
        "booleanValue": ...,
    }


# MetadataAttributeValueTypeDef definition

class MetadataAttributeValueTypeDef(TypedDict):
    type: MetadataValueTypeType,  # (1)
    booleanValue: NotRequired[bool],
    numberValue: NotRequired[float],
    stringListValue: NotRequired[Sequence[str]],
    stringValue: NotRequired[str],
  1. See MetadataValueTypeType

MongoDbAtlasFieldMappingTypeDef#

# MongoDbAtlasFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MongoDbAtlasFieldMappingTypeDef


def get_value() -> MongoDbAtlasFieldMappingTypeDef:
    return {
        "metadataField": ...,
    }


# MongoDbAtlasFieldMappingTypeDef definition

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

NeptuneAnalyticsFieldMappingTypeDef#

# NeptuneAnalyticsFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import NeptuneAnalyticsFieldMappingTypeDef


def get_value() -> NeptuneAnalyticsFieldMappingTypeDef:
    return {
        "metadataField": ...,
    }


# NeptuneAnalyticsFieldMappingTypeDef definition

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

OpenSearchManagedClusterFieldMappingTypeDef#

# OpenSearchManagedClusterFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import OpenSearchManagedClusterFieldMappingTypeDef


def get_value() -> OpenSearchManagedClusterFieldMappingTypeDef:
    return {
        "metadataField": ...,
    }


# OpenSearchManagedClusterFieldMappingTypeDef definition

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

OpenSearchServerlessFieldMappingTypeDef#

# OpenSearchServerlessFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import OpenSearchServerlessFieldMappingTypeDef


def get_value() -> OpenSearchServerlessFieldMappingTypeDef:
    return {
        "metadataField": ...,
    }


# OpenSearchServerlessFieldMappingTypeDef definition

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

PatternObjectFilterOutputTypeDef#

# PatternObjectFilterOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PatternObjectFilterOutputTypeDef


def get_value() -> PatternObjectFilterOutputTypeDef:
    return {
        "exclusionFilters": ...,
    }


# PatternObjectFilterOutputTypeDef definition

class PatternObjectFilterOutputTypeDef(TypedDict):
    objectType: str,
    exclusionFilters: NotRequired[List[str]],
    inclusionFilters: NotRequired[List[str]],

PatternObjectFilterTypeDef#

# PatternObjectFilterTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PatternObjectFilterTypeDef


def get_value() -> PatternObjectFilterTypeDef:
    return {
        "exclusionFilters": ...,
    }


# PatternObjectFilterTypeDef definition

class PatternObjectFilterTypeDef(TypedDict):
    objectType: str,
    exclusionFilters: NotRequired[Sequence[str]],
    inclusionFilters: NotRequired[Sequence[str]],

PineconeFieldMappingTypeDef#

# PineconeFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PineconeFieldMappingTypeDef


def get_value() -> PineconeFieldMappingTypeDef:
    return {
        "metadataField": ...,
    }


# PineconeFieldMappingTypeDef definition

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

PrepareAgentRequestTypeDef#

# PrepareAgentRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PrepareAgentRequestTypeDef


def get_value() -> PrepareAgentRequestTypeDef:
    return {
        "agentId": ...,
    }


# PrepareAgentRequestTypeDef definition

class PrepareAgentRequestTypeDef(TypedDict):
    agentId: str,

PrepareFlowRequestTypeDef#

# PrepareFlowRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PrepareFlowRequestTypeDef


def get_value() -> PrepareFlowRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# PrepareFlowRequestTypeDef definition

class PrepareFlowRequestTypeDef(TypedDict):
    flowIdentifier: str,

PromptAgentResourceTypeDef#

# PromptAgentResourceTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptAgentResourceTypeDef


def get_value() -> PromptAgentResourceTypeDef:
    return {
        "agentIdentifier": ...,
    }


# PromptAgentResourceTypeDef definition

class PromptAgentResourceTypeDef(TypedDict):
    agentIdentifier: str,

PromptFlowNodeResourceConfigurationTypeDef#

# PromptFlowNodeResourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeResourceConfigurationTypeDef


def get_value() -> PromptFlowNodeResourceConfigurationTypeDef:
    return {
        "promptArn": ...,
    }


# PromptFlowNodeResourceConfigurationTypeDef definition

class PromptFlowNodeResourceConfigurationTypeDef(TypedDict):
    promptArn: str,

PromptModelInferenceConfigurationOutputTypeDef#

# PromptModelInferenceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptModelInferenceConfigurationOutputTypeDef


def get_value() -> PromptModelInferenceConfigurationOutputTypeDef:
    return {
        "maxTokens": ...,
    }


# PromptModelInferenceConfigurationOutputTypeDef definition

class PromptModelInferenceConfigurationOutputTypeDef(TypedDict):
    maxTokens: NotRequired[int],
    stopSequences: NotRequired[List[str]],
    temperature: NotRequired[float],
    topP: NotRequired[float],

PromptMetadataEntryTypeDef#

# PromptMetadataEntryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptMetadataEntryTypeDef


def get_value() -> PromptMetadataEntryTypeDef:
    return {
        "key": ...,
    }


# PromptMetadataEntryTypeDef definition

class PromptMetadataEntryTypeDef(TypedDict):
    key: str,
    value: str,

PromptModelInferenceConfigurationTypeDef#

# PromptModelInferenceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptModelInferenceConfigurationTypeDef


def get_value() -> PromptModelInferenceConfigurationTypeDef:
    return {
        "maxTokens": ...,
    }


# PromptModelInferenceConfigurationTypeDef definition

class PromptModelInferenceConfigurationTypeDef(TypedDict):
    maxTokens: NotRequired[int],
    stopSequences: NotRequired[Sequence[str]],
    temperature: NotRequired[float],
    topP: NotRequired[float],

QueryGenerationColumnTypeDef#

# QueryGenerationColumnTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationColumnTypeDef


def get_value() -> QueryGenerationColumnTypeDef:
    return {
        "description": ...,
    }


# QueryGenerationColumnTypeDef definition

class QueryGenerationColumnTypeDef(TypedDict):
    description: NotRequired[str],
    inclusion: NotRequired[IncludeExcludeType],  # (1)
    name: NotRequired[str],
  1. See IncludeExcludeType

RdsFieldMappingTypeDef#

# RdsFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RdsFieldMappingTypeDef


def get_value() -> RdsFieldMappingTypeDef:
    return {
        "customMetadataField": ...,
    }


# RdsFieldMappingTypeDef definition

class RdsFieldMappingTypeDef(TypedDict):
    metadataField: str,
    primaryKeyField: str,
    textField: str,
    vectorField: str,
    customMetadataField: NotRequired[str],

RedisEnterpriseCloudFieldMappingTypeDef#

# RedisEnterpriseCloudFieldMappingTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedisEnterpriseCloudFieldMappingTypeDef


def get_value() -> RedisEnterpriseCloudFieldMappingTypeDef:
    return {
        "metadataField": ...,
    }


# RedisEnterpriseCloudFieldMappingTypeDef definition

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

RedshiftProvisionedAuthConfigurationTypeDef#

# RedshiftProvisionedAuthConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftProvisionedAuthConfigurationTypeDef


def get_value() -> RedshiftProvisionedAuthConfigurationTypeDef:
    return {
        "databaseUser": ...,
    }


# RedshiftProvisionedAuthConfigurationTypeDef definition

class RedshiftProvisionedAuthConfigurationTypeDef(TypedDict):
    type: RedshiftProvisionedAuthTypeType,  # (1)
    databaseUser: NotRequired[str],
    usernamePasswordSecretArn: NotRequired[str],
  1. See RedshiftProvisionedAuthTypeType

RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef#

# RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef


def get_value() -> RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef:
    return {
        "tableNames": ...,
    }


# RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef definition

class RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef(TypedDict):
    tableNames: List[str],

RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef#

# RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef


def get_value() -> RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef:
    return {
        "tableNames": ...,
    }


# RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef definition

class RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef(TypedDict):
    tableNames: Sequence[str],

RedshiftQueryEngineRedshiftStorageConfigurationTypeDef#

# RedshiftQueryEngineRedshiftStorageConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftQueryEngineRedshiftStorageConfigurationTypeDef


def get_value() -> RedshiftQueryEngineRedshiftStorageConfigurationTypeDef:
    return {
        "databaseName": ...,
    }


# RedshiftQueryEngineRedshiftStorageConfigurationTypeDef definition

class RedshiftQueryEngineRedshiftStorageConfigurationTypeDef(TypedDict):
    databaseName: str,

RedshiftServerlessAuthConfigurationTypeDef#

# RedshiftServerlessAuthConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftServerlessAuthConfigurationTypeDef


def get_value() -> RedshiftServerlessAuthConfigurationTypeDef:
    return {
        "type": ...,
    }


# RedshiftServerlessAuthConfigurationTypeDef definition

class RedshiftServerlessAuthConfigurationTypeDef(TypedDict):
    type: RedshiftServerlessAuthTypeType,  # (1)
    usernamePasswordSecretArn: NotRequired[str],
  1. See RedshiftServerlessAuthTypeType

RetrievalFlowNodeS3ConfigurationTypeDef#

# RetrievalFlowNodeS3ConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RetrievalFlowNodeS3ConfigurationTypeDef


def get_value() -> RetrievalFlowNodeS3ConfigurationTypeDef:
    return {
        "bucketName": ...,
    }


# RetrievalFlowNodeS3ConfigurationTypeDef definition

class RetrievalFlowNodeS3ConfigurationTypeDef(TypedDict):
    bucketName: str,

SalesforceSourceConfigurationTypeDef#

# SalesforceSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SalesforceSourceConfigurationTypeDef


def get_value() -> SalesforceSourceConfigurationTypeDef:
    return {
        "authType": ...,
    }


# SalesforceSourceConfigurationTypeDef definition

class SalesforceSourceConfigurationTypeDef(TypedDict):
    authType: SalesforceAuthTypeType,  # (1)
    credentialsSecretArn: str,
    hostUrl: str,
  1. See SalesforceAuthTypeType

SeedUrlTypeDef#

# SeedUrlTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SeedUrlTypeDef


def get_value() -> SeedUrlTypeDef:
    return {
        "url": ...,
    }


# SeedUrlTypeDef definition

class SeedUrlTypeDef(TypedDict):
    url: NotRequired[str],

SharePointSourceConfigurationOutputTypeDef#

# SharePointSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SharePointSourceConfigurationOutputTypeDef


def get_value() -> SharePointSourceConfigurationOutputTypeDef:
    return {
        "authType": ...,
    }


# SharePointSourceConfigurationOutputTypeDef definition

class SharePointSourceConfigurationOutputTypeDef(TypedDict):
    authType: SharePointAuthTypeType,  # (1)
    credentialsSecretArn: str,
    domain: str,
    hostType: SharePointHostTypeType,  # (2)
    siteUrls: List[str],
    tenantId: NotRequired[str],
  1. See SharePointAuthTypeType
  2. See SharePointHostTypeType

SharePointSourceConfigurationTypeDef#

# SharePointSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SharePointSourceConfigurationTypeDef


def get_value() -> SharePointSourceConfigurationTypeDef:
    return {
        "authType": ...,
    }


# SharePointSourceConfigurationTypeDef definition

class SharePointSourceConfigurationTypeDef(TypedDict):
    authType: SharePointAuthTypeType,  # (1)
    credentialsSecretArn: str,
    domain: str,
    hostType: SharePointHostTypeType,  # (2)
    siteUrls: Sequence[str],
    tenantId: NotRequired[str],
  1. See SharePointAuthTypeType
  2. See SharePointHostTypeType

SpecificToolChoiceTypeDef#

# SpecificToolChoiceTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SpecificToolChoiceTypeDef


def get_value() -> SpecificToolChoiceTypeDef:
    return {
        "name": ...,
    }


# SpecificToolChoiceTypeDef definition

class SpecificToolChoiceTypeDef(TypedDict):
    name: str,

StartIngestionJobRequestTypeDef#

# StartIngestionJobRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StartIngestionJobRequestTypeDef


def get_value() -> StartIngestionJobRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# StartIngestionJobRequestTypeDef definition

class StartIngestionJobRequestTypeDef(TypedDict):
    dataSourceId: str,
    knowledgeBaseId: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],

StopIngestionJobRequestTypeDef#

# StopIngestionJobRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StopIngestionJobRequestTypeDef


def get_value() -> StopIngestionJobRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# StopIngestionJobRequestTypeDef definition

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

StorageFlowNodeS3ConfigurationTypeDef#

# StorageFlowNodeS3ConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StorageFlowNodeS3ConfigurationTypeDef


def get_value() -> StorageFlowNodeS3ConfigurationTypeDef:
    return {
        "bucketName": ...,
    }


# StorageFlowNodeS3ConfigurationTypeDef definition

class StorageFlowNodeS3ConfigurationTypeDef(TypedDict):
    bucketName: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

ToolInputSchemaOutputTypeDef#

# ToolInputSchemaOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolInputSchemaOutputTypeDef


def get_value() -> ToolInputSchemaOutputTypeDef:
    return {
        "json": ...,
    }


# ToolInputSchemaOutputTypeDef definition

class ToolInputSchemaOutputTypeDef(TypedDict):
    json: NotRequired[Dict[str, Any]],

ToolInputSchemaTypeDef#

# ToolInputSchemaTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolInputSchemaTypeDef


def get_value() -> ToolInputSchemaTypeDef:
    return {
        "json": ...,
    }


# ToolInputSchemaTypeDef definition

class ToolInputSchemaTypeDef(TypedDict):
    json: NotRequired[Mapping[str, Any]],

TransformationLambdaConfigurationTypeDef#

# TransformationLambdaConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TransformationLambdaConfigurationTypeDef


def get_value() -> TransformationLambdaConfigurationTypeDef:
    return {
        "lambdaArn": ...,
    }


# TransformationLambdaConfigurationTypeDef definition

class TransformationLambdaConfigurationTypeDef(TypedDict):
    lambdaArn: str,

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateAgentKnowledgeBaseRequestTypeDef#

# UpdateAgentKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentKnowledgeBaseRequestTypeDef


def get_value() -> UpdateAgentKnowledgeBaseRequestTypeDef:
    return {
        "agentId": ...,
    }


# UpdateAgentKnowledgeBaseRequestTypeDef definition

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

WebCrawlerLimitsTypeDef#

# WebCrawlerLimitsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebCrawlerLimitsTypeDef


def get_value() -> WebCrawlerLimitsTypeDef:
    return {
        "maxPages": ...,
    }


# WebCrawlerLimitsTypeDef definition

class WebCrawlerLimitsTypeDef(TypedDict):
    maxPages: NotRequired[int],
    rateLimit: NotRequired[int],

APISchemaTypeDef#

# APISchemaTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import APISchemaTypeDef


def get_value() -> APISchemaTypeDef:
    return {
        "payload": ...,
    }


# APISchemaTypeDef definition

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

AgentAliasHistoryEventTypeDef#

# AgentAliasHistoryEventTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentAliasHistoryEventTypeDef


def get_value() -> AgentAliasHistoryEventTypeDef:
    return {
        "endDate": ...,
    }


# AgentAliasHistoryEventTypeDef definition

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

AgentAliasSummaryTypeDef#

# AgentAliasSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentAliasSummaryTypeDef


def get_value() -> AgentAliasSummaryTypeDef:
    return {
        "agentAliasId": ...,
    }


# AgentAliasSummaryTypeDef definition

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

CreateAgentAliasRequestTypeDef#

# CreateAgentAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateAgentAliasRequestTypeDef


def get_value() -> CreateAgentAliasRequestTypeDef:
    return {
        "agentAliasName": ...,
    }


# CreateAgentAliasRequestTypeDef definition

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

UpdateAgentAliasRequestTypeDef#

# UpdateAgentAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentAliasRequestTypeDef


def get_value() -> UpdateAgentAliasRequestTypeDef:
    return {
        "agentAliasId": ...,
    }


# UpdateAgentAliasRequestTypeDef definition

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

AgentCollaboratorSummaryTypeDef#

# AgentCollaboratorSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentCollaboratorSummaryTypeDef


def get_value() -> AgentCollaboratorSummaryTypeDef:
    return {
        "agentDescriptor": ...,
    }


# AgentCollaboratorSummaryTypeDef definition

class AgentCollaboratorSummaryTypeDef(TypedDict):
    agentDescriptor: AgentDescriptorTypeDef,  # (1)
    agentId: str,
    agentVersion: str,
    collaborationInstruction: str,
    collaboratorId: str,
    collaboratorName: str,
    createdAt: datetime.datetime,
    lastUpdatedAt: datetime.datetime,
    relayConversationHistory: RelayConversationHistoryType,  # (2)
  1. See AgentDescriptorTypeDef
  2. See RelayConversationHistoryType

AgentCollaboratorTypeDef#

# AgentCollaboratorTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentCollaboratorTypeDef


def get_value() -> AgentCollaboratorTypeDef:
    return {
        "agentDescriptor": ...,
    }


# AgentCollaboratorTypeDef definition

class AgentCollaboratorTypeDef(TypedDict):
    agentDescriptor: AgentDescriptorTypeDef,  # (1)
    agentId: str,
    agentVersion: str,
    collaborationInstruction: str,
    collaboratorId: str,
    collaboratorName: str,
    createdAt: datetime.datetime,
    lastUpdatedAt: datetime.datetime,
    clientToken: NotRequired[str],
    relayConversationHistory: NotRequired[RelayConversationHistoryType],  # (2)
  1. See AgentDescriptorTypeDef
  2. See RelayConversationHistoryType

AssociateAgentCollaboratorRequestTypeDef#

# AssociateAgentCollaboratorRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AssociateAgentCollaboratorRequestTypeDef


def get_value() -> AssociateAgentCollaboratorRequestTypeDef:
    return {
        "agentDescriptor": ...,
    }


# AssociateAgentCollaboratorRequestTypeDef definition

class AssociateAgentCollaboratorRequestTypeDef(TypedDict):
    agentDescriptor: AgentDescriptorTypeDef,  # (1)
    agentId: str,
    agentVersion: str,
    collaborationInstruction: str,
    collaboratorName: str,
    clientToken: NotRequired[str],
    relayConversationHistory: NotRequired[RelayConversationHistoryType],  # (2)
  1. See AgentDescriptorTypeDef
  2. See RelayConversationHistoryType

UpdateAgentCollaboratorRequestTypeDef#

# UpdateAgentCollaboratorRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentCollaboratorRequestTypeDef


def get_value() -> UpdateAgentCollaboratorRequestTypeDef:
    return {
        "agentDescriptor": ...,
    }


# UpdateAgentCollaboratorRequestTypeDef definition

class UpdateAgentCollaboratorRequestTypeDef(TypedDict):
    agentDescriptor: AgentDescriptorTypeDef,  # (1)
    agentId: str,
    agentVersion: str,
    collaborationInstruction: str,
    collaboratorId: str,
    collaboratorName: str,
    relayConversationHistory: NotRequired[RelayConversationHistoryType],  # (2)
  1. See AgentDescriptorTypeDef
  2. See RelayConversationHistoryType

AgentSummaryTypeDef#

# AgentSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentSummaryTypeDef


def get_value() -> AgentSummaryTypeDef:
    return {
        "agentId": ...,
    }


# AgentSummaryTypeDef definition

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

AgentVersionSummaryTypeDef#

# AgentVersionSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentVersionSummaryTypeDef


def get_value() -> AgentVersionSummaryTypeDef:
    return {
        "agentName": ...,
    }


# AgentVersionSummaryTypeDef definition

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

KnowledgeBaseFlowNodeConfigurationTypeDef#

# KnowledgeBaseFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseFlowNodeConfigurationTypeDef


def get_value() -> KnowledgeBaseFlowNodeConfigurationTypeDef:
    return {
        "guardrailConfiguration": ...,
    }


# KnowledgeBaseFlowNodeConfigurationTypeDef definition

class KnowledgeBaseFlowNodeConfigurationTypeDef(TypedDict):
    knowledgeBaseId: str,
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (1)
    modelId: NotRequired[str],
  1. See GuardrailConfigurationTypeDef

AssociateAgentKnowledgeBaseResponseTypeDef#

# AssociateAgentKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AssociateAgentKnowledgeBaseResponseTypeDef


def get_value() -> AssociateAgentKnowledgeBaseResponseTypeDef:
    return {
        "agentKnowledgeBase": ...,
    }


# AssociateAgentKnowledgeBaseResponseTypeDef definition

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

DeleteAgentAliasResponseTypeDef#

# DeleteAgentAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentAliasResponseTypeDef


def get_value() -> DeleteAgentAliasResponseTypeDef:
    return {
        "agentAliasId": ...,
    }


# DeleteAgentAliasResponseTypeDef definition

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

DeleteAgentResponseTypeDef#

# DeleteAgentResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentResponseTypeDef


def get_value() -> DeleteAgentResponseTypeDef:
    return {
        "agentId": ...,
    }


# DeleteAgentResponseTypeDef definition

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

DeleteAgentVersionResponseTypeDef#

# DeleteAgentVersionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteAgentVersionResponseTypeDef


def get_value() -> DeleteAgentVersionResponseTypeDef:
    return {
        "agentId": ...,
    }


# DeleteAgentVersionResponseTypeDef definition

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

DeleteDataSourceResponseTypeDef#

# DeleteDataSourceResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteDataSourceResponseTypeDef


def get_value() -> DeleteDataSourceResponseTypeDef:
    return {
        "dataSourceId": ...,
    }


# DeleteDataSourceResponseTypeDef definition

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

DeleteFlowAliasResponseTypeDef#

# DeleteFlowAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteFlowAliasResponseTypeDef


def get_value() -> DeleteFlowAliasResponseTypeDef:
    return {
        "flowId": ...,
    }


# DeleteFlowAliasResponseTypeDef definition

class DeleteFlowAliasResponseTypeDef(TypedDict):
    flowId: str,
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteFlowResponseTypeDef#

# DeleteFlowResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteFlowResponseTypeDef


def get_value() -> DeleteFlowResponseTypeDef:
    return {
        "id": ...,
    }


# DeleteFlowResponseTypeDef definition

class DeleteFlowResponseTypeDef(TypedDict):
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteFlowVersionResponseTypeDef#

# DeleteFlowVersionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteFlowVersionResponseTypeDef


def get_value() -> DeleteFlowVersionResponseTypeDef:
    return {
        "id": ...,
    }


# DeleteFlowVersionResponseTypeDef definition

class DeleteFlowVersionResponseTypeDef(TypedDict):
    id: str,
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteKnowledgeBaseResponseTypeDef#

# DeleteKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteKnowledgeBaseResponseTypeDef


def get_value() -> DeleteKnowledgeBaseResponseTypeDef:
    return {
        "knowledgeBaseId": ...,
    }


# DeleteKnowledgeBaseResponseTypeDef definition

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

DeletePromptResponseTypeDef#

# DeletePromptResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeletePromptResponseTypeDef


def get_value() -> DeletePromptResponseTypeDef:
    return {
        "id": ...,
    }


# DeletePromptResponseTypeDef definition

class DeletePromptResponseTypeDef(TypedDict):
    id: str,
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAgentKnowledgeBaseResponseTypeDef#

# GetAgentKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentKnowledgeBaseResponseTypeDef


def get_value() -> GetAgentKnowledgeBaseResponseTypeDef:
    return {
        "agentKnowledgeBase": ...,
    }


# GetAgentKnowledgeBaseResponseTypeDef definition

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

ListAgentActionGroupsResponseTypeDef#

# ListAgentActionGroupsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentActionGroupsResponseTypeDef


def get_value() -> ListAgentActionGroupsResponseTypeDef:
    return {
        "actionGroupSummaries": ...,
    }


# ListAgentActionGroupsResponseTypeDef definition

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

ListAgentKnowledgeBasesResponseTypeDef#

# ListAgentKnowledgeBasesResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentKnowledgeBasesResponseTypeDef


def get_value() -> ListAgentKnowledgeBasesResponseTypeDef:
    return {
        "agentKnowledgeBaseSummaries": ...,
    }


# ListAgentKnowledgeBasesResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

PrepareAgentResponseTypeDef#

# PrepareAgentResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PrepareAgentResponseTypeDef


def get_value() -> PrepareAgentResponseTypeDef:
    return {
        "agentId": ...,
    }


# PrepareAgentResponseTypeDef definition

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

PrepareFlowResponseTypeDef#

# PrepareFlowResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PrepareFlowResponseTypeDef


def get_value() -> PrepareFlowResponseTypeDef:
    return {
        "id": ...,
    }


# PrepareFlowResponseTypeDef definition

class PrepareFlowResponseTypeDef(TypedDict):
    id: str,
    status: FlowStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowStatusType
  2. See ResponseMetadataTypeDef

UpdateAgentKnowledgeBaseResponseTypeDef#

# UpdateAgentKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentKnowledgeBaseResponseTypeDef


def get_value() -> UpdateAgentKnowledgeBaseResponseTypeDef:
    return {
        "agentKnowledgeBase": ...,
    }


# UpdateAgentKnowledgeBaseResponseTypeDef definition

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

EmbeddingModelConfigurationTypeDef#

# EmbeddingModelConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import EmbeddingModelConfigurationTypeDef


def get_value() -> EmbeddingModelConfigurationTypeDef:
    return {
        "bedrockEmbeddingModelConfiguration": ...,
    }


# EmbeddingModelConfigurationTypeDef definition

class EmbeddingModelConfigurationTypeDef(TypedDict):
    bedrockEmbeddingModelConfiguration: NotRequired[BedrockEmbeddingModelConfigurationTypeDef],  # (1)
  1. See BedrockEmbeddingModelConfigurationTypeDef

BedrockFoundationModelConfigurationTypeDef#

# BedrockFoundationModelConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import BedrockFoundationModelConfigurationTypeDef


def get_value() -> BedrockFoundationModelConfigurationTypeDef:
    return {
        "modelArn": ...,
    }


# BedrockFoundationModelConfigurationTypeDef definition

class BedrockFoundationModelConfigurationTypeDef(TypedDict):
    modelArn: str,
    parsingModality: NotRequired[ParsingModalityType],  # (1)
    parsingPrompt: NotRequired[ParsingPromptTypeDef],  # (2)
  1. See ParsingModalityType
  2. See ParsingPromptTypeDef

BedrockFoundationModelContextEnrichmentConfigurationTypeDef#

# BedrockFoundationModelContextEnrichmentConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import BedrockFoundationModelContextEnrichmentConfigurationTypeDef


def get_value() -> BedrockFoundationModelContextEnrichmentConfigurationTypeDef:
    return {
        "enrichmentStrategyConfiguration": ...,
    }


# BedrockFoundationModelContextEnrichmentConfigurationTypeDef definition

class BedrockFoundationModelContextEnrichmentConfigurationTypeDef(TypedDict):
    enrichmentStrategyConfiguration: EnrichmentStrategyConfigurationTypeDef,  # (1)
    modelArn: str,
  1. See EnrichmentStrategyConfigurationTypeDef

ByteContentDocTypeDef#

# ByteContentDocTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ByteContentDocTypeDef


def get_value() -> ByteContentDocTypeDef:
    return {
        "data": ...,
    }


# ByteContentDocTypeDef definition

class ByteContentDocTypeDef(TypedDict):
    data: BlobTypeDef,
    mimeType: str,

ContentBlockTypeDef#

# ContentBlockTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ContentBlockTypeDef


def get_value() -> ContentBlockTypeDef:
    return {
        "cachePoint": ...,
    }


# ContentBlockTypeDef definition

class ContentBlockTypeDef(TypedDict):
    cachePoint: NotRequired[CachePointBlockTypeDef],  # (1)
    text: NotRequired[str],
  1. See CachePointBlockTypeDef

SystemContentBlockTypeDef#

# SystemContentBlockTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SystemContentBlockTypeDef


def get_value() -> SystemContentBlockTypeDef:
    return {
        "cachePoint": ...,
    }


# SystemContentBlockTypeDef definition

class SystemContentBlockTypeDef(TypedDict):
    cachePoint: NotRequired[CachePointBlockTypeDef],  # (1)
    text: NotRequired[str],
  1. See CachePointBlockTypeDef

TextPromptTemplateConfigurationOutputTypeDef#

# TextPromptTemplateConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TextPromptTemplateConfigurationOutputTypeDef


def get_value() -> TextPromptTemplateConfigurationOutputTypeDef:
    return {
        "cachePoint": ...,
    }


# TextPromptTemplateConfigurationOutputTypeDef definition

class TextPromptTemplateConfigurationOutputTypeDef(TypedDict):
    text: str,
    cachePoint: NotRequired[CachePointBlockTypeDef],  # (1)
    inputVariables: NotRequired[List[PromptInputVariableTypeDef]],  # (2)
  1. See CachePointBlockTypeDef
  2. See List[PromptInputVariableTypeDef]

TextPromptTemplateConfigurationTypeDef#

# TextPromptTemplateConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TextPromptTemplateConfigurationTypeDef


def get_value() -> TextPromptTemplateConfigurationTypeDef:
    return {
        "cachePoint": ...,
    }


# TextPromptTemplateConfigurationTypeDef definition

class TextPromptTemplateConfigurationTypeDef(TypedDict):
    text: str,
    cachePoint: NotRequired[CachePointBlockTypeDef],  # (1)
    inputVariables: NotRequired[Sequence[PromptInputVariableTypeDef]],  # (2)
  1. See CachePointBlockTypeDef
  2. See Sequence[PromptInputVariableTypeDef]

ConditionFlowNodeConfigurationOutputTypeDef#

# ConditionFlowNodeConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConditionFlowNodeConfigurationOutputTypeDef


def get_value() -> ConditionFlowNodeConfigurationOutputTypeDef:
    return {
        "conditions": ...,
    }


# ConditionFlowNodeConfigurationOutputTypeDef definition

class ConditionFlowNodeConfigurationOutputTypeDef(TypedDict):
    conditions: List[FlowConditionTypeDef],  # (1)
  1. See List[FlowConditionTypeDef]

ConditionFlowNodeConfigurationTypeDef#

# ConditionFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConditionFlowNodeConfigurationTypeDef


def get_value() -> ConditionFlowNodeConfigurationTypeDef:
    return {
        "conditions": ...,
    }


# ConditionFlowNodeConfigurationTypeDef definition

class ConditionFlowNodeConfigurationTypeDef(TypedDict):
    conditions: Sequence[FlowConditionTypeDef],  # (1)
  1. See Sequence[FlowConditionTypeDef]

CreateFlowAliasRequestTypeDef#

# CreateFlowAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateFlowAliasRequestTypeDef


def get_value() -> CreateFlowAliasRequestTypeDef:
    return {
        "flowIdentifier": ...,
    }


# CreateFlowAliasRequestTypeDef definition

class CreateFlowAliasRequestTypeDef(TypedDict):
    flowIdentifier: str,
    name: str,
    routingConfiguration: Sequence[FlowAliasRoutingConfigurationListItemTypeDef],  # (1)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See Sequence[FlowAliasRoutingConfigurationListItemTypeDef]

CreateFlowAliasResponseTypeDef#

# CreateFlowAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateFlowAliasResponseTypeDef


def get_value() -> CreateFlowAliasResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateFlowAliasResponseTypeDef definition

class CreateFlowAliasResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    description: str,
    flowId: str,
    id: str,
    name: str,
    routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef],  # (1)
    updatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[FlowAliasRoutingConfigurationListItemTypeDef]
  2. See ResponseMetadataTypeDef

FlowAliasSummaryTypeDef#

# FlowAliasSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowAliasSummaryTypeDef


def get_value() -> FlowAliasSummaryTypeDef:
    return {
        "arn": ...,
    }


# FlowAliasSummaryTypeDef definition

class FlowAliasSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    flowId: str,
    id: str,
    name: str,
    routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef],  # (1)
    updatedAt: datetime.datetime,
    description: NotRequired[str],
  1. See List[FlowAliasRoutingConfigurationListItemTypeDef]

GetFlowAliasResponseTypeDef#

# GetFlowAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetFlowAliasResponseTypeDef


def get_value() -> GetFlowAliasResponseTypeDef:
    return {
        "arn": ...,
    }


# GetFlowAliasResponseTypeDef definition

class GetFlowAliasResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    description: str,
    flowId: str,
    id: str,
    name: str,
    routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef],  # (1)
    updatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[FlowAliasRoutingConfigurationListItemTypeDef]
  2. See ResponseMetadataTypeDef

UpdateFlowAliasRequestTypeDef#

# UpdateFlowAliasRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateFlowAliasRequestTypeDef


def get_value() -> UpdateFlowAliasRequestTypeDef:
    return {
        "aliasIdentifier": ...,
    }


# UpdateFlowAliasRequestTypeDef definition

class UpdateFlowAliasRequestTypeDef(TypedDict):
    aliasIdentifier: str,
    flowIdentifier: str,
    name: str,
    routingConfiguration: Sequence[FlowAliasRoutingConfigurationListItemTypeDef],  # (1)
    description: NotRequired[str],
  1. See Sequence[FlowAliasRoutingConfigurationListItemTypeDef]

UpdateFlowAliasResponseTypeDef#

# UpdateFlowAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateFlowAliasResponseTypeDef


def get_value() -> UpdateFlowAliasResponseTypeDef:
    return {
        "arn": ...,
    }


# UpdateFlowAliasResponseTypeDef definition

class UpdateFlowAliasResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    description: str,
    flowId: str,
    id: str,
    name: str,
    routingConfiguration: List[FlowAliasRoutingConfigurationListItemTypeDef],  # (1)
    updatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[FlowAliasRoutingConfigurationListItemTypeDef]
  2. See ResponseMetadataTypeDef

CustomOrchestrationTypeDef#

# CustomOrchestrationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CustomOrchestrationTypeDef


def get_value() -> CustomOrchestrationTypeDef:
    return {
        "executor": ...,
    }


# CustomOrchestrationTypeDef definition

class CustomOrchestrationTypeDef(TypedDict):
    executor: NotRequired[OrchestrationExecutorTypeDef],  # (1)
  1. See OrchestrationExecutorTypeDef

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListDataSourcesResponseTypeDef


def get_value() -> ListDataSourcesResponseTypeDef:
    return {
        "dataSourceSummaries": ...,
    }


# ListDataSourcesResponseTypeDef definition

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

DocumentIdentifierTypeDef#

# DocumentIdentifierTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DocumentIdentifierTypeDef


def get_value() -> DocumentIdentifierTypeDef:
    return {
        "custom": ...,
    }


# DocumentIdentifierTypeDef definition

class DocumentIdentifierTypeDef(TypedDict):
    dataSourceType: ContentDataSourceTypeType,  # (2)
    custom: NotRequired[CustomDocumentIdentifierTypeDef],  # (1)
    s3: NotRequired[S3LocationTypeDef],  # (3)
  1. See CustomDocumentIdentifierTypeDef
  2. See ContentDataSourceTypeType
  3. See S3LocationTypeDef

IntermediateStorageTypeDef#

# IntermediateStorageTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IntermediateStorageTypeDef


def get_value() -> IntermediateStorageTypeDef:
    return {
        "s3Location": ...,
    }


# IntermediateStorageTypeDef definition

class IntermediateStorageTypeDef(TypedDict):
    s3Location: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

S3ContentTypeDef#

# S3ContentTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import S3ContentTypeDef


def get_value() -> S3ContentTypeDef:
    return {
        "s3Location": ...,
    }


# S3ContentTypeDef definition

class S3ContentTypeDef(TypedDict):
    s3Location: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

SupplementalDataStorageLocationTypeDef#

# SupplementalDataStorageLocationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SupplementalDataStorageLocationTypeDef


def get_value() -> SupplementalDataStorageLocationTypeDef:
    return {
        "s3Location": ...,
    }


# SupplementalDataStorageLocationTypeDef definition

class SupplementalDataStorageLocationTypeDef(TypedDict):
    type: SupplementalDataStorageLocationTypeType,  # (2)
    s3Location: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef
  2. See SupplementalDataStorageLocationTypeType

FlowConnectionConfigurationTypeDef#

# FlowConnectionConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowConnectionConfigurationTypeDef


def get_value() -> FlowConnectionConfigurationTypeDef:
    return {
        "conditional": ...,
    }


# FlowConnectionConfigurationTypeDef definition

class FlowConnectionConfigurationTypeDef(TypedDict):
    conditional: NotRequired[FlowConditionalConnectionConfigurationTypeDef],  # (1)
    data: NotRequired[FlowDataConnectionConfigurationTypeDef],  # (2)
  1. See FlowConditionalConnectionConfigurationTypeDef
  2. See FlowDataConnectionConfigurationTypeDef

ListFlowsResponseTypeDef#

# ListFlowsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowsResponseTypeDef


def get_value() -> ListFlowsResponseTypeDef:
    return {
        "flowSummaries": ...,
    }


# ListFlowsResponseTypeDef definition

class ListFlowsResponseTypeDef(TypedDict):
    flowSummaries: List[FlowSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[FlowSummaryTypeDef]
  2. See ResponseMetadataTypeDef

FlowValidationDetailsTypeDef#

# FlowValidationDetailsTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowValidationDetailsTypeDef


def get_value() -> FlowValidationDetailsTypeDef:
    return {
        "cyclicConnection": ...,
    }


# FlowValidationDetailsTypeDef definition

class FlowValidationDetailsTypeDef(TypedDict):
    cyclicConnection: NotRequired[CyclicConnectionFlowValidationDetailsTypeDef],  # (1)
    duplicateConditionExpression: NotRequired[DuplicateConditionExpressionFlowValidationDetailsTypeDef],  # (2)
    duplicateConnections: NotRequired[DuplicateConnectionsFlowValidationDetailsTypeDef],  # (3)
    incompatibleConnectionDataType: NotRequired[IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef],  # (4)
    malformedConditionExpression: NotRequired[MalformedConditionExpressionFlowValidationDetailsTypeDef],  # (5)
    malformedNodeInputExpression: NotRequired[MalformedNodeInputExpressionFlowValidationDetailsTypeDef],  # (6)
    mismatchedNodeInputType: NotRequired[MismatchedNodeInputTypeFlowValidationDetailsTypeDef],  # (7)
    mismatchedNodeOutputType: NotRequired[MismatchedNodeOutputTypeFlowValidationDetailsTypeDef],  # (8)
    missingConnectionConfiguration: NotRequired[MissingConnectionConfigurationFlowValidationDetailsTypeDef],  # (9)
    missingDefaultCondition: NotRequired[MissingDefaultConditionFlowValidationDetailsTypeDef],  # (10)
    missingEndingNodes: NotRequired[Dict[str, Any]],
    missingNodeConfiguration: NotRequired[MissingNodeConfigurationFlowValidationDetailsTypeDef],  # (11)
    missingNodeInput: NotRequired[MissingNodeInputFlowValidationDetailsTypeDef],  # (12)
    missingNodeOutput: NotRequired[MissingNodeOutputFlowValidationDetailsTypeDef],  # (13)
    missingStartingNodes: NotRequired[Dict[str, Any]],
    multipleNodeInputConnections: NotRequired[MultipleNodeInputConnectionsFlowValidationDetailsTypeDef],  # (14)
    unfulfilledNodeInput: NotRequired[UnfulfilledNodeInputFlowValidationDetailsTypeDef],  # (15)
    unknownConnectionCondition: NotRequired[UnknownConnectionConditionFlowValidationDetailsTypeDef],  # (16)
    unknownConnectionSource: NotRequired[UnknownConnectionSourceFlowValidationDetailsTypeDef],  # (17)
    unknownConnectionSourceOutput: NotRequired[UnknownConnectionSourceOutputFlowValidationDetailsTypeDef],  # (18)
    unknownConnectionTarget: NotRequired[UnknownConnectionTargetFlowValidationDetailsTypeDef],  # (19)
    unknownConnectionTargetInput: NotRequired[UnknownConnectionTargetInputFlowValidationDetailsTypeDef],  # (20)
    unknownNodeInput: NotRequired[UnknownNodeInputFlowValidationDetailsTypeDef],  # (21)
    unknownNodeOutput: NotRequired[UnknownNodeOutputFlowValidationDetailsTypeDef],  # (22)
    unreachableNode: NotRequired[UnreachableNodeFlowValidationDetailsTypeDef],  # (23)
    unsatisfiedConnectionConditions: NotRequired[UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef],  # (24)
    unspecified: NotRequired[Dict[str, Any]],
  1. See CyclicConnectionFlowValidationDetailsTypeDef
  2. See DuplicateConditionExpressionFlowValidationDetailsTypeDef
  3. See DuplicateConnectionsFlowValidationDetailsTypeDef
  4. See IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef
  5. See MalformedConditionExpressionFlowValidationDetailsTypeDef
  6. See MalformedNodeInputExpressionFlowValidationDetailsTypeDef
  7. See MismatchedNodeInputTypeFlowValidationDetailsTypeDef
  8. See MismatchedNodeOutputTypeFlowValidationDetailsTypeDef
  9. See MissingConnectionConfigurationFlowValidationDetailsTypeDef
  10. See MissingDefaultConditionFlowValidationDetailsTypeDef
  11. See MissingNodeConfigurationFlowValidationDetailsTypeDef
  12. See MissingNodeInputFlowValidationDetailsTypeDef
  13. See MissingNodeOutputFlowValidationDetailsTypeDef
  14. See MultipleNodeInputConnectionsFlowValidationDetailsTypeDef
  15. See UnfulfilledNodeInputFlowValidationDetailsTypeDef
  16. See UnknownConnectionConditionFlowValidationDetailsTypeDef
  17. See UnknownConnectionSourceFlowValidationDetailsTypeDef
  18. See UnknownConnectionSourceOutputFlowValidationDetailsTypeDef
  19. See UnknownConnectionTargetFlowValidationDetailsTypeDef
  20. See UnknownConnectionTargetInputFlowValidationDetailsTypeDef
  21. See UnknownNodeInputFlowValidationDetailsTypeDef
  22. See UnknownNodeOutputFlowValidationDetailsTypeDef
  23. See UnreachableNodeFlowValidationDetailsTypeDef
  24. See UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef

ListFlowVersionsResponseTypeDef#

# ListFlowVersionsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowVersionsResponseTypeDef


def get_value() -> ListFlowVersionsResponseTypeDef:
    return {
        "flowVersionSummaries": ...,
    }


# ListFlowVersionsResponseTypeDef definition

class ListFlowVersionsResponseTypeDef(TypedDict):
    flowVersionSummaries: List[FlowVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[FlowVersionSummaryTypeDef]
  2. See ResponseMetadataTypeDef

FunctionOutputTypeDef#

# FunctionOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FunctionOutputTypeDef


def get_value() -> FunctionOutputTypeDef:
    return {
        "description": ...,
    }


# FunctionOutputTypeDef definition

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

FunctionTypeDef#

# FunctionTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FunctionTypeDef


def get_value() -> FunctionTypeDef:
    return {
        "description": ...,
    }


# FunctionTypeDef definition

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

HierarchicalChunkingConfigurationOutputTypeDef#

# HierarchicalChunkingConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import HierarchicalChunkingConfigurationOutputTypeDef


def get_value() -> HierarchicalChunkingConfigurationOutputTypeDef:
    return {
        "levelConfigurations": ...,
    }


# HierarchicalChunkingConfigurationOutputTypeDef definition

class HierarchicalChunkingConfigurationOutputTypeDef(TypedDict):
    levelConfigurations: List[HierarchicalChunkingLevelConfigurationTypeDef],  # (1)
    overlapTokens: int,
  1. See List[HierarchicalChunkingLevelConfigurationTypeDef]

HierarchicalChunkingConfigurationTypeDef#

# HierarchicalChunkingConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import HierarchicalChunkingConfigurationTypeDef


def get_value() -> HierarchicalChunkingConfigurationTypeDef:
    return {
        "levelConfigurations": ...,
    }


# HierarchicalChunkingConfigurationTypeDef definition

class HierarchicalChunkingConfigurationTypeDef(TypedDict):
    levelConfigurations: Sequence[HierarchicalChunkingLevelConfigurationTypeDef],  # (1)
    overlapTokens: int,
  1. See Sequence[HierarchicalChunkingLevelConfigurationTypeDef]

PromptConfigurationOutputTypeDef#

# PromptConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptConfigurationOutputTypeDef


def get_value() -> PromptConfigurationOutputTypeDef:
    return {
        "additionalModelRequestFields": ...,
    }


# PromptConfigurationOutputTypeDef definition

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

PromptConfigurationTypeDef#

# PromptConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptConfigurationTypeDef


def get_value() -> PromptConfigurationTypeDef:
    return {
        "additionalModelRequestFields": ...,
    }


# PromptConfigurationTypeDef definition

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

ListIngestionJobsRequestTypeDef#

# ListIngestionJobsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListIngestionJobsRequestTypeDef


def get_value() -> ListIngestionJobsRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# ListIngestionJobsRequestTypeDef definition

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

IngestionJobSummaryTypeDef#

# IngestionJobSummaryTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestionJobSummaryTypeDef


def get_value() -> IngestionJobSummaryTypeDef:
    return {
        "dataSourceId": ...,
    }


# IngestionJobSummaryTypeDef definition

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

IngestionJobTypeDef#

# IngestionJobTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestionJobTypeDef


def get_value() -> IngestionJobTypeDef:
    return {
        "dataSourceId": ...,
    }


# IngestionJobTypeDef definition

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

ListKnowledgeBasesResponseTypeDef#

# ListKnowledgeBasesResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListKnowledgeBasesResponseTypeDef


def get_value() -> ListKnowledgeBasesResponseTypeDef:
    return {
        "knowledgeBaseSummaries": ...,
    }


# ListKnowledgeBasesResponseTypeDef definition

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

ListAgentActionGroupsRequestPaginateTypeDef#

# ListAgentActionGroupsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentActionGroupsRequestPaginateTypeDef


def get_value() -> ListAgentActionGroupsRequestPaginateTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentActionGroupsRequestPaginateTypeDef definition

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

ListAgentAliasesRequestPaginateTypeDef#

# ListAgentAliasesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentAliasesRequestPaginateTypeDef


def get_value() -> ListAgentAliasesRequestPaginateTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentAliasesRequestPaginateTypeDef definition

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

ListAgentCollaboratorsRequestPaginateTypeDef#

# ListAgentCollaboratorsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentCollaboratorsRequestPaginateTypeDef


def get_value() -> ListAgentCollaboratorsRequestPaginateTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentCollaboratorsRequestPaginateTypeDef definition

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

ListAgentKnowledgeBasesRequestPaginateTypeDef#

# ListAgentKnowledgeBasesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentKnowledgeBasesRequestPaginateTypeDef


def get_value() -> ListAgentKnowledgeBasesRequestPaginateTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentKnowledgeBasesRequestPaginateTypeDef definition

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

ListAgentVersionsRequestPaginateTypeDef#

# ListAgentVersionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentVersionsRequestPaginateTypeDef


def get_value() -> ListAgentVersionsRequestPaginateTypeDef:
    return {
        "agentId": ...,
    }


# ListAgentVersionsRequestPaginateTypeDef definition

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

ListAgentsRequestPaginateTypeDef#

# ListAgentsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentsRequestPaginateTypeDef


def get_value() -> ListAgentsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListAgentsRequestPaginateTypeDef definition

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

ListDataSourcesRequestPaginateTypeDef#

# ListDataSourcesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListDataSourcesRequestPaginateTypeDef


def get_value() -> ListDataSourcesRequestPaginateTypeDef:
    return {
        "knowledgeBaseId": ...,
    }


# ListDataSourcesRequestPaginateTypeDef definition

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

ListFlowAliasesRequestPaginateTypeDef#

# ListFlowAliasesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowAliasesRequestPaginateTypeDef


def get_value() -> ListFlowAliasesRequestPaginateTypeDef:
    return {
        "flowIdentifier": ...,
    }


# ListFlowAliasesRequestPaginateTypeDef definition

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

ListFlowVersionsRequestPaginateTypeDef#

# ListFlowVersionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowVersionsRequestPaginateTypeDef


def get_value() -> ListFlowVersionsRequestPaginateTypeDef:
    return {
        "flowIdentifier": ...,
    }


# ListFlowVersionsRequestPaginateTypeDef definition

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

ListFlowsRequestPaginateTypeDef#

# ListFlowsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowsRequestPaginateTypeDef


def get_value() -> ListFlowsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListFlowsRequestPaginateTypeDef definition

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

ListIngestionJobsRequestPaginateTypeDef#

# ListIngestionJobsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListIngestionJobsRequestPaginateTypeDef


def get_value() -> ListIngestionJobsRequestPaginateTypeDef:
    return {
        "dataSourceId": ...,
    }


# ListIngestionJobsRequestPaginateTypeDef definition

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

ListKnowledgeBaseDocumentsRequestPaginateTypeDef#

# ListKnowledgeBaseDocumentsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListKnowledgeBaseDocumentsRequestPaginateTypeDef


def get_value() -> ListKnowledgeBaseDocumentsRequestPaginateTypeDef:
    return {
        "dataSourceId": ...,
    }


# ListKnowledgeBaseDocumentsRequestPaginateTypeDef definition

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

ListKnowledgeBasesRequestPaginateTypeDef#

# ListKnowledgeBasesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListKnowledgeBasesRequestPaginateTypeDef


def get_value() -> ListKnowledgeBasesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListKnowledgeBasesRequestPaginateTypeDef definition

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

ListPromptsRequestPaginateTypeDef#

# ListPromptsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListPromptsRequestPaginateTypeDef


def get_value() -> ListPromptsRequestPaginateTypeDef:
    return {
        "promptIdentifier": ...,
    }


# ListPromptsRequestPaginateTypeDef definition

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

ListPromptsResponseTypeDef#

# ListPromptsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListPromptsResponseTypeDef


def get_value() -> ListPromptsResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListPromptsResponseTypeDef definition

class ListPromptsResponseTypeDef(TypedDict):
    promptSummaries: List[PromptSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[PromptSummaryTypeDef]
  2. See ResponseMetadataTypeDef

MemoryConfigurationOutputTypeDef#

# MemoryConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MemoryConfigurationOutputTypeDef


def get_value() -> MemoryConfigurationOutputTypeDef:
    return {
        "enabledMemoryTypes": ...,
    }


# MemoryConfigurationOutputTypeDef definition

class MemoryConfigurationOutputTypeDef(TypedDict):
    enabledMemoryTypes: List[MemoryTypeType],  # (1)
    sessionSummaryConfiguration: NotRequired[SessionSummaryConfigurationTypeDef],  # (2)
    storageDays: NotRequired[int],
  1. See List[Literal['SESSION_SUMMARY']]
  2. See SessionSummaryConfigurationTypeDef

MemoryConfigurationTypeDef#

# MemoryConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MemoryConfigurationTypeDef


def get_value() -> MemoryConfigurationTypeDef:
    return {
        "enabledMemoryTypes": ...,
    }


# MemoryConfigurationTypeDef definition

class MemoryConfigurationTypeDef(TypedDict):
    enabledMemoryTypes: Sequence[MemoryTypeType],  # (1)
    sessionSummaryConfiguration: NotRequired[SessionSummaryConfigurationTypeDef],  # (2)
    storageDays: NotRequired[int],
  1. See Sequence[Literal['SESSION_SUMMARY']]
  2. See SessionSummaryConfigurationTypeDef

MetadataAttributeTypeDef#

# MetadataAttributeTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MetadataAttributeTypeDef


def get_value() -> MetadataAttributeTypeDef:
    return {
        "key": ...,
    }


# MetadataAttributeTypeDef definition

class MetadataAttributeTypeDef(TypedDict):
    key: str,
    value: MetadataAttributeValueTypeDef,  # (1)
  1. See MetadataAttributeValueTypeDef

MongoDbAtlasConfigurationTypeDef#

# MongoDbAtlasConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MongoDbAtlasConfigurationTypeDef


def get_value() -> MongoDbAtlasConfigurationTypeDef:
    return {
        "collectionName": ...,
    }


# MongoDbAtlasConfigurationTypeDef definition

class MongoDbAtlasConfigurationTypeDef(TypedDict):
    collectionName: str,
    credentialsSecretArn: str,
    databaseName: str,
    endpoint: str,
    fieldMapping: MongoDbAtlasFieldMappingTypeDef,  # (1)
    vectorIndexName: str,
    endpointServiceName: NotRequired[str],
    textIndexName: NotRequired[str],
  1. See MongoDbAtlasFieldMappingTypeDef

NeptuneAnalyticsConfigurationTypeDef#

# NeptuneAnalyticsConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import NeptuneAnalyticsConfigurationTypeDef


def get_value() -> NeptuneAnalyticsConfigurationTypeDef:
    return {
        "fieldMapping": ...,
    }


# NeptuneAnalyticsConfigurationTypeDef definition

class NeptuneAnalyticsConfigurationTypeDef(TypedDict):
    fieldMapping: NeptuneAnalyticsFieldMappingTypeDef,  # (1)
    graphArn: str,
  1. See NeptuneAnalyticsFieldMappingTypeDef

OpenSearchManagedClusterConfigurationTypeDef#

# OpenSearchManagedClusterConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import OpenSearchManagedClusterConfigurationTypeDef


def get_value() -> OpenSearchManagedClusterConfigurationTypeDef:
    return {
        "domainArn": ...,
    }


# OpenSearchManagedClusterConfigurationTypeDef definition

class OpenSearchManagedClusterConfigurationTypeDef(TypedDict):
    domainArn: str,
    domainEndpoint: str,
    fieldMapping: OpenSearchManagedClusterFieldMappingTypeDef,  # (1)
    vectorIndexName: str,
  1. See OpenSearchManagedClusterFieldMappingTypeDef

OpenSearchServerlessConfigurationTypeDef#

# OpenSearchServerlessConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import OpenSearchServerlessConfigurationTypeDef


def get_value() -> OpenSearchServerlessConfigurationTypeDef:
    return {
        "collectionArn": ...,
    }


# OpenSearchServerlessConfigurationTypeDef definition

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

PatternObjectFilterConfigurationOutputTypeDef#

# PatternObjectFilterConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PatternObjectFilterConfigurationOutputTypeDef


def get_value() -> PatternObjectFilterConfigurationOutputTypeDef:
    return {
        "filters": ...,
    }


# PatternObjectFilterConfigurationOutputTypeDef definition

class PatternObjectFilterConfigurationOutputTypeDef(TypedDict):
    filters: List[PatternObjectFilterOutputTypeDef],  # (1)
  1. See List[PatternObjectFilterOutputTypeDef]

PatternObjectFilterConfigurationTypeDef#

# PatternObjectFilterConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PatternObjectFilterConfigurationTypeDef


def get_value() -> PatternObjectFilterConfigurationTypeDef:
    return {
        "filters": ...,
    }


# PatternObjectFilterConfigurationTypeDef definition

class PatternObjectFilterConfigurationTypeDef(TypedDict):
    filters: Sequence[PatternObjectFilterTypeDef],  # (1)
  1. See Sequence[PatternObjectFilterTypeDef]

PineconeConfigurationTypeDef#

# PineconeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PineconeConfigurationTypeDef


def get_value() -> PineconeConfigurationTypeDef:
    return {
        "connectionString": ...,
    }


# PineconeConfigurationTypeDef definition

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

PromptGenAiResourceTypeDef#

# PromptGenAiResourceTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptGenAiResourceTypeDef


def get_value() -> PromptGenAiResourceTypeDef:
    return {
        "agent": ...,
    }


# PromptGenAiResourceTypeDef definition

class PromptGenAiResourceTypeDef(TypedDict):
    agent: NotRequired[PromptAgentResourceTypeDef],  # (1)
  1. See PromptAgentResourceTypeDef

PromptInferenceConfigurationOutputTypeDef#

# PromptInferenceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptInferenceConfigurationOutputTypeDef


def get_value() -> PromptInferenceConfigurationOutputTypeDef:
    return {
        "text": ...,
    }


# PromptInferenceConfigurationOutputTypeDef definition

class PromptInferenceConfigurationOutputTypeDef(TypedDict):
    text: NotRequired[PromptModelInferenceConfigurationOutputTypeDef],  # (1)
  1. See PromptModelInferenceConfigurationOutputTypeDef

QueryGenerationTableOutputTypeDef#

# QueryGenerationTableOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationTableOutputTypeDef


def get_value() -> QueryGenerationTableOutputTypeDef:
    return {
        "columns": ...,
    }


# QueryGenerationTableOutputTypeDef definition

class QueryGenerationTableOutputTypeDef(TypedDict):
    name: str,
    columns: NotRequired[List[QueryGenerationColumnTypeDef]],  # (1)
    description: NotRequired[str],
    inclusion: NotRequired[IncludeExcludeType],  # (2)
  1. See List[QueryGenerationColumnTypeDef]
  2. See IncludeExcludeType

QueryGenerationTableTypeDef#

# QueryGenerationTableTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationTableTypeDef


def get_value() -> QueryGenerationTableTypeDef:
    return {
        "columns": ...,
    }


# QueryGenerationTableTypeDef definition

class QueryGenerationTableTypeDef(TypedDict):
    name: str,
    columns: NotRequired[Sequence[QueryGenerationColumnTypeDef]],  # (1)
    description: NotRequired[str],
    inclusion: NotRequired[IncludeExcludeType],  # (2)
  1. See Sequence[QueryGenerationColumnTypeDef]
  2. See IncludeExcludeType

RdsConfigurationTypeDef#

# RdsConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RdsConfigurationTypeDef


def get_value() -> RdsConfigurationTypeDef:
    return {
        "credentialsSecretArn": ...,
    }


# RdsConfigurationTypeDef definition

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

RedisEnterpriseCloudConfigurationTypeDef#

# RedisEnterpriseCloudConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedisEnterpriseCloudConfigurationTypeDef


def get_value() -> RedisEnterpriseCloudConfigurationTypeDef:
    return {
        "credentialsSecretArn": ...,
    }


# RedisEnterpriseCloudConfigurationTypeDef definition

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

RedshiftProvisionedConfigurationTypeDef#

# RedshiftProvisionedConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftProvisionedConfigurationTypeDef


def get_value() -> RedshiftProvisionedConfigurationTypeDef:
    return {
        "authConfiguration": ...,
    }


# RedshiftProvisionedConfigurationTypeDef definition

class RedshiftProvisionedConfigurationTypeDef(TypedDict):
    authConfiguration: RedshiftProvisionedAuthConfigurationTypeDef,  # (1)
    clusterIdentifier: str,
  1. See RedshiftProvisionedAuthConfigurationTypeDef

RedshiftQueryEngineStorageConfigurationOutputTypeDef#

# RedshiftQueryEngineStorageConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftQueryEngineStorageConfigurationOutputTypeDef


def get_value() -> RedshiftQueryEngineStorageConfigurationOutputTypeDef:
    return {
        "awsDataCatalogConfiguration": ...,
    }


# RedshiftQueryEngineStorageConfigurationOutputTypeDef definition

class RedshiftQueryEngineStorageConfigurationOutputTypeDef(TypedDict):
    type: RedshiftQueryEngineStorageTypeType,  # (3)
    awsDataCatalogConfiguration: NotRequired[RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef],  # (1)
    redshiftConfiguration: NotRequired[RedshiftQueryEngineRedshiftStorageConfigurationTypeDef],  # (2)
  1. See RedshiftQueryEngineAwsDataCatalogStorageConfigurationOutputTypeDef
  2. See RedshiftQueryEngineRedshiftStorageConfigurationTypeDef
  3. See RedshiftQueryEngineStorageTypeType

RedshiftQueryEngineStorageConfigurationTypeDef#

# RedshiftQueryEngineStorageConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftQueryEngineStorageConfigurationTypeDef


def get_value() -> RedshiftQueryEngineStorageConfigurationTypeDef:
    return {
        "awsDataCatalogConfiguration": ...,
    }


# RedshiftQueryEngineStorageConfigurationTypeDef definition

class RedshiftQueryEngineStorageConfigurationTypeDef(TypedDict):
    type: RedshiftQueryEngineStorageTypeType,  # (3)
    awsDataCatalogConfiguration: NotRequired[RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef],  # (1)
    redshiftConfiguration: NotRequired[RedshiftQueryEngineRedshiftStorageConfigurationTypeDef],  # (2)
  1. See RedshiftQueryEngineAwsDataCatalogStorageConfigurationTypeDef
  2. See RedshiftQueryEngineRedshiftStorageConfigurationTypeDef
  3. See RedshiftQueryEngineStorageTypeType

RedshiftServerlessConfigurationTypeDef#

# RedshiftServerlessConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftServerlessConfigurationTypeDef


def get_value() -> RedshiftServerlessConfigurationTypeDef:
    return {
        "authConfiguration": ...,
    }


# RedshiftServerlessConfigurationTypeDef definition

class RedshiftServerlessConfigurationTypeDef(TypedDict):
    authConfiguration: RedshiftServerlessAuthConfigurationTypeDef,  # (1)
    workgroupArn: str,
  1. See RedshiftServerlessAuthConfigurationTypeDef

RetrievalFlowNodeServiceConfigurationTypeDef#

# RetrievalFlowNodeServiceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RetrievalFlowNodeServiceConfigurationTypeDef


def get_value() -> RetrievalFlowNodeServiceConfigurationTypeDef:
    return {
        "s3": ...,
    }


# RetrievalFlowNodeServiceConfigurationTypeDef definition

class RetrievalFlowNodeServiceConfigurationTypeDef(TypedDict):
    s3: NotRequired[RetrievalFlowNodeS3ConfigurationTypeDef],  # (1)
  1. See RetrievalFlowNodeS3ConfigurationTypeDef

UrlConfigurationOutputTypeDef#

# UrlConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UrlConfigurationOutputTypeDef


def get_value() -> UrlConfigurationOutputTypeDef:
    return {
        "seedUrls": ...,
    }


# UrlConfigurationOutputTypeDef definition

class UrlConfigurationOutputTypeDef(TypedDict):
    seedUrls: NotRequired[List[SeedUrlTypeDef]],  # (1)
  1. See List[SeedUrlTypeDef]

UrlConfigurationTypeDef#

# UrlConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UrlConfigurationTypeDef


def get_value() -> UrlConfigurationTypeDef:
    return {
        "seedUrls": ...,
    }


# UrlConfigurationTypeDef definition

class UrlConfigurationTypeDef(TypedDict):
    seedUrls: NotRequired[Sequence[SeedUrlTypeDef]],  # (1)
  1. See Sequence[SeedUrlTypeDef]

ToolChoiceOutputTypeDef#

# ToolChoiceOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolChoiceOutputTypeDef


def get_value() -> ToolChoiceOutputTypeDef:
    return {
        "any": ...,
    }


# ToolChoiceOutputTypeDef definition

class ToolChoiceOutputTypeDef(TypedDict):
    any: NotRequired[Dict[str, Any]],
    auto: NotRequired[Dict[str, Any]],
    tool: NotRequired[SpecificToolChoiceTypeDef],  # (1)
  1. See SpecificToolChoiceTypeDef

ToolChoiceTypeDef#

# ToolChoiceTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolChoiceTypeDef


def get_value() -> ToolChoiceTypeDef:
    return {
        "any": ...,
    }


# ToolChoiceTypeDef definition

class ToolChoiceTypeDef(TypedDict):
    any: NotRequired[Mapping[str, Any]],
    auto: NotRequired[Mapping[str, Any]],
    tool: NotRequired[SpecificToolChoiceTypeDef],  # (1)
  1. See SpecificToolChoiceTypeDef

StorageFlowNodeServiceConfigurationTypeDef#

# StorageFlowNodeServiceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StorageFlowNodeServiceConfigurationTypeDef


def get_value() -> StorageFlowNodeServiceConfigurationTypeDef:
    return {
        "s3": ...,
    }


# StorageFlowNodeServiceConfigurationTypeDef definition

class StorageFlowNodeServiceConfigurationTypeDef(TypedDict):
    s3: NotRequired[StorageFlowNodeS3ConfigurationTypeDef],  # (1)
  1. See StorageFlowNodeS3ConfigurationTypeDef

ToolSpecificationOutputTypeDef#

# ToolSpecificationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolSpecificationOutputTypeDef


def get_value() -> ToolSpecificationOutputTypeDef:
    return {
        "description": ...,
    }


# ToolSpecificationOutputTypeDef definition

class ToolSpecificationOutputTypeDef(TypedDict):
    inputSchema: ToolInputSchemaOutputTypeDef,  # (1)
    name: str,
    description: NotRequired[str],
  1. See ToolInputSchemaOutputTypeDef

TransformationFunctionTypeDef#

# TransformationFunctionTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TransformationFunctionTypeDef


def get_value() -> TransformationFunctionTypeDef:
    return {
        "transformationLambdaConfiguration": ...,
    }


# TransformationFunctionTypeDef definition

class TransformationFunctionTypeDef(TypedDict):
    transformationLambdaConfiguration: TransformationLambdaConfigurationTypeDef,  # (1)
  1. See TransformationLambdaConfigurationTypeDef

WebCrawlerConfigurationOutputTypeDef#

# WebCrawlerConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebCrawlerConfigurationOutputTypeDef


def get_value() -> WebCrawlerConfigurationOutputTypeDef:
    return {
        "crawlerLimits": ...,
    }


# WebCrawlerConfigurationOutputTypeDef definition

class WebCrawlerConfigurationOutputTypeDef(TypedDict):
    crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef],  # (1)
    exclusionFilters: NotRequired[List[str]],
    inclusionFilters: NotRequired[List[str]],
    scope: NotRequired[WebScopeTypeType],  # (2)
    userAgent: NotRequired[str],
    userAgentHeader: NotRequired[str],
  1. See WebCrawlerLimitsTypeDef
  2. See WebScopeTypeType

WebCrawlerConfigurationTypeDef#

# WebCrawlerConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebCrawlerConfigurationTypeDef


def get_value() -> WebCrawlerConfigurationTypeDef:
    return {
        "crawlerLimits": ...,
    }


# WebCrawlerConfigurationTypeDef definition

class WebCrawlerConfigurationTypeDef(TypedDict):
    crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef],  # (1)
    exclusionFilters: NotRequired[Sequence[str]],
    inclusionFilters: NotRequired[Sequence[str]],
    scope: NotRequired[WebScopeTypeType],  # (2)
    userAgent: NotRequired[str],
    userAgentHeader: NotRequired[str],
  1. See WebCrawlerLimitsTypeDef
  2. See WebScopeTypeType

AgentAliasTypeDef#

# AgentAliasTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentAliasTypeDef


def get_value() -> AgentAliasTypeDef:
    return {
        "agentAliasArn": ...,
    }


# AgentAliasTypeDef definition

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

ListAgentAliasesResponseTypeDef#

# ListAgentAliasesResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentAliasesResponseTypeDef


def get_value() -> ListAgentAliasesResponseTypeDef:
    return {
        "agentAliasSummaries": ...,
    }


# ListAgentAliasesResponseTypeDef definition

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

ListAgentCollaboratorsResponseTypeDef#

# ListAgentCollaboratorsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentCollaboratorsResponseTypeDef


def get_value() -> ListAgentCollaboratorsResponseTypeDef:
    return {
        "agentCollaboratorSummaries": ...,
    }


# ListAgentCollaboratorsResponseTypeDef definition

class ListAgentCollaboratorsResponseTypeDef(TypedDict):
    agentCollaboratorSummaries: List[AgentCollaboratorSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[AgentCollaboratorSummaryTypeDef]
  2. See ResponseMetadataTypeDef

AssociateAgentCollaboratorResponseTypeDef#

# AssociateAgentCollaboratorResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AssociateAgentCollaboratorResponseTypeDef


def get_value() -> AssociateAgentCollaboratorResponseTypeDef:
    return {
        "agentCollaborator": ...,
    }


# AssociateAgentCollaboratorResponseTypeDef definition

class AssociateAgentCollaboratorResponseTypeDef(TypedDict):
    agentCollaborator: AgentCollaboratorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentCollaboratorTypeDef
  2. See ResponseMetadataTypeDef

GetAgentCollaboratorResponseTypeDef#

# GetAgentCollaboratorResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentCollaboratorResponseTypeDef


def get_value() -> GetAgentCollaboratorResponseTypeDef:
    return {
        "agentCollaborator": ...,
    }


# GetAgentCollaboratorResponseTypeDef definition

class GetAgentCollaboratorResponseTypeDef(TypedDict):
    agentCollaborator: AgentCollaboratorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentCollaboratorTypeDef
  2. See ResponseMetadataTypeDef

UpdateAgentCollaboratorResponseTypeDef#

# UpdateAgentCollaboratorResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentCollaboratorResponseTypeDef


def get_value() -> UpdateAgentCollaboratorResponseTypeDef:
    return {
        "agentCollaborator": ...,
    }


# UpdateAgentCollaboratorResponseTypeDef definition

class UpdateAgentCollaboratorResponseTypeDef(TypedDict):
    agentCollaborator: AgentCollaboratorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentCollaboratorTypeDef
  2. See ResponseMetadataTypeDef

ListAgentsResponseTypeDef#

# ListAgentsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentsResponseTypeDef


def get_value() -> ListAgentsResponseTypeDef:
    return {
        "agentSummaries": ...,
    }


# ListAgentsResponseTypeDef definition

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

ListAgentVersionsResponseTypeDef#

# ListAgentVersionsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListAgentVersionsResponseTypeDef


def get_value() -> ListAgentVersionsResponseTypeDef:
    return {
        "agentVersionSummaries": ...,
    }


# ListAgentVersionsResponseTypeDef definition

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

ParsingConfigurationTypeDef#

# ParsingConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ParsingConfigurationTypeDef


def get_value() -> ParsingConfigurationTypeDef:
    return {
        "bedrockDataAutomationConfiguration": ...,
    }


# ParsingConfigurationTypeDef definition

class ParsingConfigurationTypeDef(TypedDict):
    parsingStrategy: ParsingStrategyType,  # (3)
    bedrockDataAutomationConfiguration: NotRequired[BedrockDataAutomationConfigurationTypeDef],  # (1)
    bedrockFoundationModelConfiguration: NotRequired[BedrockFoundationModelConfigurationTypeDef],  # (2)
  1. See BedrockDataAutomationConfigurationTypeDef
  2. See BedrockFoundationModelConfigurationTypeDef
  3. See ParsingStrategyType

ContextEnrichmentConfigurationTypeDef#

# ContextEnrichmentConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ContextEnrichmentConfigurationTypeDef


def get_value() -> ContextEnrichmentConfigurationTypeDef:
    return {
        "bedrockFoundationModelConfiguration": ...,
    }


# ContextEnrichmentConfigurationTypeDef definition

class ContextEnrichmentConfigurationTypeDef(TypedDict):
    type: ContextEnrichmentTypeType,  # (2)
    bedrockFoundationModelConfiguration: NotRequired[BedrockFoundationModelContextEnrichmentConfigurationTypeDef],  # (1)
  1. See BedrockFoundationModelContextEnrichmentConfigurationTypeDef
  2. See ContextEnrichmentTypeType

InlineContentTypeDef#

# InlineContentTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import InlineContentTypeDef


def get_value() -> InlineContentTypeDef:
    return {
        "byteContent": ...,
    }


# InlineContentTypeDef definition

class InlineContentTypeDef(TypedDict):
    type: InlineContentTypeType,  # (3)
    byteContent: NotRequired[ByteContentDocTypeDef],  # (1)
    textContent: NotRequired[TextContentDocTypeDef],  # (2)
  1. See ByteContentDocTypeDef
  2. See TextContentDocTypeDef
  3. See InlineContentTypeType

MessageOutputTypeDef#

# MessageOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MessageOutputTypeDef


def get_value() -> MessageOutputTypeDef:
    return {
        "content": ...,
    }


# MessageOutputTypeDef definition

class MessageOutputTypeDef(TypedDict):
    content: List[ContentBlockTypeDef],  # (1)
    role: ConversationRoleType,  # (2)
  1. See List[ContentBlockTypeDef]
  2. See ConversationRoleType

MessageTypeDef#

# MessageTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import MessageTypeDef


def get_value() -> MessageTypeDef:
    return {
        "content": ...,
    }


# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    content: Sequence[ContentBlockTypeDef],  # (1)
    role: ConversationRoleType,  # (2)
  1. See Sequence[ContentBlockTypeDef]
  2. See ConversationRoleType

ListFlowAliasesResponseTypeDef#

# ListFlowAliasesResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListFlowAliasesResponseTypeDef


def get_value() -> ListFlowAliasesResponseTypeDef:
    return {
        "flowAliasSummaries": ...,
    }


# ListFlowAliasesResponseTypeDef definition

class ListFlowAliasesResponseTypeDef(TypedDict):
    flowAliasSummaries: List[FlowAliasSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[FlowAliasSummaryTypeDef]
  2. See ResponseMetadataTypeDef

DeleteKnowledgeBaseDocumentsRequestTypeDef#

# DeleteKnowledgeBaseDocumentsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteKnowledgeBaseDocumentsRequestTypeDef


def get_value() -> DeleteKnowledgeBaseDocumentsRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# DeleteKnowledgeBaseDocumentsRequestTypeDef definition

class DeleteKnowledgeBaseDocumentsRequestTypeDef(TypedDict):
    dataSourceId: str,
    documentIdentifiers: Sequence[DocumentIdentifierTypeDef],  # (1)
    knowledgeBaseId: str,
    clientToken: NotRequired[str],
  1. See Sequence[DocumentIdentifierTypeDef]

GetKnowledgeBaseDocumentsRequestTypeDef#

# GetKnowledgeBaseDocumentsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetKnowledgeBaseDocumentsRequestTypeDef


def get_value() -> GetKnowledgeBaseDocumentsRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# GetKnowledgeBaseDocumentsRequestTypeDef definition

class GetKnowledgeBaseDocumentsRequestTypeDef(TypedDict):
    dataSourceId: str,
    documentIdentifiers: Sequence[DocumentIdentifierTypeDef],  # (1)
    knowledgeBaseId: str,
  1. See Sequence[DocumentIdentifierTypeDef]

KnowledgeBaseDocumentDetailTypeDef#

# KnowledgeBaseDocumentDetailTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseDocumentDetailTypeDef


def get_value() -> KnowledgeBaseDocumentDetailTypeDef:
    return {
        "dataSourceId": ...,
    }


# KnowledgeBaseDocumentDetailTypeDef definition

class KnowledgeBaseDocumentDetailTypeDef(TypedDict):
    dataSourceId: str,
    identifier: DocumentIdentifierTypeDef,  # (1)
    knowledgeBaseId: str,
    status: DocumentStatusType,  # (2)
    statusReason: NotRequired[str],
    updatedAt: NotRequired[datetime.datetime],
  1. See DocumentIdentifierTypeDef
  2. See DocumentStatusType

SupplementalDataStorageConfigurationOutputTypeDef#

# SupplementalDataStorageConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SupplementalDataStorageConfigurationOutputTypeDef


def get_value() -> SupplementalDataStorageConfigurationOutputTypeDef:
    return {
        "storageLocations": ...,
    }


# SupplementalDataStorageConfigurationOutputTypeDef definition

class SupplementalDataStorageConfigurationOutputTypeDef(TypedDict):
    storageLocations: List[SupplementalDataStorageLocationTypeDef],  # (1)
  1. See List[SupplementalDataStorageLocationTypeDef]

SupplementalDataStorageConfigurationTypeDef#

# SupplementalDataStorageConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SupplementalDataStorageConfigurationTypeDef


def get_value() -> SupplementalDataStorageConfigurationTypeDef:
    return {
        "storageLocations": ...,
    }


# SupplementalDataStorageConfigurationTypeDef definition

class SupplementalDataStorageConfigurationTypeDef(TypedDict):
    storageLocations: Sequence[SupplementalDataStorageLocationTypeDef],  # (1)
  1. See Sequence[SupplementalDataStorageLocationTypeDef]

FlowConnectionTypeDef#

# FlowConnectionTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowConnectionTypeDef


def get_value() -> FlowConnectionTypeDef:
    return {
        "configuration": ...,
    }


# FlowConnectionTypeDef definition

class FlowConnectionTypeDef(TypedDict):
    name: str,
    source: str,
    target: str,
    type: FlowConnectionTypeType,  # (2)
    configuration: NotRequired[FlowConnectionConfigurationTypeDef],  # (1)
  1. See FlowConnectionConfigurationTypeDef
  2. See FlowConnectionTypeType

FlowValidationTypeDef#

# FlowValidationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowValidationTypeDef


def get_value() -> FlowValidationTypeDef:
    return {
        "details": ...,
    }


# FlowValidationTypeDef definition

class FlowValidationTypeDef(TypedDict):
    message: str,
    severity: FlowValidationSeverityType,  # (2)
    details: NotRequired[FlowValidationDetailsTypeDef],  # (1)
    type: NotRequired[FlowValidationTypeType],  # (3)
  1. See FlowValidationDetailsTypeDef
  2. See FlowValidationSeverityType
  3. See FlowValidationTypeType

FunctionSchemaOutputTypeDef#

# FunctionSchemaOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FunctionSchemaOutputTypeDef


def get_value() -> FunctionSchemaOutputTypeDef:
    return {
        "functions": ...,
    }


# FunctionSchemaOutputTypeDef definition

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

FunctionSchemaTypeDef#

# FunctionSchemaTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FunctionSchemaTypeDef


def get_value() -> FunctionSchemaTypeDef:
    return {
        "functions": ...,
    }


# FunctionSchemaTypeDef definition

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

ChunkingConfigurationOutputTypeDef#

# ChunkingConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ChunkingConfigurationOutputTypeDef


def get_value() -> ChunkingConfigurationOutputTypeDef:
    return {
        "chunkingStrategy": ...,
    }


# ChunkingConfigurationOutputTypeDef definition

class ChunkingConfigurationOutputTypeDef(TypedDict):
    chunkingStrategy: ChunkingStrategyType,  # (1)
    fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef],  # (2)
    hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationOutputTypeDef],  # (3)
    semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef],  # (4)
  1. See ChunkingStrategyType
  2. See FixedSizeChunkingConfigurationTypeDef
  3. See HierarchicalChunkingConfigurationOutputTypeDef
  4. See SemanticChunkingConfigurationTypeDef

ChunkingConfigurationTypeDef#

# ChunkingConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ChunkingConfigurationTypeDef


def get_value() -> ChunkingConfigurationTypeDef:
    return {
        "chunkingStrategy": ...,
    }


# ChunkingConfigurationTypeDef definition

class ChunkingConfigurationTypeDef(TypedDict):
    chunkingStrategy: ChunkingStrategyType,  # (1)
    fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef],  # (2)
    hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationTypeDef],  # (3)
    semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef],  # (4)
  1. See ChunkingStrategyType
  2. See FixedSizeChunkingConfigurationTypeDef
  3. See HierarchicalChunkingConfigurationTypeDef
  4. See SemanticChunkingConfigurationTypeDef

PromptOverrideConfigurationOutputTypeDef#

# PromptOverrideConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptOverrideConfigurationOutputTypeDef


def get_value() -> PromptOverrideConfigurationOutputTypeDef:
    return {
        "overrideLambda": ...,
    }


# PromptOverrideConfigurationOutputTypeDef definition

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

PromptOverrideConfigurationTypeDef#

# PromptOverrideConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptOverrideConfigurationTypeDef


def get_value() -> PromptOverrideConfigurationTypeDef:
    return {
        "overrideLambda": ...,
    }


# PromptOverrideConfigurationTypeDef definition

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

ListIngestionJobsResponseTypeDef#

# ListIngestionJobsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListIngestionJobsResponseTypeDef


def get_value() -> ListIngestionJobsResponseTypeDef:
    return {
        "ingestionJobSummaries": ...,
    }


# ListIngestionJobsResponseTypeDef definition

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

GetIngestionJobResponseTypeDef#

# GetIngestionJobResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetIngestionJobResponseTypeDef


def get_value() -> GetIngestionJobResponseTypeDef:
    return {
        "ingestionJob": ...,
    }


# GetIngestionJobResponseTypeDef definition

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

StartIngestionJobResponseTypeDef#

# StartIngestionJobResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StartIngestionJobResponseTypeDef


def get_value() -> StartIngestionJobResponseTypeDef:
    return {
        "ingestionJob": ...,
    }


# StartIngestionJobResponseTypeDef definition

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

StopIngestionJobResponseTypeDef#

# StopIngestionJobResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StopIngestionJobResponseTypeDef


def get_value() -> StopIngestionJobResponseTypeDef:
    return {
        "ingestionJob": ...,
    }


# StopIngestionJobResponseTypeDef definition

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

DocumentMetadataTypeDef#

# DocumentMetadataTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DocumentMetadataTypeDef


def get_value() -> DocumentMetadataTypeDef:
    return {
        "inlineAttributes": ...,
    }


# DocumentMetadataTypeDef definition

class DocumentMetadataTypeDef(TypedDict):
    type: MetadataSourceTypeType,  # (3)
    inlineAttributes: NotRequired[Sequence[MetadataAttributeTypeDef]],  # (1)
    s3Location: NotRequired[CustomS3LocationTypeDef],  # (2)
  1. See Sequence[MetadataAttributeTypeDef]
  2. See CustomS3LocationTypeDef
  3. See MetadataSourceTypeType

CrawlFilterConfigurationOutputTypeDef#

# CrawlFilterConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CrawlFilterConfigurationOutputTypeDef


def get_value() -> CrawlFilterConfigurationOutputTypeDef:
    return {
        "patternObjectFilter": ...,
    }


# CrawlFilterConfigurationOutputTypeDef definition

class CrawlFilterConfigurationOutputTypeDef(TypedDict):
    type: CrawlFilterConfigurationTypeType,  # (2)
    patternObjectFilter: NotRequired[PatternObjectFilterConfigurationOutputTypeDef],  # (1)
  1. See PatternObjectFilterConfigurationOutputTypeDef
  2. See CrawlFilterConfigurationTypeType

CrawlFilterConfigurationTypeDef#

# CrawlFilterConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CrawlFilterConfigurationTypeDef


def get_value() -> CrawlFilterConfigurationTypeDef:
    return {
        "patternObjectFilter": ...,
    }


# CrawlFilterConfigurationTypeDef definition

class CrawlFilterConfigurationTypeDef(TypedDict):
    type: CrawlFilterConfigurationTypeType,  # (2)
    patternObjectFilter: NotRequired[PatternObjectFilterConfigurationTypeDef],  # (1)
  1. See PatternObjectFilterConfigurationTypeDef
  2. See CrawlFilterConfigurationTypeType

PromptInferenceConfigurationTypeDef#

# PromptInferenceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptInferenceConfigurationTypeDef


def get_value() -> PromptInferenceConfigurationTypeDef:
    return {
        "text": ...,
    }


# PromptInferenceConfigurationTypeDef definition

class PromptInferenceConfigurationTypeDef(TypedDict):
    text: NotRequired[PromptModelInferenceConfigurationUnionTypeDef],  # (1)
  1. See PromptModelInferenceConfigurationUnionTypeDef

QueryGenerationContextOutputTypeDef#

# QueryGenerationContextOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationContextOutputTypeDef


def get_value() -> QueryGenerationContextOutputTypeDef:
    return {
        "curatedQueries": ...,
    }


# QueryGenerationContextOutputTypeDef definition

class QueryGenerationContextOutputTypeDef(TypedDict):
    curatedQueries: NotRequired[List[CuratedQueryTypeDef]],  # (1)
    tables: NotRequired[List[QueryGenerationTableOutputTypeDef]],  # (2)
  1. See List[CuratedQueryTypeDef]
  2. See List[QueryGenerationTableOutputTypeDef]

QueryGenerationContextTypeDef#

# QueryGenerationContextTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationContextTypeDef


def get_value() -> QueryGenerationContextTypeDef:
    return {
        "curatedQueries": ...,
    }


# QueryGenerationContextTypeDef definition

class QueryGenerationContextTypeDef(TypedDict):
    curatedQueries: NotRequired[Sequence[CuratedQueryTypeDef]],  # (1)
    tables: NotRequired[Sequence[QueryGenerationTableTypeDef]],  # (2)
  1. See Sequence[CuratedQueryTypeDef]
  2. See Sequence[QueryGenerationTableTypeDef]

StorageConfigurationTypeDef#

# StorageConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StorageConfigurationTypeDef


def get_value() -> StorageConfigurationTypeDef:
    return {
        "mongoDbAtlasConfiguration": ...,
    }


# StorageConfigurationTypeDef definition

class StorageConfigurationTypeDef(TypedDict):
    type: KnowledgeBaseStorageTypeType,  # (8)
    mongoDbAtlasConfiguration: NotRequired[MongoDbAtlasConfigurationTypeDef],  # (1)
    neptuneAnalyticsConfiguration: NotRequired[NeptuneAnalyticsConfigurationTypeDef],  # (2)
    opensearchManagedClusterConfiguration: NotRequired[OpenSearchManagedClusterConfigurationTypeDef],  # (3)
    opensearchServerlessConfiguration: NotRequired[OpenSearchServerlessConfigurationTypeDef],  # (4)
    pineconeConfiguration: NotRequired[PineconeConfigurationTypeDef],  # (5)
    rdsConfiguration: NotRequired[RdsConfigurationTypeDef],  # (6)
    redisEnterpriseCloudConfiguration: NotRequired[RedisEnterpriseCloudConfigurationTypeDef],  # (7)
  1. See MongoDbAtlasConfigurationTypeDef
  2. See NeptuneAnalyticsConfigurationTypeDef
  3. See OpenSearchManagedClusterConfigurationTypeDef
  4. See OpenSearchServerlessConfigurationTypeDef
  5. See PineconeConfigurationTypeDef
  6. See RdsConfigurationTypeDef
  7. See RedisEnterpriseCloudConfigurationTypeDef
  8. See KnowledgeBaseStorageTypeType

RedshiftQueryEngineConfigurationTypeDef#

# RedshiftQueryEngineConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftQueryEngineConfigurationTypeDef


def get_value() -> RedshiftQueryEngineConfigurationTypeDef:
    return {
        "provisionedConfiguration": ...,
    }


# RedshiftQueryEngineConfigurationTypeDef definition

class RedshiftQueryEngineConfigurationTypeDef(TypedDict):
    type: RedshiftQueryEngineTypeType,  # (3)
    provisionedConfiguration: NotRequired[RedshiftProvisionedConfigurationTypeDef],  # (1)
    serverlessConfiguration: NotRequired[RedshiftServerlessConfigurationTypeDef],  # (2)
  1. See RedshiftProvisionedConfigurationTypeDef
  2. See RedshiftServerlessConfigurationTypeDef
  3. See RedshiftQueryEngineTypeType

RetrievalFlowNodeConfigurationTypeDef#

# RetrievalFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RetrievalFlowNodeConfigurationTypeDef


def get_value() -> RetrievalFlowNodeConfigurationTypeDef:
    return {
        "serviceConfiguration": ...,
    }


# RetrievalFlowNodeConfigurationTypeDef definition

class RetrievalFlowNodeConfigurationTypeDef(TypedDict):
    serviceConfiguration: RetrievalFlowNodeServiceConfigurationTypeDef,  # (1)
  1. See RetrievalFlowNodeServiceConfigurationTypeDef

WebSourceConfigurationOutputTypeDef#

# WebSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebSourceConfigurationOutputTypeDef


def get_value() -> WebSourceConfigurationOutputTypeDef:
    return {
        "urlConfiguration": ...,
    }


# WebSourceConfigurationOutputTypeDef definition

class WebSourceConfigurationOutputTypeDef(TypedDict):
    urlConfiguration: UrlConfigurationOutputTypeDef,  # (1)
  1. See UrlConfigurationOutputTypeDef

WebSourceConfigurationTypeDef#

# WebSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebSourceConfigurationTypeDef


def get_value() -> WebSourceConfigurationTypeDef:
    return {
        "urlConfiguration": ...,
    }


# WebSourceConfigurationTypeDef definition

class WebSourceConfigurationTypeDef(TypedDict):
    urlConfiguration: UrlConfigurationTypeDef,  # (1)
  1. See UrlConfigurationTypeDef

StorageFlowNodeConfigurationTypeDef#

# StorageFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import StorageFlowNodeConfigurationTypeDef


def get_value() -> StorageFlowNodeConfigurationTypeDef:
    return {
        "serviceConfiguration": ...,
    }


# StorageFlowNodeConfigurationTypeDef definition

class StorageFlowNodeConfigurationTypeDef(TypedDict):
    serviceConfiguration: StorageFlowNodeServiceConfigurationTypeDef,  # (1)
  1. See StorageFlowNodeServiceConfigurationTypeDef

ToolOutputTypeDef#

# ToolOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolOutputTypeDef


def get_value() -> ToolOutputTypeDef:
    return {
        "cachePoint": ...,
    }


# ToolOutputTypeDef definition

class ToolOutputTypeDef(TypedDict):
    cachePoint: NotRequired[CachePointBlockTypeDef],  # (1)
    toolSpec: NotRequired[ToolSpecificationOutputTypeDef],  # (2)
  1. See CachePointBlockTypeDef
  2. See ToolSpecificationOutputTypeDef

ToolSpecificationTypeDef#

# ToolSpecificationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolSpecificationTypeDef


def get_value() -> ToolSpecificationTypeDef:
    return {
        "description": ...,
    }


# ToolSpecificationTypeDef definition

class ToolSpecificationTypeDef(TypedDict):
    inputSchema: ToolInputSchemaUnionTypeDef,  # (1)
    name: str,
    description: NotRequired[str],
  1. See ToolInputSchemaUnionTypeDef

TransformationTypeDef#

# TransformationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import TransformationTypeDef


def get_value() -> TransformationTypeDef:
    return {
        "stepToApply": ...,
    }


# TransformationTypeDef definition

class TransformationTypeDef(TypedDict):
    stepToApply: StepTypeType,  # (1)
    transformationFunction: TransformationFunctionTypeDef,  # (2)
  1. See StepTypeType
  2. See TransformationFunctionTypeDef

CreateAgentAliasResponseTypeDef#

# CreateAgentAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateAgentAliasResponseTypeDef


def get_value() -> CreateAgentAliasResponseTypeDef:
    return {
        "agentAlias": ...,
    }


# CreateAgentAliasResponseTypeDef definition

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

GetAgentAliasResponseTypeDef#

# GetAgentAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentAliasResponseTypeDef


def get_value() -> GetAgentAliasResponseTypeDef:
    return {
        "agentAlias": ...,
    }


# GetAgentAliasResponseTypeDef definition

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

UpdateAgentAliasResponseTypeDef#

# UpdateAgentAliasResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentAliasResponseTypeDef


def get_value() -> UpdateAgentAliasResponseTypeDef:
    return {
        "agentAlias": ...,
    }


# UpdateAgentAliasResponseTypeDef definition

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

CustomContentTypeDef#

# CustomContentTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CustomContentTypeDef


def get_value() -> CustomContentTypeDef:
    return {
        "customDocumentIdentifier": ...,
    }


# CustomContentTypeDef definition

class CustomContentTypeDef(TypedDict):
    customDocumentIdentifier: CustomDocumentIdentifierTypeDef,  # (1)
    sourceType: CustomSourceTypeType,  # (4)
    inlineContent: NotRequired[InlineContentTypeDef],  # (2)
    s3Location: NotRequired[CustomS3LocationTypeDef],  # (3)
  1. See CustomDocumentIdentifierTypeDef
  2. See InlineContentTypeDef
  3. See CustomS3LocationTypeDef
  4. See CustomSourceTypeType

DeleteKnowledgeBaseDocumentsResponseTypeDef#

# DeleteKnowledgeBaseDocumentsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DeleteKnowledgeBaseDocumentsResponseTypeDef


def get_value() -> DeleteKnowledgeBaseDocumentsResponseTypeDef:
    return {
        "documentDetails": ...,
    }


# DeleteKnowledgeBaseDocumentsResponseTypeDef definition

class DeleteKnowledgeBaseDocumentsResponseTypeDef(TypedDict):
    documentDetails: List[KnowledgeBaseDocumentDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[KnowledgeBaseDocumentDetailTypeDef]
  2. See ResponseMetadataTypeDef

GetKnowledgeBaseDocumentsResponseTypeDef#

# GetKnowledgeBaseDocumentsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetKnowledgeBaseDocumentsResponseTypeDef


def get_value() -> GetKnowledgeBaseDocumentsResponseTypeDef:
    return {
        "documentDetails": ...,
    }


# GetKnowledgeBaseDocumentsResponseTypeDef definition

class GetKnowledgeBaseDocumentsResponseTypeDef(TypedDict):
    documentDetails: List[KnowledgeBaseDocumentDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[KnowledgeBaseDocumentDetailTypeDef]
  2. See ResponseMetadataTypeDef

IngestKnowledgeBaseDocumentsResponseTypeDef#

# IngestKnowledgeBaseDocumentsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestKnowledgeBaseDocumentsResponseTypeDef


def get_value() -> IngestKnowledgeBaseDocumentsResponseTypeDef:
    return {
        "documentDetails": ...,
    }


# IngestKnowledgeBaseDocumentsResponseTypeDef definition

class IngestKnowledgeBaseDocumentsResponseTypeDef(TypedDict):
    documentDetails: List[KnowledgeBaseDocumentDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[KnowledgeBaseDocumentDetailTypeDef]
  2. See ResponseMetadataTypeDef

ListKnowledgeBaseDocumentsResponseTypeDef#

# ListKnowledgeBaseDocumentsResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ListKnowledgeBaseDocumentsResponseTypeDef


def get_value() -> ListKnowledgeBaseDocumentsResponseTypeDef:
    return {
        "documentDetails": ...,
    }


# ListKnowledgeBaseDocumentsResponseTypeDef definition

class ListKnowledgeBaseDocumentsResponseTypeDef(TypedDict):
    documentDetails: List[KnowledgeBaseDocumentDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[KnowledgeBaseDocumentDetailTypeDef]
  2. See ResponseMetadataTypeDef

VectorKnowledgeBaseConfigurationOutputTypeDef#

# VectorKnowledgeBaseConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import VectorKnowledgeBaseConfigurationOutputTypeDef


def get_value() -> VectorKnowledgeBaseConfigurationOutputTypeDef:
    return {
        "embeddingModelArn": ...,
    }


# VectorKnowledgeBaseConfigurationOutputTypeDef definition

class VectorKnowledgeBaseConfigurationOutputTypeDef(TypedDict):
    embeddingModelArn: str,
    embeddingModelConfiguration: NotRequired[EmbeddingModelConfigurationTypeDef],  # (1)
    supplementalDataStorageConfiguration: NotRequired[SupplementalDataStorageConfigurationOutputTypeDef],  # (2)
  1. See EmbeddingModelConfigurationTypeDef
  2. See SupplementalDataStorageConfigurationOutputTypeDef

VectorKnowledgeBaseConfigurationTypeDef#

# VectorKnowledgeBaseConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import VectorKnowledgeBaseConfigurationTypeDef


def get_value() -> VectorKnowledgeBaseConfigurationTypeDef:
    return {
        "embeddingModelArn": ...,
    }


# VectorKnowledgeBaseConfigurationTypeDef definition

class VectorKnowledgeBaseConfigurationTypeDef(TypedDict):
    embeddingModelArn: str,
    embeddingModelConfiguration: NotRequired[EmbeddingModelConfigurationTypeDef],  # (1)
    supplementalDataStorageConfiguration: NotRequired[SupplementalDataStorageConfigurationTypeDef],  # (2)
  1. See EmbeddingModelConfigurationTypeDef
  2. See SupplementalDataStorageConfigurationTypeDef

ValidateFlowDefinitionResponseTypeDef#

# ValidateFlowDefinitionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ValidateFlowDefinitionResponseTypeDef


def get_value() -> ValidateFlowDefinitionResponseTypeDef:
    return {
        "validations": ...,
    }


# ValidateFlowDefinitionResponseTypeDef definition

class ValidateFlowDefinitionResponseTypeDef(TypedDict):
    validations: List[FlowValidationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[FlowValidationTypeDef]
  2. See ResponseMetadataTypeDef

AgentActionGroupTypeDef#

# AgentActionGroupTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentActionGroupTypeDef


def get_value() -> AgentActionGroupTypeDef:
    return {
        "actionGroupExecutor": ...,
    }


# AgentActionGroupTypeDef definition

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

AgentTypeDef#

# AgentTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentTypeDef


def get_value() -> AgentTypeDef:
    return {
        "agentArn": ...,
    }


# AgentTypeDef definition

class AgentTypeDef(TypedDict):
    agentArn: str,
    agentId: str,
    agentName: str,
    agentResourceRoleArn: str,
    agentStatus: AgentStatusType,  # (2)
    agentVersion: str,
    createdAt: datetime.datetime,
    idleSessionTTLInSeconds: int,
    updatedAt: datetime.datetime,
    agentCollaboration: NotRequired[AgentCollaborationType],  # (1)
    clientToken: NotRequired[str],
    customOrchestration: NotRequired[CustomOrchestrationTypeDef],  # (3)
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    failureReasons: NotRequired[List[str]],
    foundationModel: NotRequired[str],
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (4)
    instruction: NotRequired[str],
    memoryConfiguration: NotRequired[MemoryConfigurationOutputTypeDef],  # (5)
    orchestrationType: NotRequired[OrchestrationTypeType],  # (6)
    preparedAt: NotRequired[datetime.datetime],
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationOutputTypeDef],  # (7)
    recommendedActions: NotRequired[List[str]],
  1. See AgentCollaborationType
  2. See AgentStatusType
  3. See CustomOrchestrationTypeDef
  4. See GuardrailConfigurationTypeDef
  5. See MemoryConfigurationOutputTypeDef
  6. See OrchestrationTypeType
  7. See PromptOverrideConfigurationOutputTypeDef

AgentVersionTypeDef#

# AgentVersionTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import AgentVersionTypeDef


def get_value() -> AgentVersionTypeDef:
    return {
        "agentArn": ...,
    }


# AgentVersionTypeDef definition

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

ConfluenceCrawlerConfigurationOutputTypeDef#

# ConfluenceCrawlerConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConfluenceCrawlerConfigurationOutputTypeDef


def get_value() -> ConfluenceCrawlerConfigurationOutputTypeDef:
    return {
        "filterConfiguration": ...,
    }


# ConfluenceCrawlerConfigurationOutputTypeDef definition

class ConfluenceCrawlerConfigurationOutputTypeDef(TypedDict):
    filterConfiguration: NotRequired[CrawlFilterConfigurationOutputTypeDef],  # (1)
  1. See CrawlFilterConfigurationOutputTypeDef

SalesforceCrawlerConfigurationOutputTypeDef#

# SalesforceCrawlerConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SalesforceCrawlerConfigurationOutputTypeDef


def get_value() -> SalesforceCrawlerConfigurationOutputTypeDef:
    return {
        "filterConfiguration": ...,
    }


# SalesforceCrawlerConfigurationOutputTypeDef definition

class SalesforceCrawlerConfigurationOutputTypeDef(TypedDict):
    filterConfiguration: NotRequired[CrawlFilterConfigurationOutputTypeDef],  # (1)
  1. See CrawlFilterConfigurationOutputTypeDef

SharePointCrawlerConfigurationOutputTypeDef#

# SharePointCrawlerConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SharePointCrawlerConfigurationOutputTypeDef


def get_value() -> SharePointCrawlerConfigurationOutputTypeDef:
    return {
        "filterConfiguration": ...,
    }


# SharePointCrawlerConfigurationOutputTypeDef definition

class SharePointCrawlerConfigurationOutputTypeDef(TypedDict):
    filterConfiguration: NotRequired[CrawlFilterConfigurationOutputTypeDef],  # (1)
  1. See CrawlFilterConfigurationOutputTypeDef

ConfluenceCrawlerConfigurationTypeDef#

# ConfluenceCrawlerConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConfluenceCrawlerConfigurationTypeDef


def get_value() -> ConfluenceCrawlerConfigurationTypeDef:
    return {
        "filterConfiguration": ...,
    }


# ConfluenceCrawlerConfigurationTypeDef definition

class ConfluenceCrawlerConfigurationTypeDef(TypedDict):
    filterConfiguration: NotRequired[CrawlFilterConfigurationTypeDef],  # (1)
  1. See CrawlFilterConfigurationTypeDef

SalesforceCrawlerConfigurationTypeDef#

# SalesforceCrawlerConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SalesforceCrawlerConfigurationTypeDef


def get_value() -> SalesforceCrawlerConfigurationTypeDef:
    return {
        "filterConfiguration": ...,
    }


# SalesforceCrawlerConfigurationTypeDef definition

class SalesforceCrawlerConfigurationTypeDef(TypedDict):
    filterConfiguration: NotRequired[CrawlFilterConfigurationTypeDef],  # (1)
  1. See CrawlFilterConfigurationTypeDef

SharePointCrawlerConfigurationTypeDef#

# SharePointCrawlerConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SharePointCrawlerConfigurationTypeDef


def get_value() -> SharePointCrawlerConfigurationTypeDef:
    return {
        "filterConfiguration": ...,
    }


# SharePointCrawlerConfigurationTypeDef definition

class SharePointCrawlerConfigurationTypeDef(TypedDict):
    filterConfiguration: NotRequired[CrawlFilterConfigurationTypeDef],  # (1)
  1. See CrawlFilterConfigurationTypeDef

QueryGenerationConfigurationOutputTypeDef#

# QueryGenerationConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationConfigurationOutputTypeDef


def get_value() -> QueryGenerationConfigurationOutputTypeDef:
    return {
        "executionTimeoutSeconds": ...,
    }


# QueryGenerationConfigurationOutputTypeDef definition

class QueryGenerationConfigurationOutputTypeDef(TypedDict):
    executionTimeoutSeconds: NotRequired[int],
    generationContext: NotRequired[QueryGenerationContextOutputTypeDef],  # (1)
  1. See QueryGenerationContextOutputTypeDef

QueryGenerationConfigurationTypeDef#

# QueryGenerationConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import QueryGenerationConfigurationTypeDef


def get_value() -> QueryGenerationConfigurationTypeDef:
    return {
        "executionTimeoutSeconds": ...,
    }


# QueryGenerationConfigurationTypeDef definition

class QueryGenerationConfigurationTypeDef(TypedDict):
    executionTimeoutSeconds: NotRequired[int],
    generationContext: NotRequired[QueryGenerationContextTypeDef],  # (1)
  1. See QueryGenerationContextTypeDef

WebDataSourceConfigurationOutputTypeDef#

# WebDataSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebDataSourceConfigurationOutputTypeDef


def get_value() -> WebDataSourceConfigurationOutputTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# WebDataSourceConfigurationOutputTypeDef definition

class WebDataSourceConfigurationOutputTypeDef(TypedDict):
    sourceConfiguration: WebSourceConfigurationOutputTypeDef,  # (2)
    crawlerConfiguration: NotRequired[WebCrawlerConfigurationOutputTypeDef],  # (1)
  1. See WebCrawlerConfigurationOutputTypeDef
  2. See WebSourceConfigurationOutputTypeDef

WebDataSourceConfigurationTypeDef#

# WebDataSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import WebDataSourceConfigurationTypeDef


def get_value() -> WebDataSourceConfigurationTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# WebDataSourceConfigurationTypeDef definition

class WebDataSourceConfigurationTypeDef(TypedDict):
    sourceConfiguration: WebSourceConfigurationTypeDef,  # (2)
    crawlerConfiguration: NotRequired[WebCrawlerConfigurationTypeDef],  # (1)
  1. See WebCrawlerConfigurationTypeDef
  2. See WebSourceConfigurationTypeDef

ToolConfigurationOutputTypeDef#

# ToolConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolConfigurationOutputTypeDef


def get_value() -> ToolConfigurationOutputTypeDef:
    return {
        "toolChoice": ...,
    }


# ToolConfigurationOutputTypeDef definition

class ToolConfigurationOutputTypeDef(TypedDict):
    tools: List[ToolOutputTypeDef],  # (2)
    toolChoice: NotRequired[ToolChoiceOutputTypeDef],  # (1)
  1. See ToolChoiceOutputTypeDef
  2. See List[ToolOutputTypeDef]

CustomTransformationConfigurationOutputTypeDef#

# CustomTransformationConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CustomTransformationConfigurationOutputTypeDef


def get_value() -> CustomTransformationConfigurationOutputTypeDef:
    return {
        "intermediateStorage": ...,
    }


# CustomTransformationConfigurationOutputTypeDef definition

class CustomTransformationConfigurationOutputTypeDef(TypedDict):
    intermediateStorage: IntermediateStorageTypeDef,  # (1)
    transformations: List[TransformationTypeDef],  # (2)
  1. See IntermediateStorageTypeDef
  2. See List[TransformationTypeDef]

CustomTransformationConfigurationTypeDef#

# CustomTransformationConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CustomTransformationConfigurationTypeDef


def get_value() -> CustomTransformationConfigurationTypeDef:
    return {
        "intermediateStorage": ...,
    }


# CustomTransformationConfigurationTypeDef definition

class CustomTransformationConfigurationTypeDef(TypedDict):
    intermediateStorage: IntermediateStorageTypeDef,  # (1)
    transformations: Sequence[TransformationTypeDef],  # (2)
  1. See IntermediateStorageTypeDef
  2. See Sequence[TransformationTypeDef]

DocumentContentTypeDef#

# DocumentContentTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DocumentContentTypeDef


def get_value() -> DocumentContentTypeDef:
    return {
        "custom": ...,
    }


# DocumentContentTypeDef definition

class DocumentContentTypeDef(TypedDict):
    dataSourceType: ContentDataSourceTypeType,  # (2)
    custom: NotRequired[CustomContentTypeDef],  # (1)
    s3: NotRequired[S3ContentTypeDef],  # (3)
  1. See CustomContentTypeDef
  2. See ContentDataSourceTypeType
  3. See S3ContentTypeDef

CreateAgentActionGroupResponseTypeDef#

# CreateAgentActionGroupResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateAgentActionGroupResponseTypeDef


def get_value() -> CreateAgentActionGroupResponseTypeDef:
    return {
        "agentActionGroup": ...,
    }


# CreateAgentActionGroupResponseTypeDef definition

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

GetAgentActionGroupResponseTypeDef#

# GetAgentActionGroupResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentActionGroupResponseTypeDef


def get_value() -> GetAgentActionGroupResponseTypeDef:
    return {
        "agentActionGroup": ...,
    }


# GetAgentActionGroupResponseTypeDef definition

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

UpdateAgentActionGroupResponseTypeDef#

# UpdateAgentActionGroupResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentActionGroupResponseTypeDef


def get_value() -> UpdateAgentActionGroupResponseTypeDef:
    return {
        "agentActionGroup": ...,
    }


# UpdateAgentActionGroupResponseTypeDef definition

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

CreateAgentActionGroupRequestTypeDef#

# CreateAgentActionGroupRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateAgentActionGroupRequestTypeDef


def get_value() -> CreateAgentActionGroupRequestTypeDef:
    return {
        "actionGroupName": ...,
    }


# CreateAgentActionGroupRequestTypeDef definition

class CreateAgentActionGroupRequestTypeDef(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[FunctionSchemaUnionTypeDef],  # (4)
    parentActionGroupSignature: NotRequired[ActionGroupSignatureType],  # (5)
    parentActionGroupSignatureParams: NotRequired[Mapping[str, str]],
  1. See ActionGroupExecutorTypeDef
  2. See ActionGroupStateType
  3. See APISchemaTypeDef
  4. See FunctionSchemaUnionTypeDef
  5. See ActionGroupSignatureType

UpdateAgentActionGroupRequestTypeDef#

# UpdateAgentActionGroupRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentActionGroupRequestTypeDef


def get_value() -> UpdateAgentActionGroupRequestTypeDef:
    return {
        "actionGroupId": ...,
    }


# UpdateAgentActionGroupRequestTypeDef definition

class UpdateAgentActionGroupRequestTypeDef(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[FunctionSchemaUnionTypeDef],  # (4)
    parentActionGroupSignature: NotRequired[ActionGroupSignatureType],  # (5)
    parentActionGroupSignatureParams: NotRequired[Mapping[str, str]],
  1. See ActionGroupExecutorTypeDef
  2. See ActionGroupStateType
  3. See APISchemaTypeDef
  4. See FunctionSchemaUnionTypeDef
  5. See ActionGroupSignatureType

CreateAgentResponseTypeDef#

# CreateAgentResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateAgentResponseTypeDef


def get_value() -> CreateAgentResponseTypeDef:
    return {
        "agent": ...,
    }


# CreateAgentResponseTypeDef definition

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

GetAgentResponseTypeDef#

# GetAgentResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentResponseTypeDef


def get_value() -> GetAgentResponseTypeDef:
    return {
        "agent": ...,
    }


# GetAgentResponseTypeDef definition

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

UpdateAgentResponseTypeDef#

# UpdateAgentResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentResponseTypeDef


def get_value() -> UpdateAgentResponseTypeDef:
    return {
        "agent": ...,
    }


# UpdateAgentResponseTypeDef definition

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

GetAgentVersionResponseTypeDef#

# GetAgentVersionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetAgentVersionResponseTypeDef


def get_value() -> GetAgentVersionResponseTypeDef:
    return {
        "agentVersion": ...,
    }


# GetAgentVersionResponseTypeDef definition

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

CreateAgentRequestTypeDef#

# CreateAgentRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateAgentRequestTypeDef


def get_value() -> CreateAgentRequestTypeDef:
    return {
        "agentName": ...,
    }


# CreateAgentRequestTypeDef definition

class CreateAgentRequestTypeDef(TypedDict):
    agentName: str,
    agentCollaboration: NotRequired[AgentCollaborationType],  # (1)
    agentResourceRoleArn: NotRequired[str],
    clientToken: NotRequired[str],
    customOrchestration: NotRequired[CustomOrchestrationTypeDef],  # (2)
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    foundationModel: NotRequired[str],
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (3)
    idleSessionTTLInSeconds: NotRequired[int],
    instruction: NotRequired[str],
    memoryConfiguration: NotRequired[MemoryConfigurationUnionTypeDef],  # (4)
    orchestrationType: NotRequired[OrchestrationTypeType],  # (5)
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationUnionTypeDef],  # (6)
    tags: NotRequired[Mapping[str, str]],
  1. See AgentCollaborationType
  2. See CustomOrchestrationTypeDef
  3. See GuardrailConfigurationTypeDef
  4. See MemoryConfigurationUnionTypeDef
  5. See OrchestrationTypeType
  6. See PromptOverrideConfigurationUnionTypeDef

UpdateAgentRequestTypeDef#

# UpdateAgentRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateAgentRequestTypeDef


def get_value() -> UpdateAgentRequestTypeDef:
    return {
        "agentId": ...,
    }


# UpdateAgentRequestTypeDef definition

class UpdateAgentRequestTypeDef(TypedDict):
    agentId: str,
    agentName: str,
    agentResourceRoleArn: str,
    foundationModel: str,
    agentCollaboration: NotRequired[AgentCollaborationType],  # (1)
    customOrchestration: NotRequired[CustomOrchestrationTypeDef],  # (2)
    customerEncryptionKeyArn: NotRequired[str],
    description: NotRequired[str],
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (3)
    idleSessionTTLInSeconds: NotRequired[int],
    instruction: NotRequired[str],
    memoryConfiguration: NotRequired[MemoryConfigurationUnionTypeDef],  # (4)
    orchestrationType: NotRequired[OrchestrationTypeType],  # (5)
    promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationUnionTypeDef],  # (6)
  1. See AgentCollaborationType
  2. See CustomOrchestrationTypeDef
  3. See GuardrailConfigurationTypeDef
  4. See MemoryConfigurationUnionTypeDef
  5. See OrchestrationTypeType
  6. See PromptOverrideConfigurationUnionTypeDef

ConfluenceDataSourceConfigurationOutputTypeDef#

# ConfluenceDataSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConfluenceDataSourceConfigurationOutputTypeDef


def get_value() -> ConfluenceDataSourceConfigurationOutputTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# ConfluenceDataSourceConfigurationOutputTypeDef definition

class ConfluenceDataSourceConfigurationOutputTypeDef(TypedDict):
    sourceConfiguration: ConfluenceSourceConfigurationTypeDef,  # (2)
    crawlerConfiguration: NotRequired[ConfluenceCrawlerConfigurationOutputTypeDef],  # (1)
  1. See ConfluenceCrawlerConfigurationOutputTypeDef
  2. See ConfluenceSourceConfigurationTypeDef

SalesforceDataSourceConfigurationOutputTypeDef#

# SalesforceDataSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SalesforceDataSourceConfigurationOutputTypeDef


def get_value() -> SalesforceDataSourceConfigurationOutputTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# SalesforceDataSourceConfigurationOutputTypeDef definition

class SalesforceDataSourceConfigurationOutputTypeDef(TypedDict):
    sourceConfiguration: SalesforceSourceConfigurationTypeDef,  # (2)
    crawlerConfiguration: NotRequired[SalesforceCrawlerConfigurationOutputTypeDef],  # (1)
  1. See SalesforceCrawlerConfigurationOutputTypeDef
  2. See SalesforceSourceConfigurationTypeDef

SharePointDataSourceConfigurationOutputTypeDef#

# SharePointDataSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SharePointDataSourceConfigurationOutputTypeDef


def get_value() -> SharePointDataSourceConfigurationOutputTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# SharePointDataSourceConfigurationOutputTypeDef definition

class SharePointDataSourceConfigurationOutputTypeDef(TypedDict):
    sourceConfiguration: SharePointSourceConfigurationOutputTypeDef,  # (2)
    crawlerConfiguration: NotRequired[SharePointCrawlerConfigurationOutputTypeDef],  # (1)
  1. See SharePointCrawlerConfigurationOutputTypeDef
  2. See SharePointSourceConfigurationOutputTypeDef

ConfluenceDataSourceConfigurationTypeDef#

# ConfluenceDataSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ConfluenceDataSourceConfigurationTypeDef


def get_value() -> ConfluenceDataSourceConfigurationTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# ConfluenceDataSourceConfigurationTypeDef definition

class ConfluenceDataSourceConfigurationTypeDef(TypedDict):
    sourceConfiguration: ConfluenceSourceConfigurationTypeDef,  # (2)
    crawlerConfiguration: NotRequired[ConfluenceCrawlerConfigurationTypeDef],  # (1)
  1. See ConfluenceCrawlerConfigurationTypeDef
  2. See ConfluenceSourceConfigurationTypeDef

SalesforceDataSourceConfigurationTypeDef#

# SalesforceDataSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SalesforceDataSourceConfigurationTypeDef


def get_value() -> SalesforceDataSourceConfigurationTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# SalesforceDataSourceConfigurationTypeDef definition

class SalesforceDataSourceConfigurationTypeDef(TypedDict):
    sourceConfiguration: SalesforceSourceConfigurationTypeDef,  # (2)
    crawlerConfiguration: NotRequired[SalesforceCrawlerConfigurationTypeDef],  # (1)
  1. See SalesforceCrawlerConfigurationTypeDef
  2. See SalesforceSourceConfigurationTypeDef

SharePointDataSourceConfigurationTypeDef#

# SharePointDataSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SharePointDataSourceConfigurationTypeDef


def get_value() -> SharePointDataSourceConfigurationTypeDef:
    return {
        "crawlerConfiguration": ...,
    }


# SharePointDataSourceConfigurationTypeDef definition

class SharePointDataSourceConfigurationTypeDef(TypedDict):
    sourceConfiguration: SharePointSourceConfigurationTypeDef,  # (2)
    crawlerConfiguration: NotRequired[SharePointCrawlerConfigurationTypeDef],  # (1)
  1. See SharePointCrawlerConfigurationTypeDef
  2. See SharePointSourceConfigurationTypeDef

RedshiftConfigurationOutputTypeDef#

# RedshiftConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftConfigurationOutputTypeDef


def get_value() -> RedshiftConfigurationOutputTypeDef:
    return {
        "queryEngineConfiguration": ...,
    }


# RedshiftConfigurationOutputTypeDef definition

class RedshiftConfigurationOutputTypeDef(TypedDict):
    queryEngineConfiguration: RedshiftQueryEngineConfigurationTypeDef,  # (1)
    storageConfigurations: List[RedshiftQueryEngineStorageConfigurationOutputTypeDef],  # (3)
    queryGenerationConfiguration: NotRequired[QueryGenerationConfigurationOutputTypeDef],  # (2)
  1. See RedshiftQueryEngineConfigurationTypeDef
  2. See QueryGenerationConfigurationOutputTypeDef
  3. See List[RedshiftQueryEngineStorageConfigurationOutputTypeDef]

RedshiftConfigurationTypeDef#

# RedshiftConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import RedshiftConfigurationTypeDef


def get_value() -> RedshiftConfigurationTypeDef:
    return {
        "queryEngineConfiguration": ...,
    }


# RedshiftConfigurationTypeDef definition

class RedshiftConfigurationTypeDef(TypedDict):
    queryEngineConfiguration: RedshiftQueryEngineConfigurationTypeDef,  # (1)
    storageConfigurations: Sequence[RedshiftQueryEngineStorageConfigurationTypeDef],  # (3)
    queryGenerationConfiguration: NotRequired[QueryGenerationConfigurationTypeDef],  # (2)
  1. See RedshiftQueryEngineConfigurationTypeDef
  2. See QueryGenerationConfigurationTypeDef
  3. See Sequence[RedshiftQueryEngineStorageConfigurationTypeDef]

ChatPromptTemplateConfigurationOutputTypeDef#

# ChatPromptTemplateConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ChatPromptTemplateConfigurationOutputTypeDef


def get_value() -> ChatPromptTemplateConfigurationOutputTypeDef:
    return {
        "inputVariables": ...,
    }


# ChatPromptTemplateConfigurationOutputTypeDef definition

class ChatPromptTemplateConfigurationOutputTypeDef(TypedDict):
    messages: List[MessageOutputTypeDef],  # (2)
    inputVariables: NotRequired[List[PromptInputVariableTypeDef]],  # (1)
    system: NotRequired[List[SystemContentBlockTypeDef]],  # (3)
    toolConfiguration: NotRequired[ToolConfigurationOutputTypeDef],  # (4)
  1. See List[PromptInputVariableTypeDef]
  2. See List[MessageOutputTypeDef]
  3. See List[SystemContentBlockTypeDef]
  4. See ToolConfigurationOutputTypeDef

ToolTypeDef#

# ToolTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolTypeDef


def get_value() -> ToolTypeDef:
    return {
        "cachePoint": ...,
    }


# ToolTypeDef definition

class ToolTypeDef(TypedDict):
    cachePoint: NotRequired[CachePointBlockTypeDef],  # (1)
    toolSpec: NotRequired[ToolSpecificationUnionTypeDef],  # (2)
  1. See CachePointBlockTypeDef
  2. See ToolSpecificationUnionTypeDef

VectorIngestionConfigurationOutputTypeDef#

# VectorIngestionConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import VectorIngestionConfigurationOutputTypeDef


def get_value() -> VectorIngestionConfigurationOutputTypeDef:
    return {
        "chunkingConfiguration": ...,
    }


# VectorIngestionConfigurationOutputTypeDef definition

class VectorIngestionConfigurationOutputTypeDef(TypedDict):
    chunkingConfiguration: NotRequired[ChunkingConfigurationOutputTypeDef],  # (1)
    contextEnrichmentConfiguration: NotRequired[ContextEnrichmentConfigurationTypeDef],  # (2)
    customTransformationConfiguration: NotRequired[CustomTransformationConfigurationOutputTypeDef],  # (3)
    parsingConfiguration: NotRequired[ParsingConfigurationTypeDef],  # (4)
  1. See ChunkingConfigurationOutputTypeDef
  2. See ContextEnrichmentConfigurationTypeDef
  3. See CustomTransformationConfigurationOutputTypeDef
  4. See ParsingConfigurationTypeDef

VectorIngestionConfigurationTypeDef#

# VectorIngestionConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import VectorIngestionConfigurationTypeDef


def get_value() -> VectorIngestionConfigurationTypeDef:
    return {
        "chunkingConfiguration": ...,
    }


# VectorIngestionConfigurationTypeDef definition

class VectorIngestionConfigurationTypeDef(TypedDict):
    chunkingConfiguration: NotRequired[ChunkingConfigurationTypeDef],  # (1)
    contextEnrichmentConfiguration: NotRequired[ContextEnrichmentConfigurationTypeDef],  # (2)
    customTransformationConfiguration: NotRequired[CustomTransformationConfigurationTypeDef],  # (3)
    parsingConfiguration: NotRequired[ParsingConfigurationTypeDef],  # (4)
  1. See ChunkingConfigurationTypeDef
  2. See ContextEnrichmentConfigurationTypeDef
  3. See CustomTransformationConfigurationTypeDef
  4. See ParsingConfigurationTypeDef

KnowledgeBaseDocumentTypeDef#

# KnowledgeBaseDocumentTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseDocumentTypeDef


def get_value() -> KnowledgeBaseDocumentTypeDef:
    return {
        "content": ...,
    }


# KnowledgeBaseDocumentTypeDef definition

class KnowledgeBaseDocumentTypeDef(TypedDict):
    content: DocumentContentTypeDef,  # (1)
    metadata: NotRequired[DocumentMetadataTypeDef],  # (2)
  1. See DocumentContentTypeDef
  2. See DocumentMetadataTypeDef

DataSourceConfigurationOutputTypeDef#

# DataSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DataSourceConfigurationOutputTypeDef


def get_value() -> DataSourceConfigurationOutputTypeDef:
    return {
        "confluenceConfiguration": ...,
    }


# 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)
  1. See ConfluenceDataSourceConfigurationOutputTypeDef
  2. See S3DataSourceConfigurationOutputTypeDef
  3. See SalesforceDataSourceConfigurationOutputTypeDef
  4. See SharePointDataSourceConfigurationOutputTypeDef
  5. See DataSourceTypeType
  6. See WebDataSourceConfigurationOutputTypeDef

DataSourceConfigurationTypeDef#

# DataSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DataSourceConfigurationTypeDef


def get_value() -> DataSourceConfigurationTypeDef:
    return {
        "confluenceConfiguration": ...,
    }


# 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)
  1. See ConfluenceDataSourceConfigurationTypeDef
  2. See S3DataSourceConfigurationTypeDef
  3. See SalesforceDataSourceConfigurationTypeDef
  4. See SharePointDataSourceConfigurationTypeDef
  5. See DataSourceTypeType
  6. See WebDataSourceConfigurationTypeDef

SqlKnowledgeBaseConfigurationOutputTypeDef#

# SqlKnowledgeBaseConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SqlKnowledgeBaseConfigurationOutputTypeDef


def get_value() -> SqlKnowledgeBaseConfigurationOutputTypeDef:
    return {
        "redshiftConfiguration": ...,
    }


# SqlKnowledgeBaseConfigurationOutputTypeDef definition

class SqlKnowledgeBaseConfigurationOutputTypeDef(TypedDict):
    type: QueryEngineTypeType,  # (2)
    redshiftConfiguration: NotRequired[RedshiftConfigurationOutputTypeDef],  # (1)
  1. See RedshiftConfigurationOutputTypeDef
  2. See QueryEngineTypeType

SqlKnowledgeBaseConfigurationTypeDef#

# SqlKnowledgeBaseConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import SqlKnowledgeBaseConfigurationTypeDef


def get_value() -> SqlKnowledgeBaseConfigurationTypeDef:
    return {
        "redshiftConfiguration": ...,
    }


# SqlKnowledgeBaseConfigurationTypeDef definition

class SqlKnowledgeBaseConfigurationTypeDef(TypedDict):
    type: QueryEngineTypeType,  # (2)
    redshiftConfiguration: NotRequired[RedshiftConfigurationTypeDef],  # (1)
  1. See RedshiftConfigurationTypeDef
  2. See QueryEngineTypeType

PromptTemplateConfigurationOutputTypeDef#

# PromptTemplateConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptTemplateConfigurationOutputTypeDef


def get_value() -> PromptTemplateConfigurationOutputTypeDef:
    return {
        "chat": ...,
    }


# PromptTemplateConfigurationOutputTypeDef definition

class PromptTemplateConfigurationOutputTypeDef(TypedDict):
    chat: NotRequired[ChatPromptTemplateConfigurationOutputTypeDef],  # (1)
    text: NotRequired[TextPromptTemplateConfigurationOutputTypeDef],  # (2)
  1. See ChatPromptTemplateConfigurationOutputTypeDef
  2. See TextPromptTemplateConfigurationOutputTypeDef

IngestKnowledgeBaseDocumentsRequestTypeDef#

# IngestKnowledgeBaseDocumentsRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import IngestKnowledgeBaseDocumentsRequestTypeDef


def get_value() -> IngestKnowledgeBaseDocumentsRequestTypeDef:
    return {
        "dataSourceId": ...,
    }


# IngestKnowledgeBaseDocumentsRequestTypeDef definition

class IngestKnowledgeBaseDocumentsRequestTypeDef(TypedDict):
    dataSourceId: str,
    documents: Sequence[KnowledgeBaseDocumentTypeDef],  # (1)
    knowledgeBaseId: str,
    clientToken: NotRequired[str],
  1. See Sequence[KnowledgeBaseDocumentTypeDef]

DataSourceTypeDef#

# DataSourceTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import DataSourceTypeDef


def get_value() -> DataSourceTypeDef:
    return {
        "createdAt": ...,
    }


# DataSourceTypeDef definition

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

KnowledgeBaseConfigurationOutputTypeDef#

# KnowledgeBaseConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseConfigurationOutputTypeDef


def get_value() -> KnowledgeBaseConfigurationOutputTypeDef:
    return {
        "kendraKnowledgeBaseConfiguration": ...,
    }


# KnowledgeBaseConfigurationOutputTypeDef definition

class KnowledgeBaseConfigurationOutputTypeDef(TypedDict):
    type: KnowledgeBaseTypeType,  # (3)
    kendraKnowledgeBaseConfiguration: NotRequired[KendraKnowledgeBaseConfigurationTypeDef],  # (1)
    sqlKnowledgeBaseConfiguration: NotRequired[SqlKnowledgeBaseConfigurationOutputTypeDef],  # (2)
    vectorKnowledgeBaseConfiguration: NotRequired[VectorKnowledgeBaseConfigurationOutputTypeDef],  # (4)
  1. See KendraKnowledgeBaseConfigurationTypeDef
  2. See SqlKnowledgeBaseConfigurationOutputTypeDef
  3. See KnowledgeBaseTypeType
  4. See VectorKnowledgeBaseConfigurationOutputTypeDef

KnowledgeBaseConfigurationTypeDef#

# KnowledgeBaseConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseConfigurationTypeDef


def get_value() -> KnowledgeBaseConfigurationTypeDef:
    return {
        "kendraKnowledgeBaseConfiguration": ...,
    }


# KnowledgeBaseConfigurationTypeDef definition

class KnowledgeBaseConfigurationTypeDef(TypedDict):
    type: KnowledgeBaseTypeType,  # (3)
    kendraKnowledgeBaseConfiguration: NotRequired[KendraKnowledgeBaseConfigurationTypeDef],  # (1)
    sqlKnowledgeBaseConfiguration: NotRequired[SqlKnowledgeBaseConfigurationTypeDef],  # (2)
    vectorKnowledgeBaseConfiguration: NotRequired[VectorKnowledgeBaseConfigurationTypeDef],  # (4)
  1. See KendraKnowledgeBaseConfigurationTypeDef
  2. See SqlKnowledgeBaseConfigurationTypeDef
  3. See KnowledgeBaseTypeType
  4. See VectorKnowledgeBaseConfigurationTypeDef

PromptFlowNodeInlineConfigurationOutputTypeDef#

# PromptFlowNodeInlineConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeInlineConfigurationOutputTypeDef


def get_value() -> PromptFlowNodeInlineConfigurationOutputTypeDef:
    return {
        "additionalModelRequestFields": ...,
    }


# PromptFlowNodeInlineConfigurationOutputTypeDef definition

class PromptFlowNodeInlineConfigurationOutputTypeDef(TypedDict):
    modelId: str,
    templateConfiguration: PromptTemplateConfigurationOutputTypeDef,  # (2)
    templateType: PromptTemplateTypeType,  # (3)
    additionalModelRequestFields: NotRequired[Dict[str, Any]],
    inferenceConfiguration: NotRequired[PromptInferenceConfigurationOutputTypeDef],  # (1)
  1. See PromptInferenceConfigurationOutputTypeDef
  2. See PromptTemplateConfigurationOutputTypeDef
  3. See PromptTemplateTypeType

PromptVariantOutputTypeDef#

# PromptVariantOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptVariantOutputTypeDef


def get_value() -> PromptVariantOutputTypeDef:
    return {
        "additionalModelRequestFields": ...,
    }


# PromptVariantOutputTypeDef definition

class PromptVariantOutputTypeDef(TypedDict):
    name: str,
    templateConfiguration: PromptTemplateConfigurationOutputTypeDef,  # (4)
    templateType: PromptTemplateTypeType,  # (5)
    additionalModelRequestFields: NotRequired[Dict[str, Any]],
    genAiResource: NotRequired[PromptGenAiResourceTypeDef],  # (1)
    inferenceConfiguration: NotRequired[PromptInferenceConfigurationOutputTypeDef],  # (2)
    metadata: NotRequired[List[PromptMetadataEntryTypeDef]],  # (3)
    modelId: NotRequired[str],
  1. See PromptGenAiResourceTypeDef
  2. See PromptInferenceConfigurationOutputTypeDef
  3. See List[PromptMetadataEntryTypeDef]
  4. See PromptTemplateConfigurationOutputTypeDef
  5. See PromptTemplateTypeType

ToolConfigurationTypeDef#

# ToolConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ToolConfigurationTypeDef


def get_value() -> ToolConfigurationTypeDef:
    return {
        "toolChoice": ...,
    }


# ToolConfigurationTypeDef definition

class ToolConfigurationTypeDef(TypedDict):
    tools: Sequence[ToolUnionTypeDef],  # (2)
    toolChoice: NotRequired[ToolChoiceUnionTypeDef],  # (1)
  1. See ToolChoiceUnionTypeDef
  2. See Sequence[ToolUnionTypeDef]

CreateDataSourceResponseTypeDef#

# CreateDataSourceResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateDataSourceResponseTypeDef


def get_value() -> CreateDataSourceResponseTypeDef:
    return {
        "dataSource": ...,
    }


# CreateDataSourceResponseTypeDef definition

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

GetDataSourceResponseTypeDef#

# GetDataSourceResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetDataSourceResponseTypeDef


def get_value() -> GetDataSourceResponseTypeDef:
    return {
        "dataSource": ...,
    }


# GetDataSourceResponseTypeDef definition

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

UpdateDataSourceResponseTypeDef#

# UpdateDataSourceResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateDataSourceResponseTypeDef


def get_value() -> UpdateDataSourceResponseTypeDef:
    return {
        "dataSource": ...,
    }


# UpdateDataSourceResponseTypeDef definition

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

CreateDataSourceRequestTypeDef#

# CreateDataSourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateDataSourceRequestTypeDef


def get_value() -> CreateDataSourceRequestTypeDef:
    return {
        "dataSourceConfiguration": ...,
    }


# CreateDataSourceRequestTypeDef definition

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

UpdateDataSourceRequestTypeDef#

# UpdateDataSourceRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateDataSourceRequestTypeDef


def get_value() -> UpdateDataSourceRequestTypeDef:
    return {
        "dataSourceConfiguration": ...,
    }


# UpdateDataSourceRequestTypeDef definition

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

KnowledgeBaseTypeDef#

# KnowledgeBaseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import KnowledgeBaseTypeDef


def get_value() -> KnowledgeBaseTypeDef:
    return {
        "createdAt": ...,
    }


# KnowledgeBaseTypeDef definition

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

PromptFlowNodeSourceConfigurationOutputTypeDef#

# PromptFlowNodeSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeSourceConfigurationOutputTypeDef


def get_value() -> PromptFlowNodeSourceConfigurationOutputTypeDef:
    return {
        "inline": ...,
    }


# PromptFlowNodeSourceConfigurationOutputTypeDef definition

class PromptFlowNodeSourceConfigurationOutputTypeDef(TypedDict):
    inline: NotRequired[PromptFlowNodeInlineConfigurationOutputTypeDef],  # (1)
    resource: NotRequired[PromptFlowNodeResourceConfigurationTypeDef],  # (2)
  1. See PromptFlowNodeInlineConfigurationOutputTypeDef
  2. See PromptFlowNodeResourceConfigurationTypeDef

CreatePromptResponseTypeDef#

# CreatePromptResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreatePromptResponseTypeDef


def get_value() -> CreatePromptResponseTypeDef:
    return {
        "arn": ...,
    }


# CreatePromptResponseTypeDef definition

class CreatePromptResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    defaultVariant: str,
    description: str,
    id: str,
    name: str,
    updatedAt: datetime.datetime,
    variants: List[PromptVariantOutputTypeDef],  # (1)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[PromptVariantOutputTypeDef]
  2. See ResponseMetadataTypeDef

CreatePromptVersionResponseTypeDef#

# CreatePromptVersionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreatePromptVersionResponseTypeDef


def get_value() -> CreatePromptVersionResponseTypeDef:
    return {
        "arn": ...,
    }


# CreatePromptVersionResponseTypeDef definition

class CreatePromptVersionResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    defaultVariant: str,
    description: str,
    id: str,
    name: str,
    updatedAt: datetime.datetime,
    variants: List[PromptVariantOutputTypeDef],  # (1)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[PromptVariantOutputTypeDef]
  2. See ResponseMetadataTypeDef

GetPromptResponseTypeDef#

# GetPromptResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetPromptResponseTypeDef


def get_value() -> GetPromptResponseTypeDef:
    return {
        "arn": ...,
    }


# GetPromptResponseTypeDef definition

class GetPromptResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    defaultVariant: str,
    description: str,
    id: str,
    name: str,
    updatedAt: datetime.datetime,
    variants: List[PromptVariantOutputTypeDef],  # (1)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[PromptVariantOutputTypeDef]
  2. See ResponseMetadataTypeDef

UpdatePromptResponseTypeDef#

# UpdatePromptResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdatePromptResponseTypeDef


def get_value() -> UpdatePromptResponseTypeDef:
    return {
        "arn": ...,
    }


# UpdatePromptResponseTypeDef definition

class UpdatePromptResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    defaultVariant: str,
    description: str,
    id: str,
    name: str,
    updatedAt: datetime.datetime,
    variants: List[PromptVariantOutputTypeDef],  # (1)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[PromptVariantOutputTypeDef]
  2. See ResponseMetadataTypeDef

CreateKnowledgeBaseResponseTypeDef#

# CreateKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateKnowledgeBaseResponseTypeDef


def get_value() -> CreateKnowledgeBaseResponseTypeDef:
    return {
        "knowledgeBase": ...,
    }


# CreateKnowledgeBaseResponseTypeDef definition

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

GetKnowledgeBaseResponseTypeDef#

# GetKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetKnowledgeBaseResponseTypeDef


def get_value() -> GetKnowledgeBaseResponseTypeDef:
    return {
        "knowledgeBase": ...,
    }


# GetKnowledgeBaseResponseTypeDef definition

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

UpdateKnowledgeBaseResponseTypeDef#

# UpdateKnowledgeBaseResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateKnowledgeBaseResponseTypeDef


def get_value() -> UpdateKnowledgeBaseResponseTypeDef:
    return {
        "knowledgeBase": ...,
    }


# UpdateKnowledgeBaseResponseTypeDef definition

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

CreateKnowledgeBaseRequestTypeDef#

# CreateKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateKnowledgeBaseRequestTypeDef


def get_value() -> CreateKnowledgeBaseRequestTypeDef:
    return {
        "knowledgeBaseConfiguration": ...,
    }


# CreateKnowledgeBaseRequestTypeDef definition

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

UpdateKnowledgeBaseRequestTypeDef#

# UpdateKnowledgeBaseRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateKnowledgeBaseRequestTypeDef


def get_value() -> UpdateKnowledgeBaseRequestTypeDef:
    return {
        "knowledgeBaseConfiguration": ...,
    }


# UpdateKnowledgeBaseRequestTypeDef definition

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

PromptFlowNodeConfigurationOutputTypeDef#

# PromptFlowNodeConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeConfigurationOutputTypeDef


def get_value() -> PromptFlowNodeConfigurationOutputTypeDef:
    return {
        "guardrailConfiguration": ...,
    }


# PromptFlowNodeConfigurationOutputTypeDef definition

class PromptFlowNodeConfigurationOutputTypeDef(TypedDict):
    sourceConfiguration: PromptFlowNodeSourceConfigurationOutputTypeDef,  # (2)
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (1)
  1. See GuardrailConfigurationTypeDef
  2. See PromptFlowNodeSourceConfigurationOutputTypeDef

ChatPromptTemplateConfigurationTypeDef#

# ChatPromptTemplateConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ChatPromptTemplateConfigurationTypeDef


def get_value() -> ChatPromptTemplateConfigurationTypeDef:
    return {
        "inputVariables": ...,
    }


# ChatPromptTemplateConfigurationTypeDef definition

class ChatPromptTemplateConfigurationTypeDef(TypedDict):
    messages: Sequence[MessageUnionTypeDef],  # (2)
    inputVariables: NotRequired[Sequence[PromptInputVariableTypeDef]],  # (1)
    system: NotRequired[Sequence[SystemContentBlockTypeDef]],  # (3)
    toolConfiguration: NotRequired[ToolConfigurationUnionTypeDef],  # (4)
  1. See Sequence[PromptInputVariableTypeDef]
  2. See Sequence[MessageUnionTypeDef]
  3. See Sequence[SystemContentBlockTypeDef]
  4. See ToolConfigurationUnionTypeDef

FlowNodeConfigurationOutputTypeDef#

# FlowNodeConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowNodeConfigurationOutputTypeDef


def get_value() -> FlowNodeConfigurationOutputTypeDef:
    return {
        "agent": ...,
    }


# 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)
  1. See AgentFlowNodeConfigurationTypeDef
  2. See ConditionFlowNodeConfigurationOutputTypeDef
  3. See KnowledgeBaseFlowNodeConfigurationTypeDef
  4. See LambdaFunctionFlowNodeConfigurationTypeDef
  5. See LexFlowNodeConfigurationTypeDef
  6. See PromptFlowNodeConfigurationOutputTypeDef
  7. See RetrievalFlowNodeConfigurationTypeDef
  8. See StorageFlowNodeConfigurationTypeDef

FlowNodeExtraTypeDef#

# FlowNodeExtraTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowNodeExtraTypeDef


def get_value() -> FlowNodeExtraTypeDef:
    return {
        "configuration": ...,
    }


# FlowNodeExtraTypeDef definition

class FlowNodeExtraTypeDef(TypedDict):
    name: str,
    type: FlowNodeTypeType,  # (4)
    configuration: NotRequired[FlowNodeConfigurationOutputTypeDef],  # (1)
    inputs: NotRequired[List[FlowNodeInputTypeDef]],  # (2)
    outputs: NotRequired[List[FlowNodeOutputTypeDef]],  # (3)
  1. See FlowNodeConfigurationOutputTypeDef
  2. See List[FlowNodeInputTypeDef]
  3. See List[FlowNodeOutputTypeDef]
  4. See FlowNodeTypeType

PromptTemplateConfigurationTypeDef#

# PromptTemplateConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptTemplateConfigurationTypeDef


def get_value() -> PromptTemplateConfigurationTypeDef:
    return {
        "chat": ...,
    }


# PromptTemplateConfigurationTypeDef definition

class PromptTemplateConfigurationTypeDef(TypedDict):
    chat: NotRequired[ChatPromptTemplateConfigurationUnionTypeDef],  # (1)
    text: NotRequired[TextPromptTemplateConfigurationUnionTypeDef],  # (2)
  1. See ChatPromptTemplateConfigurationUnionTypeDef
  2. See TextPromptTemplateConfigurationUnionTypeDef

FlowDefinitionOutputTypeDef#

# FlowDefinitionOutputTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowDefinitionOutputTypeDef


def get_value() -> FlowDefinitionOutputTypeDef:
    return {
        "connections": ...,
    }


# FlowDefinitionOutputTypeDef definition

class FlowDefinitionOutputTypeDef(TypedDict):
    connections: NotRequired[List[FlowConnectionTypeDef]],  # (1)
    nodes: NotRequired[List[FlowNodeExtraTypeDef]],  # (2)
  1. See List[FlowConnectionTypeDef]
  2. See List[FlowNodeExtraTypeDef]

PromptFlowNodeInlineConfigurationTypeDef#

# PromptFlowNodeInlineConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeInlineConfigurationTypeDef


def get_value() -> PromptFlowNodeInlineConfigurationTypeDef:
    return {
        "additionalModelRequestFields": ...,
    }


# PromptFlowNodeInlineConfigurationTypeDef definition

class PromptFlowNodeInlineConfigurationTypeDef(TypedDict):
    modelId: str,
    templateConfiguration: PromptTemplateConfigurationTypeDef,  # (2)
    templateType: PromptTemplateTypeType,  # (3)
    additionalModelRequestFields: NotRequired[Mapping[str, Any]],
    inferenceConfiguration: NotRequired[PromptInferenceConfigurationTypeDef],  # (1)
  1. See PromptInferenceConfigurationTypeDef
  2. See PromptTemplateConfigurationTypeDef
  3. See PromptTemplateTypeType

CreateFlowResponseTypeDef#

# CreateFlowResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateFlowResponseTypeDef


def get_value() -> CreateFlowResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateFlowResponseTypeDef definition

class CreateFlowResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    definition: FlowDefinitionOutputTypeDef,  # (1)
    description: str,
    executionRoleArn: str,
    id: str,
    name: str,
    status: FlowStatusType,  # (2)
    updatedAt: datetime.datetime,
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FlowDefinitionOutputTypeDef
  2. See FlowStatusType
  3. See ResponseMetadataTypeDef

CreateFlowVersionResponseTypeDef#

# CreateFlowVersionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateFlowVersionResponseTypeDef


def get_value() -> CreateFlowVersionResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateFlowVersionResponseTypeDef definition

class CreateFlowVersionResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    definition: FlowDefinitionOutputTypeDef,  # (1)
    description: str,
    executionRoleArn: str,
    id: str,
    name: str,
    status: FlowStatusType,  # (2)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FlowDefinitionOutputTypeDef
  2. See FlowStatusType
  3. See ResponseMetadataTypeDef

GetFlowResponseTypeDef#

# GetFlowResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetFlowResponseTypeDef


def get_value() -> GetFlowResponseTypeDef:
    return {
        "arn": ...,
    }


# GetFlowResponseTypeDef definition

class GetFlowResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    definition: FlowDefinitionOutputTypeDef,  # (1)
    description: str,
    executionRoleArn: str,
    id: str,
    name: str,
    status: FlowStatusType,  # (2)
    updatedAt: datetime.datetime,
    validations: List[FlowValidationTypeDef],  # (3)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FlowDefinitionOutputTypeDef
  2. See FlowStatusType
  3. See List[FlowValidationTypeDef]
  4. See ResponseMetadataTypeDef

GetFlowVersionResponseTypeDef#

# GetFlowVersionResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import GetFlowVersionResponseTypeDef


def get_value() -> GetFlowVersionResponseTypeDef:
    return {
        "arn": ...,
    }


# GetFlowVersionResponseTypeDef definition

class GetFlowVersionResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    definition: FlowDefinitionOutputTypeDef,  # (1)
    description: str,
    executionRoleArn: str,
    id: str,
    name: str,
    status: FlowStatusType,  # (2)
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FlowDefinitionOutputTypeDef
  2. See FlowStatusType
  3. See ResponseMetadataTypeDef

UpdateFlowResponseTypeDef#

# UpdateFlowResponseTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateFlowResponseTypeDef


def get_value() -> UpdateFlowResponseTypeDef:
    return {
        "arn": ...,
    }


# UpdateFlowResponseTypeDef definition

class UpdateFlowResponseTypeDef(TypedDict):
    arn: str,
    createdAt: datetime.datetime,
    customerEncryptionKeyArn: str,
    definition: FlowDefinitionOutputTypeDef,  # (1)
    description: str,
    executionRoleArn: str,
    id: str,
    name: str,
    status: FlowStatusType,  # (2)
    updatedAt: datetime.datetime,
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FlowDefinitionOutputTypeDef
  2. See FlowStatusType
  3. See ResponseMetadataTypeDef

PromptFlowNodeSourceConfigurationTypeDef#

# PromptFlowNodeSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeSourceConfigurationTypeDef


def get_value() -> PromptFlowNodeSourceConfigurationTypeDef:
    return {
        "inline": ...,
    }


# PromptFlowNodeSourceConfigurationTypeDef definition

class PromptFlowNodeSourceConfigurationTypeDef(TypedDict):
    inline: NotRequired[PromptFlowNodeInlineConfigurationTypeDef],  # (1)
    resource: NotRequired[PromptFlowNodeResourceConfigurationTypeDef],  # (2)
  1. See PromptFlowNodeInlineConfigurationTypeDef
  2. See PromptFlowNodeResourceConfigurationTypeDef

PromptVariantTypeDef#

# PromptVariantTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptVariantTypeDef


def get_value() -> PromptVariantTypeDef:
    return {
        "additionalModelRequestFields": ...,
    }


# PromptVariantTypeDef definition

class PromptVariantTypeDef(TypedDict):
    name: str,
    templateConfiguration: PromptTemplateConfigurationUnionTypeDef,  # (4)
    templateType: PromptTemplateTypeType,  # (5)
    additionalModelRequestFields: NotRequired[Mapping[str, Any]],
    genAiResource: NotRequired[PromptGenAiResourceTypeDef],  # (1)
    inferenceConfiguration: NotRequired[PromptInferenceConfigurationUnionTypeDef],  # (2)
    metadata: NotRequired[Sequence[PromptMetadataEntryTypeDef]],  # (3)
    modelId: NotRequired[str],
  1. See PromptGenAiResourceTypeDef
  2. See PromptInferenceConfigurationUnionTypeDef
  3. See Sequence[PromptMetadataEntryTypeDef]
  4. See PromptTemplateConfigurationUnionTypeDef
  5. See PromptTemplateTypeType

PromptFlowNodeConfigurationTypeDef#

# PromptFlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import PromptFlowNodeConfigurationTypeDef


def get_value() -> PromptFlowNodeConfigurationTypeDef:
    return {
        "guardrailConfiguration": ...,
    }


# PromptFlowNodeConfigurationTypeDef definition

class PromptFlowNodeConfigurationTypeDef(TypedDict):
    sourceConfiguration: PromptFlowNodeSourceConfigurationTypeDef,  # (2)
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (1)
  1. See GuardrailConfigurationTypeDef
  2. See PromptFlowNodeSourceConfigurationTypeDef

FlowNodeConfigurationTypeDef#

# FlowNodeConfigurationTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowNodeConfigurationTypeDef


def get_value() -> FlowNodeConfigurationTypeDef:
    return {
        "agent": ...,
    }


# 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)
  1. See AgentFlowNodeConfigurationTypeDef
  2. See ConditionFlowNodeConfigurationTypeDef
  3. See KnowledgeBaseFlowNodeConfigurationTypeDef
  4. See LambdaFunctionFlowNodeConfigurationTypeDef
  5. See LexFlowNodeConfigurationTypeDef
  6. See PromptFlowNodeConfigurationTypeDef
  7. See RetrievalFlowNodeConfigurationTypeDef
  8. See StorageFlowNodeConfigurationTypeDef

CreatePromptRequestTypeDef#

# CreatePromptRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreatePromptRequestTypeDef


def get_value() -> CreatePromptRequestTypeDef:
    return {
        "name": ...,
    }


# CreatePromptRequestTypeDef definition

class CreatePromptRequestTypeDef(TypedDict):
    name: str,
    clientToken: NotRequired[str],
    customerEncryptionKeyArn: NotRequired[str],
    defaultVariant: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    variants: NotRequired[Sequence[PromptVariantUnionTypeDef]],  # (1)
  1. See Sequence[PromptVariantUnionTypeDef]

UpdatePromptRequestTypeDef#

# UpdatePromptRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdatePromptRequestTypeDef


def get_value() -> UpdatePromptRequestTypeDef:
    return {
        "name": ...,
    }


# UpdatePromptRequestTypeDef definition

class UpdatePromptRequestTypeDef(TypedDict):
    name: str,
    promptIdentifier: str,
    customerEncryptionKeyArn: NotRequired[str],
    defaultVariant: NotRequired[str],
    description: NotRequired[str],
    variants: NotRequired[Sequence[PromptVariantUnionTypeDef]],  # (1)
  1. See Sequence[PromptVariantUnionTypeDef]

FlowNodeTypeDef#

# FlowNodeTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowNodeTypeDef


def get_value() -> FlowNodeTypeDef:
    return {
        "configuration": ...,
    }


# FlowNodeTypeDef definition

class FlowNodeTypeDef(TypedDict):
    name: str,
    type: FlowNodeTypeType,  # (4)
    configuration: NotRequired[FlowNodeConfigurationTypeDef],  # (1)
    inputs: NotRequired[Sequence[FlowNodeInputTypeDef]],  # (2)
    outputs: NotRequired[Sequence[FlowNodeOutputTypeDef]],  # (3)
  1. See FlowNodeConfigurationTypeDef
  2. See Sequence[FlowNodeInputTypeDef]
  3. See Sequence[FlowNodeOutputTypeDef]
  4. See FlowNodeTypeType

FlowDefinitionTypeDef#

# FlowDefinitionTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import FlowDefinitionTypeDef


def get_value() -> FlowDefinitionTypeDef:
    return {
        "connections": ...,
    }


# FlowDefinitionTypeDef definition

class FlowDefinitionTypeDef(TypedDict):
    connections: NotRequired[Sequence[FlowConnectionTypeDef]],  # (1)
    nodes: NotRequired[Sequence[FlowNodeTypeDef]],  # (2)
  1. See Sequence[FlowConnectionTypeDef]
  2. See Sequence[FlowNodeTypeDef]

CreateFlowRequestTypeDef#

# CreateFlowRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import CreateFlowRequestTypeDef


def get_value() -> CreateFlowRequestTypeDef:
    return {
        "executionRoleArn": ...,
    }


# CreateFlowRequestTypeDef definition

class CreateFlowRequestTypeDef(TypedDict):
    executionRoleArn: str,
    name: str,
    clientToken: NotRequired[str],
    customerEncryptionKeyArn: NotRequired[str],
    definition: NotRequired[FlowDefinitionUnionTypeDef],  # (1)
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See FlowDefinitionUnionTypeDef

UpdateFlowRequestTypeDef#

# UpdateFlowRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import UpdateFlowRequestTypeDef


def get_value() -> UpdateFlowRequestTypeDef:
    return {
        "executionRoleArn": ...,
    }


# UpdateFlowRequestTypeDef definition

class UpdateFlowRequestTypeDef(TypedDict):
    executionRoleArn: str,
    flowIdentifier: str,
    name: str,
    customerEncryptionKeyArn: NotRequired[str],
    definition: NotRequired[FlowDefinitionUnionTypeDef],  # (1)
    description: NotRequired[str],
  1. See FlowDefinitionUnionTypeDef

ValidateFlowDefinitionRequestTypeDef#

# ValidateFlowDefinitionRequestTypeDef TypedDict usage example

from mypy_boto3_bedrock_agent.type_defs import ValidateFlowDefinitionRequestTypeDef


def get_value() -> ValidateFlowDefinitionRequestTypeDef:
    return {
        "definition": ...,
    }


# ValidateFlowDefinitionRequestTypeDef definition

class ValidateFlowDefinitionRequestTypeDef(TypedDict):
    definition: FlowDefinitionUnionTypeDef,  # (1)
  1. See FlowDefinitionUnionTypeDef