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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::CreateAgentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:instruction, :prompt_override_configuration]

Instance Attribute Summary

• #agent_name ⇒ String

  A name for the agent that you create.

• #agent_resource_role_arn ⇒ String

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

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #customer_encryption_key_arn ⇒ String

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

• #description ⇒ String

  A description of the agent.

• #foundation_model ⇒ String

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

• #guardrail_configuration ⇒ Types::GuardrailConfiguration

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

• #idle_session_ttl_in_seconds ⇒ Integer

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

• #instruction ⇒ String

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

• #prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

  Contains configurations to override prompts in different parts of an agent sequence.

• #tags ⇒ Hash<String,String>

  Any tags that you want to attach to the agent.

Instance Attribute Details

#agent_name ⇒ String

A name for the agent that you create.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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:

• (Types::GuardrailConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html

Returns:

• (Types::PromptOverrideConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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>)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 1211

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