Contact Us 1-800-596-4880
  1. Homepage
  2. Amazon Bedrock Connector (1.1)

  3. Amazon Bedrock Connector Reference

All Connectors

Amazon Bedrock Connector 1.1 Reference

Configurations

Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Session Token

String

The session token provided by Amazon STS.

Connection Timeout

Number

The amount of time to wait when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit used in the connection timeout configurations.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

50

Socket Timeout

Number

The amount of time to wait for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit used in the socket timeout configurations.

SECONDS

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Region Endpoint

String

Sets the topic region endpoint.

us-east-1

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See Using credentials providers in the AWS SDK for Java 2.x.

false

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

TLS Configuration

Tls

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.
Role
Parameters
Name Type Description Default Value Required

Role ARN

String

The Role ARN uniquely identifies the role to assume to gain cross-account access.

x

Custom STS Endpoint

String

Sets a custom STS endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

External ID

String

A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provides an external ID, then provide that value in this field.

Connection Timeout

Number

The amount of time to wait when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit used in the connection timeout configurations.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

50

Socket Timeout

Number

The amount of time to wait for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit used in the socket timeout configurations.

SECONDS

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Region Endpoint

String

Sets the topic region endpoint.

us-east-1

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See Using credentials providers in the AWS SDK for Java 2.x.

false

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

TLS Configuration

Tls

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Supported Operations

Operations

AGENT Chat

<ms-bedrock:agent-chat>

Sends a chat message to a Bedrock agent and receives a response. The agent can use knowledge bases and action groups to provide intelligent responses.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Agent Id

String

The unique identifier of the agent to chat with.

x

Agent Alias Id

String

The alias ID of the agent version to use.

x

Prompt

String

The user’s message or prompt to send to the agent.

x

Enable Trace

Boolean

Whether to enable trace logging for debugging agent reasoning.

false

Latency Optimized

Boolean

Whether to optimize for lower latency at the cost of some functionality.

false

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Session Id

String

The unique identifier of the session to maintain conversation context.

Exclude Previous Thinking Steps

Boolean

Whether to exclude previous thinking steps from the conversation history.

false

Previous Conversation Turns To Include

Number

The number of previous conversation turns to include for context.

Session Attributes

Object

Key-value pairs that persist across the entire agent session. Each value supports DataWeave expressions. Blank keys and blank values are filtered before the request is built.

Prompt Session Attributes

Object

Key-value pairs that apply only to the current prompt and turn. Each value supports DataWeave expressions. Blank keys and blank values are filtered before the request is built.

Knowledge Base Id

String

The unique identifier of the knowledge base to query.

Number Of Results

Number

The number of results to return from the query.

Override Search Type

Enumeration, one of:

  • HYBRID

  • SEMANTIC

The search type to use for retrieval.

Retrieval Metadata Filter Type

Enumeration, one of:

  • AND_ALL

  • OR_ALL

The filter type to apply to retrieval metadata.

Metadata Filters

Object

The metadata filters to apply to the retrieval query.

Knowledge Bases

Array of Knowledge Base Config

The knowledge base configurations to use for retrieval.

Request Timeout

Number

Request timeout (overrides connector-level timeout if provided).

Request Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Unit of time for the request timeout.

Enable Retry

Boolean

Enable retry for streaming operations on timeout failures.

false

Max Retries

Number

Maximum number of retry attempts (0 = no retries).

3

Retry Backoff Ms

Number

Base backoff delay in milliseconds for exponential backoff.

1000

Request Id

String

Request ID mapped from REQUEST-ID header to include in session-start event.

Correlation Id

String

Correlation ID mapped from CORRELATION-ID header to include in session-start event.

User Id

String

User ID mapped from USER-ID header to include in session-start event.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AGENT Chat Streaming (SSE)

<ms-bedrock:agent-chat-streaming-sse>

Sends a chat message to a Bedrock agent and receives a streaming response using Server-Sent Events (SSE). Returns responses in real-time as the agent generates them.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Agent Id

String

The unique identifier of the agent to chat with.

x

Agent Alias Id

String

The alias ID of the agent version to use.

x

Prompt

String

