Class: Aws::BedrockAgent::Types::CreateAgentRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockagent/types.rb

Overview

Create Agent Request

See Also:

Constant Summary collapse

SENSITIVE = 
[:instruction, :prompt_override_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_name ⇒ String

Name for a resource.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_resource_role_arn ⇒ String

ARN of a IAM role.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#client_token ⇒ String

Client specified token used for idempotency checks

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

A KMS key ARN

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#description ⇒ String

Description of the Resource.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#foundation_model ⇒ String

ARN or name of a Bedrock model.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

Max Session Time.

Returns:

  • (Integer) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#instruction ⇒ String

Instruction for the agent.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

Configuration for prompt override.

Returns:



926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of tag keys and values

Returns:

  • (Hash<String,String>) 


926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 926

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end