Class: Aws::BedrockAgentCoreControl::Types::CreateOnlineEvaluationConfigRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::CreateOnlineEvaluationConfigRequest

Defined in:

gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #client_token ⇒ String

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

• #data_source_config ⇒ Types::DataSourceConfig

  The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

• #description ⇒ String

  The description of the online evaluation configuration that explains its monitoring purpose and scope.

• #enable_on_create ⇒ Boolean

  Whether to enable the online evaluation configuration immediately upon creation.

• #evaluation_execution_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation.

• #evaluators ⇒ Array<Types::EvaluatorReference>

  The list of evaluators to apply during online evaluation.

• #online_evaluation_config_name ⇒ String

  The name of the online evaluation configuration.

• #rule ⇒ Types::Rule

  The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

• #tags ⇒ Hash<String,String>

  A map of tag keys and values to assign to an AgentCore Online Evaluation Config.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't 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)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#data_source_config ⇒ Types::DataSourceConfig

The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

Returns:

• (Types::DataSourceConfig)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the online evaluation configuration that explains its monitoring purpose and scope.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#enable_on_create ⇒ Boolean

Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

Returns:

• (Boolean)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#evaluation_execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#evaluators ⇒ Array<Types::EvaluatorReference>

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

Returns:

• (Array<Types::EvaluatorReference>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#online_evaluation_config_name ⇒ String

The name of the online evaluation configuration. Must be unique within your account.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#rule ⇒ Types::Rule

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

Returns:

• (Types::Rule)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2951

class CreateOnlineEvaluationConfigRequest < Struct.new(
  :client_token,
  :online_evaluation_config_name,
  :description,
  :rule,
  :data_source_config,
  :evaluators,
  :evaluation_execution_role_arn,
  :enable_on_create,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end