The user’s message or prompt to send to the agent.

x

Enable Trace

Boolean

Whether to enable trace logging for debugging agent reasoning.

false

Latency Optimized

Boolean

Whether to optimize for lower latency at the cost of some functionality.

false

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Session Id

String

The unique identifier of the session to maintain conversation context.

Exclude Previous Thinking Steps

Boolean

Whether to exclude previous thinking steps from the conversation history.

false

Previous Conversation Turns To Include

Number

The number of previous conversation turns to include for context.

Session Attributes

Object

Key-value pairs that persist across the entire agent session. Each value supports DataWeave expressions. Blank keys and blank values are filtered before the request is built.

Prompt Session Attributes

Object

Key-value pairs that apply only to the current prompt and turn. Each value supports DataWeave expressions. Blank keys and blank values are filtered before the request is built.

Knowledge Base Id

String

The unique identifier of the knowledge base to query.

Number Of Results

Number

The number of results to return from the query.

Override Search Type

Enumeration, one of:

  • HYBRID

  • SEMANTIC

The search type to use for retrieval.

Retrieval Metadata Filter Type

Enumeration, one of:

  • AND_ALL

  • OR_ALL

The filter type to apply to retrieval metadata.

Metadata Filters

Object

The metadata filters to apply to the retrieval query.

Knowledge Bases

Array of Knowledge Base Config

The knowledge base configurations to use for retrieval.

Request Timeout

Number

Request timeout (overrides connector-level timeout if provided).

Request Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Unit of time for the request timeout.

Enable Retry

Boolean

Enable retry for streaming operations on timeout failures.

false

Max Retries

Number

Maximum number of retry attempts (0 = no retries).

3

Retry Backoff Ms

Number

Base backoff delay in milliseconds for exponential backoff.

1000

Request Id

String

Request ID mapped from REQUEST-ID header to include in session-start event.

Correlation Id

String

Correlation ID mapped from CORRELATION-ID header to include in session-start event.

User Id

String

User ID mapped from USER-ID header to include in session-start event.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AGENT Define Prompt Template

<ms-bedrock:agent-define-prompt-template>

Defines a prompt template with instructions and dataset for use in agent operations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Template

String

The prompt template string with placeholders for instructions and dataset.

x

Instructions

String

Instructions to be inserted into the template.

x

Dataset

String

Dataset to be inserted into the template.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the foundation model to use.

amazon.nova-lite-v1:0

Temperature

Number

A value between 0 and 1 that regulates the creativity of LLMs' responses. Use lower temperature if you want more deterministic responses, and use higher temperature if you want more creative or different responses for the same prompt from LLMs on Amazon Bedrock.

0.7

Top P

Number

The percentage of most-likely candidates that the model considers for the next token. It typically ranges between 0.9 and 0.95. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Top K

Number

The number of most-likely candidates that the model considers for the next token. It typically ranges between 0.4 and 0.6. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Max Token Count

Number

The maximum number of tokens to consume during output generation. For consistent and predictable responses, it is recommended to explicitly configure maxTokens based on the model’s supported limits and expected output size.

Guardrail Identifier

String

The unique identifier of the guardrail to apply.

Guardrail Version

String

The version of the guardrail to use.

1

Aws Account Id

String

The AWS account ID for cross-account access.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AGENT Get By Id

<ms-bedrock:agent-get-by-id>

Retrieves details of a Bedrock agent by its unique identifier.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Agent Id

String

The unique identifier of the agent to retrieve.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AGENT List

<ms-bedrock:agent-list>

Lists all Bedrock agents available in the AWS account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Batch Create Memory Records

<ms-bedrock:agentcore-batch-create-memory-records>

Creates multiple memory records in a Bedrock AgentCore memory resource in a single batch operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Memory Id

String

The unique identifier of the memory resource.

x

Create Records

Array of Memory Record Create Input Parameters

The memory records to create.

x

Client Token

String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Batch Delete Memory Records

<ms-bedrock:agentcore-batch-delete-memory-records>

Deletes multiple memory records from a Bedrock AgentCore memory resource in a single batch operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Memory Id

String

