Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Agents for Amazon Bedrock Runtime can respond with.

Structs

ActionGroupInvocationInput

Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.

ActionGroupInvocationOutput

Contains the JSON-formatted string returned by the API invoked by the action group.

AgentActionGroup

Contains details of the inline agent's action group.

AgentCollaboratorInputPayload

Input for an agent collaborator. The input can be text or an action invocation result.

AgentCollaboratorInvocationInput

An agent collaborator invocation input.

AgentCollaboratorInvocationOutput

Output from an agent collaborator.

AgentCollaboratorOutputPayload

Output from an agent collaborator. The output can be text or an action invocation result.

AnalyzePromptEvent

An event in which the prompt was analyzed in preparation for optimization.

ApiInvocationInput

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

ApiParameter

Information about a parameter to provide to the API request.

This data type is used in the following API operations:

• InvokeAgent response

ApiRequestBody

The request body to provide for the API request, as the agent elicited from the user.

This data type is used in the following API operations:

• InvokeAgent response

ApiResult

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

• In the returnControlInvocationResults of the InvokeAgent request

Attribution

Contains citations for a part of an agent response.

BedrockModelConfigurations

Settings for a model called with InvokeAgent.

BedrockRerankingConfiguration

Contains configurations for an Amazon Bedrock reranker model.

BedrockRerankingModelConfiguration

Contains configurations for a reranker model.

ByteContentDoc

This property contains the document to chat with, along with its attributes.

ByteContentFile

The property contains the file to chat with, along with its attributes.

Citation

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

• InvokeAgent response – in the citations field

• RetrieveAndGenerate response – in the citations field

CitationEvent

A citation event.

CodeInterpreterInvocationInput

Contains information about the code interpreter being invoked.

CodeInterpreterInvocationOutput

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

Collaborator

List of inline collaborators.

CollaboratorConfiguration

Settings of an inline collaborator agent.

ConditionResultEvent

Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

ContentBody

Contains the body of the API response.

This data type is used in the following API operations:

• In the returnControlInvocationResults field of the InvokeAgent request

ConversationHistory

A conversation history.

CustomOrchestration

Contains details of the custom orchestration configured for the agent.

CustomOrchestrationTrace

The trace behavior for the custom orchestration.

CustomOrchestrationTraceEvent

The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.

ExternalSource

The unique external source of the content contained in the wrapper object.

ExternalSourcesGenerationConfiguration

Contains the generation configuration of the external source wrapper object.

ExternalSourcesRetrieveAndGenerateConfiguration

The configurations of the external source wrapper object in the retrieveAndGenerate function.

FailureTrace

Contains information about the failure of the interaction.

FieldForReranking

Contains information for a metadata field to include in or exclude from consideration when reranking.

FilePart

Contains intermediate response for code interpreter if any files have been generated.

FileSource

The source file of the content contained in the wrapper object.

FilterAttribute

Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.

This data type is used in the following API operations:

• RetrieveAndGenerate request

FinalResponse

Contains details about the response to the user.

FlowCompletionEvent

Contains information about why a flow completed.

FlowExecutionError

Contains information about an error that occurred during an flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowExecutionInputEvent

Contains information about the inputs provided to the flow at the start of a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowExecutionOutputEvent

Contains information about the outputs produced by the flow during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowExecutionSummary

Contains summary information about a flow execution, including its status, timestamps, and identifiers.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowFailureEvent

Contains information about a failure that occurred at the flow level during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowInput

Contains information about an input into the prompt flow and where to send it.

FlowInputField

Represents an input field provided to a flow during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowMultiTurnInputRequestEvent

Response object from the flow multi-turn node requesting additional information.

FlowOutputEvent

Contains information about an output from prompt flow invoction.

FlowOutputField

Represents an output field produced by a flow during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowTraceCondition

Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceConditionNodeResultEvent

Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceEvent

Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceNodeActionEvent

Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.

FlowTraceNodeInputEvent

Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceNodeInputField

Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceNodeOutputEvent

Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceNodeOutputField

Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FunctionDefinition

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

