Class: Aws::Bedrock::Types::CreateGuardrailRequest

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) 


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

class CreateGuardrailRequest < Struct.new(
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :cross_region_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id,
  :tags,
  :client_request_token)
  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) 


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#client_request_token ⇒ String

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

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

Returns:

  • (String) 


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#content_policy_config ⇒ Types::GuardrailContentPolicyConfig

The content filter policies to configure for the guardrail.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

class CreateGuardrailRequest < Struct.new(
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :cross_region_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id,
  :tags,
  :client_request_token)
  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 create a guardrail.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#cross_region_config ⇒ Types::GuardrailCrossRegionConfig

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#description ⇒ String

A description of the guardrail.

Returns:

  • (String) 


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#kms_key_id ⇒ String

The ARN of the KMS key that you use to encrypt the guardrail.

Returns:

  • (String) 


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#name ⇒ String

The name to give the guardrail.

Returns:

  • (String) 


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

class CreateGuardrailRequest < Struct.new(
  :name,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :cross_region_config,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :kms_key_id,
  :tags,
  :client_request_token)
  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:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#tags ⇒ Array<Types::Tag>

The tags that you want to attach to the guardrail.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#topic_policy_config ⇒ Types::GuardrailTopicPolicyConfig

The topic policies to configure for the guardrail.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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

#word_policy_config ⇒ Types::GuardrailWordPolicyConfig

The word policy you configure for the guardrail.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 582

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