The unique identifier of the memory resource.

x

Delete Records

Array of Memory Record Delete Input Parameters

The memory records to delete.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Batch Update Memory Records

<ms-bedrock:agentcore-batch-update-memory-records>

Updates multiple memory records in a Bedrock AgentCore memory resource in a single batch operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Memory Id

String

The unique identifier of the memory resource.

x

Update Records

Array of Memory Record Update Input Parameters

The memory records to update.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Get Memory Record

<ms-bedrock:agentcore-get-memory-record>

Retrieves a specific memory record from a Bedrock AgentCore memory resource.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Memory Id

String

The unique identifier of the memory resource.

x

Memory Record Id

String

The unique identifier of the memory record to retrieve.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Get Resource API Key

<ms-bedrock:agentcore-get-resource-api-key>

Retrieves an API key for a resource credential provider using a workload identity token.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Resource Credential Provider Name

String

The name of the resource credential provider.

x

Workload Identity Token

String

The workload identity token used to authenticate the request.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Get Workload Access Token

<ms-bedrock:agentcore-get-workload-access-token>

Retrieves a workload access token for a Bedrock AgentCore workload identity.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workload Name

String

The name of the workload identity.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Invoke Agent Runtime (Streaming)

<ms-bedrock:agentcore-invoke-agent-runtime>

Invokes a Bedrock AgentCore runtime and returns the response as a stream.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Agent Runtime Arn

String

The Amazon Resource Name (ARN) of the agent runtime to invoke.

x

Runtime Session Id

String

The unique identifier of the runtime session.

x

Payload

String

The input payload to send to the agent runtime.

x

Qualifier

String

Optional runtime qualifier such as a version alias; defaults to the DEFAULT endpoint when unset.

Content Type

String

The content type of the request payload.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Invoke Agent Runtime Attributes

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Invoke Agent Runtime As Bytes (Non Streaming)

<ms-bedrock:agentcore-invoke-agent-runtime-as-bytes>

Invokes a Bedrock AgentCore runtime and returns the complete response as bytes.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Agent Runtime Arn

String

The Amazon Resource Name (ARN) of the agent runtime to invoke.

x

Runtime Session Id

String

The unique identifier of the runtime session.

x

Payload

String

The input payload to send to the agent runtime.

x

Qualifier

String

Optional runtime qualifier such as a version alias; defaults to the DEFAULT endpoint when unset.

Content Type

String

The content type of the request payload.

Accept

String

The content type that the client expects in the response.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Invoke Agent Runtime Attributes

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - List Memory Records

<ms-bedrock:agentcore-list-memory-records>

Lists memory records in a Bedrock AgentCore memory resource, optionally filtered by namespace or metadata.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Memory Id

String

The unique identifier of the memory resource.

x

Namespace

String

The namespace prefix to filter memory records by. Either Namespace or Namespace Path is required.

Namespace Path

String

The namespace path for hierarchical retrievals. Either Namespace or Namespace Path is required.

Memory Strategy Id

String

The unique identifier of the memory strategy to filter by.

Max Results

Number

The maximum number of results to return.

Next Token

String

The pagination token used to retrieve the next page of results.

Memory Metadata Filters

Array of Memory Metadata Filter Expression Parameters

The metadata filters to apply to the memory records.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Retrieve Memory Records

<ms-bedrock:agentcore-retrieve-memory-records>

Searches and retrieves memory records from a Bedrock AgentCore memory resource based on search criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Memory Id

String

The unique identifier of the memory resource.

x

Search Criteria

Search Criteria Parameters

The criteria used to search for memory records.

x

Namespace

String

The namespace to search within. Either Namespace or Namespace Path is required.

Namespace Path

String

The namespace path for hierarchical retrievals. Either Namespace or Namespace Path is required.

Max Results

Number

The maximum number of results to return.

Next Token

String

The pagination token used to retrieve the next page of results.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

AgentCore - Stop Runtime Session

<ms-bedrock:agentcore-stop-runtime-session>

Stops an active Bedrock AgentCore runtime session.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Agent Runtime Arn

String

The Amazon Resource Name (ARN) of the agent runtime.