FunctionInvocationInput

Contains information about the function that the agent predicts should be called.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

FunctionParameter

Contains information about a parameter of the function.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

FunctionResult

Contains information about the function that was called from the action group and the response that was returned.

This data type is used in the following API operations:

• In the returnControlInvocationResults of the InvokeAgent request

GeneratedQuery

Contains information about a query generated for a natural language query.

GeneratedResponsePart

Contains metadata about a part of the generated response that is accompanied by a citation.

This data type is used in the following API operations:

• InvokeAgent response – in the generatedResponsePart field

• RetrieveAndGenerate response – in the generatedResponsePart field

GenerationConfiguration

Contains configurations for response generation based on the knowledge base query results.

This data type is used in the following API operations:

• RetrieveAndGenerate request

GuardrailAssessment

Assessment details of the content analyzed by Guardrails.

GuardrailConfiguration

The configuration details for the guardrail.

GuardrailConfigurationWithArn

The configuration details for the guardrail.

GuardrailContentFilter

Details of the content filter used in the Guardrail.

GuardrailContentPolicyAssessment

The details of the policy assessment in the Guardrails filter.

GuardrailCustomWord

The custom word details for the filter in the Guardrail.

GuardrailEvent

A guardrail event.

GuardrailManagedWord

The managed word details for the filter in the Guardrail.

GuardrailPiiEntityFilter

The Guardrail filter to identify and remove personally identifiable information (PII).

GuardrailRegexFilter

The details for the regex filter used in the Guardrail.

GuardrailSensitiveInformationPolicyAssessment

The details of the sensitive policy assessment used in the Guardrail.

GuardrailTopic

The details for a specific topic defined in the Guardrail.

GuardrailTopicPolicyAssessment

The details of the policy assessment used in the Guardrail.

GuardrailTrace

The trace details used in the Guardrail.

GuardrailWordPolicyAssessment

The assessment details for words defined in the Guardrail filter.

ImageBlock

Image content for an invocation step.

ImageInput

Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

ImplicitFilterConfiguration

Settings for implicit filtering, where a model generates a metadata filter based on the prompt.

InferenceConfig

The configuration for inference settings when generating responses using RetrieveAndGenerate.

InferenceConfiguration

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

InlineAgentFilePart

Contains intermediate response for code interpreter if any files have been generated.

InlineAgentPayloadPart

Contains a part of an agent response and citations for it.

InlineAgentReturnControlPayload

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the InvokeAgent response API operation.

InlineAgentTracePart

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

InlineBedrockModelConfigurations

Settings for a model called with InvokeInlineAgent.

InlineSessionState

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context

InputFile

Contains details of the source files.

InvocationInput

Contains information pertaining to the action group or knowledge base that is being invoked.

InvocationStep

Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

InvocationStepSummary

Contains details about an invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

InvocationSummary

Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

KnowledgeBase

Details of the knowledge base associated withe inline agent.

KnowledgeBaseConfiguration

Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.

KnowledgeBaseLookupInput

Contains details about the knowledge base to look up and the query to be made.

KnowledgeBaseLookupOutput

Contains details about the results from looking up the knowledge base.

KnowledgeBaseQuery

Contains the query made to the knowledge base.

This data type is used in the following API operations:

• Retrieve request – in the retrievalQuery field

KnowledgeBaseRetrievalConfiguration

Contains configurations for knowledge base query. For more information, see Query configurations.

This data type is used in the following API operations:

• Retrieve request – in the retrievalConfiguration field

• RetrieveAndGenerate request – in the retrievalConfiguration field

KnowledgeBaseRetrievalResult

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

• Retrieve response – in the retrievalResults field

KnowledgeBaseRetrieveAndGenerateConfiguration

Contains details about the resource being queried.

This data type is used in the following API operations:

• Retrieve request – in the knowledgeBaseConfiguration field

• RetrieveAndGenerate request – in the knowledgeBaseConfiguration field

KnowledgeBaseVectorSearchConfiguration

Configurations for how to perform the search query and return results. For more information, see Query configurations.

