Class: Aws::Bedrock::Types::UpdateGuardrailRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]

Instance Attribute Summary collapse

Instance Attribute Details

#blocked_input_messaging ⇒ String

The message to return when the guardrail blocks a prompt.

Returns:

  • (String) 


5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#blocked_outputs_messaging ⇒ String

The message to return when the guardrail blocks a model response.

Returns:

  • (String) 


5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#content_policy_config ⇒ Types::GuardrailContentPolicyConfig

The content policy to configure for the guardrail.

Returns:



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#contextual_grounding_policy_config ⇒ Types::GuardrailContextualGroundingPolicyConfig

The contextual grounding policy configuration used to update a guardrail.

Returns:



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#description ⇒ String

A description of the guardrail.

Returns:

  • (String) 


5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#guardrail_identifier ⇒ String

The unique identifier of the guardrail. This can be an ID or the ARN.

Returns:

  • (String) 


5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#kms_key_id ⇒ String

The ARN of the KMS key with which to encrypt the guardrail.

Returns:

  • (String) 


5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#name ⇒ String

A name for the guardrail.

Returns:

  • (String) 


5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#sensitive_information_policy_config ⇒ Types::GuardrailSensitiveInformationPolicyConfig

The sensitive information policy to configure for the guardrail.

Returns:



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#topic_policy_config ⇒ Types::GuardrailTopicPolicyConfig

The topic policy to configure for the guardrail.

Returns:



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end

#word_policy_config ⇒ Types::GuardrailWordPolicyConfig

The word policy to configure for the guardrail.

Returns:



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5217

class UpdateGuardrailRequest < Struct.new(
  :guardrail_identifier,
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id)
  SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
  include Aws::Structure
end