x

Runtime Session Id

String

The unique identifier of the runtime session to stop.

x

Qualifier

String

Optional runtime qualifier such as a version alias; defaults to the DEFAULT endpoint when unset.

Idempotency Token

String

An opaque de-duplication identifier the AWS SDK uses to safely retry the request; the SDK auto-generates one when unset. This is not an authentication token.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Stop Runtime Session Attributes

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

CHAT Answer Prompt

<ms-bedrock:chat-answer-prompt>

Generates a text response from a prompt using the specified Bedrock foundation model.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Prompt

String

The text prompt to send to the model.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the foundation model to use.

amazon.nova-lite-v1:0

Temperature

Number

A value between 0 and 1 that regulates the creativity of LLMs' responses. Use lower temperature if you want more deterministic responses, and use higher temperature if you want more creative or different responses for the same prompt from LLMs on Amazon Bedrock.

0.7

Top P

Number

The percentage of most-likely candidates that the model considers for the next token. It typically ranges between 0.9 and 0.95. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Top K

Number

The number of most-likely candidates that the model considers for the next token. It typically ranges between 0.4 and 0.6. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Max Token Count

Number

The maximum number of tokens to consume during output generation. For consistent and predictable responses, it is recommended to explicitly configure maxTokens based on the model’s supported limits and expected output size.

Guardrail Identifier

String

The unique identifier of the guardrail to apply.

Guardrail Version

String

The version of the guardrail to use.

1

Aws Account Id

String

The AWS account ID for cross-account access.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

CHAT Answer Prompt Streaming

<ms-bedrock:chat-answer-prompt-streaming>

Generates a streaming text response from a prompt using Server-Sent Events (SSE). Returns responses in real-time as they are generated.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Prompt

String

The text prompt to send to the model.

x

Model Arn

String

The optional ARN of a base model, inference profile, or application inference profile. If you set this field, the connector uses this ARN and ignores Model Name.

Attachments

Array of Converse Attachment

Optional images or documents to include with the prompt.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the foundation model to use.

amazon.nova-lite-v1:0

Temperature

Number

A value between 0 and 1 that regulates the creativity of LLMs' responses. Use lower temperature if you want more deterministic responses, and use higher temperature if you want more creative or different responses for the same prompt from LLMs on Amazon Bedrock.

0.7

Top P

Number

The percentage of most-likely candidates that the model considers for the next token. It typically ranges between 0.9 and 0.95. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Top K

Number

The number of most-likely candidates that the model considers for the next token. It typically ranges between 0.4 and 0.6. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Max Token Count

Number

The maximum number of tokens to consume during output generation. For consistent and predictable responses, it is recommended to explicitly configure maxTokens based on the model’s supported limits and expected output size.

Guardrail Identifier

String

The unique identifier of the guardrail to apply.

Guardrail Version

String

The version of the guardrail to use.

1

Aws Account Id

String

The AWS account ID for cross-account access.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

EMBEDDING Adhoc Query

<ms-bedrock:embedding-adhoc-query>

Performs Retrieval Augmented Generation (RAG) by converting the query and documents into embeddings, comparing them for similarity, and ranking the most relevant document chunks to ground the response with respect to the query.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Prompt

String

The query text to search for in the document.

x

File Path

String

Optional file system path to a document file on the Mule runtime host to embed. Used when Document Bytes is not set. Do not bind this field directly to untrusted end-user input.

Document Bytes

String

Optional base64-encoded document content to embed. Takes precedence over File Path when both are set.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the embedding model to use.

amazon.titan-embed-text-v1

Dimension

Number

The dimensionality of the embedding vectors.

1024

Normalize

Boolean

Whether to normalize the embedding vectors.

true

Option Type

String

The type of embedding output to generate.

FULL

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

EMBEDDING Generate From Text

<ms-bedrock:embedding-generate-from-text>

Generates vector embeddings from text using Amazon Bedrock embedding models. Embeddings are numerical representations of text that capture semantic meaning.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Prompt

String

The text to generate embeddings for.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the embedding model to use.

amazon.titan-embed-text-v1

Dimension

Number

The dimensionality of the embedding vectors.

1024

Normalize

Boolean

Whether to normalize the embedding vectors.

true

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

FOUNDATIONAL Model Details

<ms-bedrock:foundational-model-details>

Retrieves detailed information about a specific foundation model available in Amazon Bedrock.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the foundation model to use.

amazon.titan-text-express-v1

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

FOUNDATIONAL Models List

<ms-bedrock:foundational-models-list>

Lists all foundation models available in Amazon Bedrock for the specified region.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

IMAGE Generate

<ms-bedrock:image-generate>

Generates an image from a text prompt using Amazon Bedrock image generation models (e.g., Stable Diffusion, Amazon Titan Image).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Text To Image

String

The text prompt describing the image to generate.

x

Avoid In Image

String

Text describing what should be avoided in the generated image (negative prompt).

x

Full Path Output

String

The full file path where the generated image is saved.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the image generation model to use.

amazon.titan-image-generator-v1:0

Num Of Images

Number

The number of images to generate.

1

Height

Number

The height of the generated image in pixels.

512

Width

Number

The width of the generated image in pixels.

512

Cfg Scale

Number

The classifier-free guidance scale. Higher values increase adherence to the prompt.

8.0

Seed

Number

The random seed for reproducible image generation.

0

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

SENTIMENT Analyze

<ms-bedrock:sentiment-analyze>

Analyzes the sentiment of the input text using Amazon Bedrock sentiment analysis models. Determines whether the text expresses positive, negative, or neutral sentiment.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Text To Analyze

String

The text to analyze for sentiment.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model Name

String

The name of the foundation model to use.

amazon.nova-lite-v1:0

Temperature

Number

A value between 0 and 1 that regulates the creativity of LLMs' responses. Use lower temperature if you want more deterministic responses, and use higher temperature if you want more creative or different responses for the same prompt from LLMs on Amazon Bedrock.

0.7

Top P

Number

The percentage of most-likely candidates that the model considers for the next token. It typically ranges between 0.9 and 0.95. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Top K

Number

The number of most-likely candidates that the model considers for the next token. It typically ranges between 0.4 and 0.6. Refer to the model provider documentation to confirm whether this parameter is supported and to verify the appropriate acceptable range.

Max Token Count

Number

The maximum number of tokens to consume during output generation. For consistent and predictable responses, it is recommended to explicitly configure maxTokens based on the model’s supported limits and expected output size.

Guardrail Identifier

String

The unique identifier of the guardrail to apply.

Guardrail Version

String

The version of the guardrail to use.

1

Aws Account Id

String

The AWS account ID for cross-account access.

Target Variable

String

The name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-BEDROCK:ACCESS_DENIED

  • MS-BEDROCK:AWS_SDK_ERROR

  • MS-BEDROCK:BEDROCK_ERROR

  • MS-BEDROCK:CLIENT_ERROR

  • MS-BEDROCK:CONNECTIVITY

  • MS-BEDROCK:RESOURCE_NOT_FOUND

  • MS-BEDROCK:RETRY_EXHAUSTED

  • MS-BEDROCK:SERVICE_ERROR

  • MS-BEDROCK:THROTTLING_ERROR

  • MS-BEDROCK:VALIDATION_ERROR

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

The trust store configuration.

Key Store

Key Store

The key store configuration.

Revocation Check

The revocation check configuration.

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which In Memory Size is expressed.

Knowledge Base Config

Field Type Description Default Value Required

Knowledge Base Id

String

The unique identifier of the knowledge base.

Number Of Results

Number

The number of results to return from the query.

Override Search Type

Enumeration, one of:

  • HYBRID

  • SEMANTIC

The search type to use for retrieval.

Retrieval Metadata Filter Type

Enumeration, one of:

  • AND_ALL

  • OR_ALL

The filter type to apply to retrieval metadata.

Metadata Filters

Object

The metadata filters to apply to the retrieval query.

Reranking Configuration

Reranking Configuration

The reranking configuration for the knowledge base.

Reranking Configuration

Field Type Description Default Value Required

Reranking Type

String

The type of reranking to use.

Model Arn

String

