Class: Aws::BedrockAgentRuntime::Types::ApiResult

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::ApiResult

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagentruntime/types.rb

Overview

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]

^

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:api_path]

Instance Attribute Summary

• #action_group ⇒ String

  The action group that the API operation belongs to.

• #agent_id ⇒ String

  The agent’s ID.

• #api_path ⇒ String

  The path to the API operation.

• #confirmation_state ⇒ String

  Controls the API operations or functions to invoke based on the user confirmation.

• #http_method ⇒ String

  The HTTP method for the API operation.

• #http_status_code ⇒ Integer

  http status code from API execution response (for example: 200, 400, 500).

• #response_body ⇒ Hash<String,Types::ContentBody>

  The response body from the API operation.

• #response_state ⇒ String

  Controls the final response state returned to end user when API/Function execution failed.

Instance Attribute Details

#action_group ⇒ String

The action group that the API operation belongs to.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#agent_id ⇒ String

The agent’s ID.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#api_path ⇒ String

The path to the API operation.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#confirmation_state ⇒ String

Controls the API operations or functions to invoke based on the user confirmation.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#http_method ⇒ String

The HTTP method for the API operation.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#http_status_code ⇒ Integer

http status code from API execution response (for example: 200, 400, 500).

Returns:

• (Integer)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#response_body ⇒ Hash<String,Types::ContentBody>

The response body from the API operation. The key of the object is the content type (currently, only ‘TEXT` is supported). The response may be returned directly or from the Lambda function.

Returns:

• (Hash<String,Types::ContentBody>)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#response_state ⇒ String

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 1203

class ApiResult < Struct.new(
  :action_group,
  :agent_id,
  :api_path,
  :confirmation_state,
  :http_method,
  :http_status_code,
  :response_body,
  :response_state)
  SENSITIVE = [:api_path]
  include Aws::Structure
end