Class: Aws::BedrockAgentRuntime::Types::ApiInvocationInput

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 the agent predicts should be called.

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) 


146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 146

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :api_path,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#action_invocation_type ⇒ String

Contains information about the API operation to invoke.

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 146

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :api_path,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#api_path ⇒ String

The path to the API operation.

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 146

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :api_path,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#http_method ⇒ String

The HTTP method of the API operation.

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 146

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :api_path,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#parameters ⇒ Array<Types::ApiParameter>

The parameters to provide for the API request, as the agent elicited from the user.

Returns:



146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 146

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :api_path,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path]
  include Aws::Structure
end

#request_body ⇒ Types::ApiRequestBody

The request body to provide for the API request, as the agent elicited from the user.

Returns:



146
147
148
149
150
151
152
153
154
155
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 146

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :api_path,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path]
  include Aws::Structure
end