The ARN of the model to use for reranking.

Number Of Reranked Results

Number

The number of reranked results to return.

Selection Mode

Enumeration, one of:

  • SELECTIVE

  • ALL

The selection mode for reranking.

Fields To Exclude

Array of String

The fields to exclude from reranking.

Fields To Include

Array of String

The fields to include in reranking.

Additional Model Request Fields

Object

Additional fields to include in the model request.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

The error type from the source.

Target

String

The target error type.

x

Memory Record Create Input Parameters

Field Type Description Default Value Required

Content

Memory Content Parameters

The content of the memory record.

x

Namespaces

Array of String

The namespaces associated with the memory record.

x

Timestamp

String

The timestamp of the memory record.

x

Memory Strategy Id

String

The unique identifier of the memory strategy.

Request Identifier

String

A unique identifier for the create request.

x

Metadata

Object

Additional metadata associated with the memory record.

Memory Content Parameters

Field Type Description Default Value Required

Text

String

The text content of the memory record.

Memory Record Delete Input Parameters

Field Type Description Default Value Required

Memory Record Id

String

The unique identifier of the memory record to delete.

x

Memory Record Update Input Parameters

Field Type Description Default Value Required

Memory Record Id

String

The unique identifier of the memory record to update.

x

Content

Memory Content Parameters

The updated content of the memory record.

Namespaces

Array of String

The updated namespaces associated with the memory record.

Timestamp

String

The timestamp of the memory record.

x

Memory Strategy Id

String

The unique identifier of the memory strategy.

Metadata

Object

Additional metadata associated with the memory record.

Invoke Agent Runtime Attributes

Field Type Description Default Value Required

Baggage

String

The baggage header propagated with the request.

Content Type

String

The content type of the response.

Mcp Protocol Version

String

The Model Context Protocol (MCP) version used.

Mcp Session Id

String

The MCP session identifier.

Runtime Session Id

String

The unique identifier of the runtime session.

Status Code

Number

HTTP status code of the response.

Trace Id

String

The trace identifier used for distributed tracing.

Trace Parent

String

The W3C trace context traceparent header.

Trace State

String

The W3C trace context tracestate header.

Memory Metadata Filter Expression Parameters

Field Type Description Default Value Required

Left

Left Expression

The left-hand side of the filter expression.

Operator

Enumeration, one of:

  • EQUALS_TO

  • EXISTS

  • NOT_EXISTS

  • BEFORE

  • AFTER

  • CONTAINS

  • GREATER_THAN

  • GREATER_THAN_OR_EQUALS

  • LESS_THAN

  • LESS_THAN_OR_EQUALS

The comparison operator to apply between the left and right expressions.

Right

Right Expression

The right-hand side of the filter expression.

Left Expression

Field Type Description Default Value Required

Metadata Key

String

The metadata key to filter by.

Right Expression

Field Type Description Default Value Required

Metadata Value

Memory Metadata Value Parameters

The metadata value to compare against.

Memory Metadata Value Parameters

Field Type Description Default Value Required

String Value

String

The string value to compare.

String List Value

Array of String

The list of string values to compare.

Number Value

Number

The numeric value to compare.

Date Time Value

String

The date-time value to compare.

Search Criteria Parameters

Field Type Description Default Value Required

Search Query

String

The query text used to search for memory records.

x

Memory Strategy Id

String

The unique identifier of the memory strategy.

Top K

Number

The number of top matching results to return.

Memory Metadata Filters

Array of Memory Metadata Filter Expression Parameters

The metadata filters to apply to the search.

Stop Runtime Session Attributes

Field Type Description Default Value Required

Runtime Session Id

String

The unique identifier of the runtime session.

Status Code

Number

HTTP status code of the response.

Converse Attachment

Field Type Description Default Value Required

Path

String

The file system path of the attachment.

Bytes

String

The content of the attachment.

Name

String

The name of the attachment.

Format

Enumeration, one of:

  • png

  • jpeg

  • gif

  • webp

  • pdf

  • csv

  • doc

  • docx

  • html

  • txt

  • md

  • xls

  • xlsx

The file format of the attachment.

x
Back to top