This data type is used in the following API operations:

• Retrieve request – in the vectorSearchConfiguration field

• RetrieveAndGenerate request – in the vectorSearchConfiguration field

MemorySessionSummary

Contains details of a session summary.

Message

Details about a message.

Metadata

Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.

MetadataAttributeSchema

Details about a metadata attribute.

MetadataConfigurationForReranking

Contains configurations for the metadata to use in reranking.

ModelInvocationInput

The input for the pre-processing step.

• The type matches the agent step.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

ModelPerformanceConfiguration

The performance configuration for a model called with InvokeFlow.

NodeFailureEvent

Contains information about a failure that occurred at a specific node during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

NodeInputEvent

Contains information about the inputs provided to a specific node during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

NodeInputField

Represents an input field provided to a node during a flow execution.

NodeOutputEvent

Contains information about the outputs produced by a specific node during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

NodeOutputField

Represents an output field produced by a node during a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

Observation

Contains the result or output of an action group or knowledge base, or the response to the user.

OptimizedPromptEvent

An event in which the prompt was optimized.

OrchestrationConfiguration

Settings for how the model processes the prompt prior to retrieval and generation.

OrchestrationModelInvocationOutput

The foundation model output from the orchestration step.

OutputFile

Contains details of the response from code interpreter.

Parameter

A parameter for the API request or function.

ParameterDetail

Contains details about a parameter in a function for an action group.

PayloadPart

Contains a part of an agent response and citations for it.

PerformanceConfiguration

Performance settings for a model.

PostProcessingModelInvocationOutput

The foundation model output from the post-processing step.

PostProcessingParsedResponse

Details about the response from the Lambda parsing of the output from the post-processing step.

PreProcessingModelInvocationOutput

The foundation model output from the pre-processing step.

PreProcessingParsedResponse

Details about the response from the Lambda parsing of the output from the pre-processing step.

PromptConfiguration

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

PromptCreationConfigurations

Specifies parameters that control how the service populates the agent prompt for an InvokeAgent or InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

PromptOverrideConfiguration

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

PromptTemplate

Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the filter field

PropertyParameters

Contains the parameters in the request body.

QueryGenerationInput

Contains information about a natural language query to transform into SQL.

QueryTransformationConfiguration

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

Rationale

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

RawResponse

Contains the raw output from the foundation model.

ReasoningTextBlock

Contains information about the reasoning that the model used to return the content in the content block.

RepromptResponse

Contains details about the agent's response to reprompt the input.

RequestBody

The parameters in the API request body.

RerankDocument

Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.

RerankQuery

Contains information about a query to submit to the reranker model.

RerankResult

Contains information about a document that was reranked.

RerankSource

Contains information about a source for reranking.

RerankTextDocument

Contains information about a text document to rerank.

RerankingConfiguration

Contains configurations for reranking.

RetrievalResultConfluenceLocation

The Confluence data source location.

RetrievalResultContent

Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.

This data type is used in the following API operations:

• Retrieve response – in the content field

• RetrieveAndGenerate response – in the content field

• InvokeAgent response – in the content field

RetrievalResultContentColumn

Contains information about a column with a cell to return in retrieval.

RetrievalResultCustomDocumentLocation

Contains information about the location of a document in a custom data source.

RetrievalResultKendraDocumentLocation

The location of a result in Amazon Kendra.

RetrievalResultLocation

Contains information about the data source location.

This data type is used in the following API operations:

• Retrieve response – in the location field

• RetrieveAndGenerate response – in the location field

• InvokeAgent response – in the location field

RetrievalResultS3Location

The S3 data source location.

This data type is used in the following API operations:

• Retrieve response – in the s3Location field

• RetrieveAndGenerate response – in the s3Location field

• InvokeAgent response – in the s3Location field

RetrievalResultSalesforceLocation

The Salesforce data source location.

RetrievalResultSharePointLocation

The SharePoint data source location.

RetrievalResultSqlLocation

Contains information about the SQL query used to retrieve the result.

RetrievalResultWebLocation

The web URL/URLs data source location.

