Class: Aws::BedrockAgentCore::Types::InvokeAgentRuntimeRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::InvokeAgentRuntimeRequest

Defined in:

gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:payload]

Instance Attribute Summary

• #accept ⇒ String

  The desired MIME type for the response from the agent runtime.

• #account_id ⇒ String

  The identifier of the Amazon Web Services account for the agent runtime resource.

• #agent_runtime_arn ⇒ String

  The identifier of the agent runtime to invoke.

• #baggage ⇒ String

  Additional context information for distributed tracing.

• #content_type ⇒ String

  The MIME type of the input data in the payload.

• #mcp_protocol_version ⇒ String

  The version of the MCP protocol being used.

• #mcp_session_id ⇒ String

  The identifier of the MCP session.

• #payload ⇒ String

  The input data to send to the agent runtime.

• #qualifier ⇒ String

  The qualifier to use for the agent runtime.

• #runtime_session_id ⇒ String

  The identifier of the runtime session.

• #runtime_user_id ⇒ String

  The identifier of the runtime user.

• #trace_id ⇒ String

  The trace identifier for request tracking.

• #trace_parent ⇒ String

  The parent trace information for distributed tracing.

• #trace_state ⇒ String

  The trace state information for distributed tracing.

Instance Attribute Details

#accept ⇒ String

The desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#account_id ⇒ String

The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#agent_runtime_arn ⇒ String

The identifier of the agent runtime to invoke. You can specify either the full Amazon Web Services Resource Name (ARN) or the agent ID. If you use the agent ID, you must also provide the accountId query parameter.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#baggage ⇒ String

Additional context information for distributed tracing.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#content_type ⇒ String

The MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#mcp_protocol_version ⇒ String

The version of the MCP protocol being used.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#mcp_session_id ⇒ String

The identifier of the MCP session.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#payload ⇒ String

The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#qualifier ⇒ String

The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#runtime_session_id ⇒ String

The identifier of the runtime session.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#runtime_user_id ⇒ String

The identifier of the runtime user.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#trace_id ⇒ String

The trace identifier for request tracking.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#trace_parent ⇒ String

The parent trace information for distributed tracing.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#trace_state ⇒ String

The trace state information for distributed tracing.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2473

class InvokeAgentRuntimeRequest < Struct.new(
  :content_type,
  :accept,
  :mcp_session_id,
  :runtime_session_id,
  :mcp_protocol_version,
  :runtime_user_id,
  :trace_id,
  :trace_parent,
  :trace_state,
  :baggage,
  :agent_runtime_arn,
  :qualifier,
  :account_id,
  :payload)
  SENSITIVE = [:payload]
  include Aws::Structure
end