Package software.amazon.awssdk.services.bedrockagentcore.model

Class InvokeAgentRuntimeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.InvokeAgentRuntimeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeAgentRuntimeRequest.Builder,InvokeAgentRuntimeRequest>
@Generated("software.amazon.awssdk:codegen") public final class InvokeAgentRuntimeRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<InvokeAgentRuntimeRequest.Builder,InvokeAgentRuntimeRequest>

  • Method Details

    • contentType

      public final String contentType()

      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:
      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.

    • accept

      public final String accept()

      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:
      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.

    • mcpSessionId

      public final String mcpSessionId()

      The identifier of the MCP session.

      Returns:
      The identifier of the MCP session.

    • runtimeSessionId

      public final String runtimeSessionId()

      The identifier of the runtime session.

      Returns:
      The identifier of the runtime session.

    • mcpProtocolVersion

      public final String mcpProtocolVersion()

      The version of the MCP protocol being used.

      Returns:
      The version of the MCP protocol being used.

    • runtimeUserId

      public final String runtimeUserId()

      The identifier of the runtime user.

      Returns:
      The identifier of the runtime user.

    • traceId

      public final String traceId()

      The trace identifier for request tracking.

      Returns:
      The trace identifier for request tracking.

    • traceParent

      public final String traceParent()

      The parent trace information for distributed tracing.

      Returns:
      The parent trace information for distributed tracing.

    • traceState

      public final String traceState()

      The trace state information for distributed tracing.

      Returns:
      The trace state information for distributed tracing.

    • baggage

      public final String baggage()

      Additional context information for distributed tracing.

      Returns:
      Additional context information for distributed tracing.

    • agentRuntimeArn

      public final String agentRuntimeArn()

      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:
      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.

    • qualifier

      public final String qualifier()

      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:
      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.

    • accountId

      public final String accountId()

      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:
      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.

    • payload

      public final SdkBytes payload()

      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:
      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.

    • toBuilder

      public InvokeAgentRuntimeRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<InvokeAgentRuntimeRequest.Builder,InvokeAgentRuntimeRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static InvokeAgentRuntimeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InvokeAgentRuntimeRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo