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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/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:

^

See Also:

Constant Summary collapse

SENSITIVE = 
[:api_path]

Instance Attribute Summary collapse

Instance Attribute Details

#action_group ⇒ String

The action group that the API operation belongs to.

Returns:

  • (String) 


423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

class ApiResult < Struct.new(
  :action_group,
  :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) 


423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

class ApiResult < Struct.new(
  :action_group,
  :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) 


423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

class ApiResult < Struct.new(
  :action_group,
  :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) 


423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

class ApiResult < Struct.new(
  :action_group,
  :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) 


423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

class ApiResult < Struct.new(
  :action_group,
  :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:



423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

class ApiResult < Struct.new(
  :action_group,
  :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) 


423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 423

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