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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::ApiInvocationInput

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:

• In the returnControl field of the InvokeAgent response

^

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:api_path, :collaborator_name]

Instance Attribute Summary

• #action_group ⇒ String

  The action group that the API operation belongs to.

• #action_invocation_type ⇒ String

  Contains information about the API operation to invoke.

• #agent_id ⇒ String

  The agent's ID.

• #api_path ⇒ String

  The path to the API operation.

• #collaborator_name ⇒ String

  The agent collaborator's name.

• #http_method ⇒ String

  The HTTP method of the API operation.

• #parameters ⇒ Array<Types::ApiParameter>

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

• #request_body ⇒ Types::ApiRequestBody

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

Instance Attribute Details

#action_group ⇒ String

The action group that the API operation belongs to.

Returns:

• (String)

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

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

#action_invocation_type ⇒ String

Contains information about the API operation to invoke.

Returns:

• (String)

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

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

#agent_id ⇒ String

The agent's ID.

Returns:

• (String)

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

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

#api_path ⇒ String

The path to the API operation.

Returns:

• (String)

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

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

#collaborator_name ⇒ String

The agent collaborator's name.

Returns:

• (String)

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

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

#http_method ⇒ String

The HTTP method of the API operation.

Returns:

• (String)

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

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

#parameters ⇒ Array<Types::ApiParameter>

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

Returns:

• (Array<Types::ApiParameter>)

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

class ApiInvocationInput < Struct.new(
  :action_group,
  :action_invocation_type,
  :agent_id,
  :api_path,
  :collaborator_name,
  :http_method,
  :parameters,
  :request_body)
  SENSITIVE = [:api_path, :collaborator_name]
  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:

• (Types::ApiRequestBody)

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

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