RetrieveAndGenerateConfiguration

Contains details about the resource being queried.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field

RetrieveAndGenerateInput

Contains the query made to the knowledge base.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the input field

RetrieveAndGenerateOutput

Contains the response generated from querying the knowledge base.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the output field

RetrieveAndGenerateOutputEvent

A retrieve and generate output event.

RetrieveAndGenerateSessionConfiguration

Contains configuration about the session with the knowledge base.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the sessionConfiguration field

RetrievedReference

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the retrievedReferences field

• InvokeAgent response – in the retrievedReferences field

ReturnControlPayload

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the following API operations:

• InvokeAgent response

ReturnControlResults

An action invocation result.

RoutingClassifierModelInvocationOutput

Invocation output from a routing classifier model.

S3Identifier

The identifier information for an Amazon S3 bucket.

S3Location

Information about the Amazon S3 bucket where the image is stored.

S3ObjectDoc

The unique wrapper object of the document from the S3 location.

S3ObjectFile

Contains details of the s3 object where the source file is located.

SatisfiedCondition

Represents a condition that was satisfied during a condition node evaluation in a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

SessionState

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.

SessionSummary

Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Span

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the span field

• InvokeAgent response – in the span field

StreamingConfigurations

Configurations for streaming.

TextInferenceConfig

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.

The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.

TextPrompt

Contains information about the text prompt to optimize.

TextResponsePart

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the textResponsePart field

• InvokeAgent response – in the textResponsePart field

TextToSqlConfiguration

Contains configurations for transforming text to SQL.

TextToSqlKnowledgeBaseConfiguration

Contains configurations for a knowledge base to use in transformation.

TracePart

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

TransformationConfiguration

Contains configurations for transforming the natural language query into SQL.

Usage

Contains information of the usage of the foundation model.

VectorSearchBedrockRerankingConfiguration

Contains configurations for reranking with an Amazon Bedrock reranker model.

VectorSearchBedrockRerankingModelConfiguration

Contains configurations for an Amazon Bedrock reranker model.

VectorSearchRerankingConfiguration

Contains configurations for reranking the retrieved results.

Enums

ActionGroupExecutor

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

ActionGroupSignature

When writing a match expression against ActionGroupSignature, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ActionInvocationType

When writing a match expression against ActionInvocationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AgentCollaboration

When writing a match expression against AgentCollaboration, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ApiSchema

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

AttributeType

When writing a match expression against AttributeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

BedrockSessionContentBlock

A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.

For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Caller

Details about a caller.

ConfirmationState

When writing a match expression against ConfirmationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContentBlock

A content block.

ConversationRole

When writing a match expression against ConversationRole, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CreationMode

When writing a match expression against CreationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CustomControlMethod

When writing a match expression against CustomControlMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutionType

When writing a match expression against ExecutionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExternalSourceType

When writing a match expression against ExternalSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FileSourceType

When writing a match expression against FileSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FileUseCase

When writing a match expression against FileUseCase, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowCompletionReason

When writing a match expression against FlowCompletionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowErrorCode

When writing a match expression against FlowErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowExecutionContent

Contains the content of an flow execution input or output field.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowExecutionErrorType

When writing a match expression against FlowExecutionErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowExecutionEvent

Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

FlowExecutionEventType

When writing a match expression against FlowExecutionEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowExecutionStatus

When writing a match expression against FlowExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowInputContent

Contains information about an input into the flow.

FlowMultiTurnInputContent

The content structure containing input information for multi-turn flow interactions.

FlowOutputContent

Contains information about the content in an output from prompt flow invocation.

FlowResponseStream

The output of the flow.

FlowTrace

Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceNodeInputContent

Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FlowTraceNodeOutputContent

Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

FunctionSchema

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

GeneratedQueryType

When writing a match expression against GeneratedQueryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuadrailAction

When writing a match expression against GuadrailAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailAction

When writing a match expression against GuardrailAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailContentFilterConfidence

When writing a match expression against GuardrailContentFilterConfidence, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailContentFilterType

When writing a match expression against GuardrailContentFilterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailContentPolicyAction

When writing a match expression against GuardrailContentPolicyAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailManagedWordType

When writing a match expression against GuardrailManagedWordType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailPiiEntityType

When writing a match expression against GuardrailPiiEntityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailSensitiveInformationPolicyAction

When writing a match expression against GuardrailSensitiveInformationPolicyAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailTopicPolicyAction

When writing a match expression against GuardrailTopicPolicyAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailTopicType

When writing a match expression against GuardrailTopicType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GuardrailWordPolicyAction

When writing a match expression against GuardrailWordPolicyAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImageFormat

When writing a match expression against ImageFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImageInputFormat

When writing a match expression against ImageInputFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImageInputSource

Details about the source of an input image in the result from a function in the action group invocation.

ImageSource

The source for an image.

InlineAgentResponseStream

The response from invoking the agent and associated citations and trace information.

InputPrompt

Contains information about the prompt to optimize.

InputQueryType

When writing a match expression against InputQueryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InvocationInputMember

Contains details about the API operation or function that the agent predicts should be called.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

InvocationResultMember

A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.

This data type is used in the following API operations:

• InvokeAgent request

InvocationStepPayload

Payload content, such as text and images, for the invocation step.

InvocationType

When writing a match expression against InvocationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Memory

Contains sessions summaries.

MemoryType

When writing a match expression against MemoryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NodeErrorCode

When writing a match expression against NodeErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NodeExecutionContent

Contains the content of a flow node's input or output field for a flow execution.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

NodeType

When writing a match expression against NodeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OptimizedPrompt

Contains information about the optimized prompt.

OptimizedPromptStream

The stream containing events in the prompt optimization process.

OrchestrationExecutor

The structure of the executor invoking the actions in custom orchestration.

OrchestrationTrace

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

OrchestrationType

When writing a match expression against OrchestrationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParameterType

When writing a match expression against ParameterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PayloadType

When writing a match expression against PayloadType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PerformanceConfigLatency

When writing a match expression against PerformanceConfigLatency, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PostProcessingTrace

Details about the post-processing step, in which the agent shapes the response.

PreProcessingTrace

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

PromptState

When writing a match expression against PromptState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PromptType

When writing a match expression against PromptType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueryTransformationMode

When writing a match expression against QueryTransformationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueryTransformationType

When writing a match expression against QueryTransformationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ReasoningContentBlock

Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

RelayConversationHistory

When writing a match expression against RelayConversationHistory, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RequireConfirmation

When writing a match expression against RequireConfirmation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RerankDocumentType

When writing a match expression against RerankDocumentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RerankQueryContentType

When writing a match expression against RerankQueryContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RerankSourceType

When writing a match expression against RerankSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RerankingConfigurationType

When writing a match expression against RerankingConfigurationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RerankingMetadataSelectionMode

When writing a match expression against RerankingMetadataSelectionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RerankingMetadataSelectiveModeConfiguration

Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

ResponseState

When writing a match expression against ResponseState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResponseStream

The response from invoking the agent and associated citations and trace information.

RetrievalFilter

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

• Retrieve request – in the filter field

• RetrieveAndGenerate request – in the filter field

RetrievalResultContentColumnType

When writing a match expression against RetrievalResultContentColumnType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RetrievalResultContentType

When writing a match expression against RetrievalResultContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RetrievalResultLocationType

When writing a match expression against RetrievalResultLocationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RetrieveAndGenerateStreamResponseOutput

A retrieve and generate stream response output.

RetrieveAndGenerateType

When writing a match expression against RetrieveAndGenerateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RoutingClassifierTrace

A trace for a routing classifier.

SearchType

When writing a match expression against SearchType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SessionStatus

When writing a match expression against SessionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Source

When writing a match expression against Source, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TextToSqlConfigurationType

When writing a match expression against TextToSqlConfigurationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Trace

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

Type

When writing a match expression against Type, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorSearchRerankingConfigurationType

When writing a match expression against VectorSearchRerankingConfigurationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.