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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:instruction, :prompt_override_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_name ⇒ String

A name for the agent that you create.

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#agent_resource_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#description ⇒ String

A description of the agent.

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#foundation_model ⇒ String

The foundation model to be used for orchestration by the agent you create.

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#guardrail_configuration ⇒ Types::GuardrailConfiguration

The unique Guardrail configuration assigned to the agent when it is created.

Returns:



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#idle_session_ttl_in_seconds ⇒ Integer

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Returns:

  • (Integer) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#instruction ⇒ String

Instructions that tell the agent what it should do and how it should interact with users.

Returns:

  • (String) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Returns:



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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

#tags ⇒ Hash<String,String>

Any tags that you want to attach to the agent.

Returns:

  • (Hash<String,String>) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1226

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