UpdateGuardrailRequest Class | AWS SDK for .NET V3

Container for the parameters to the UpdateGuardrail operation. Updates a guardrail with the values you specify.

Specify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
- Give a name and description so that the guardrail can properly identify the topic.
- Specify DENY in the type field.
- (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
- Specify the category in the type field.
- Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Bedrock.AmazonBedrockRequest
      Amazon.Bedrock.Model.UpdateGuardrailRequest

Namespace: Amazon.Bedrock.Model
Assembly: AWSSDK.Bedrock.dll
Version: 3.x.y.z

Syntax

public class UpdateGuardrailRequest : AmazonBedrockRequest
         IAmazonWebServiceRequest

The UpdateGuardrailRequest type exposes the following members

Constructors

	Name	Description
	UpdateGuardrailRequest()

Properties

Name	Type	Description
AutomatedReasoningPolicyConfig	Amazon.Bedrock.Model.GuardrailAutomatedReasoningPolicyConfig	Gets and sets the property AutomatedReasoningPolicyConfig. Updated configuration for Automated Reasoning policies associated with the guardrail.
BlockedInputMessaging	System.String	Gets and sets the property BlockedInputMessaging. The message to return when the guardrail blocks a prompt.
BlockedOutputsMessaging	System.String	Gets and sets the property BlockedOutputsMessaging. The message to return when the guardrail blocks a model response.
ContentPolicyConfig	Amazon.Bedrock.Model.GuardrailContentPolicyConfig	Gets and sets the property ContentPolicyConfig. The content policy to configure for the guardrail.
ContextualGroundingPolicyConfig	Amazon.Bedrock.Model.GuardrailContextualGroundingPolicyConfig	Gets and sets the property ContextualGroundingPolicyConfig. The contextual grounding policy configuration used to update a guardrail.
CrossRegionConfig	Amazon.Bedrock.Model.GuardrailCrossRegionConfig	Gets and sets the property CrossRegionConfig. 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.
Description	System.String	Gets and sets the property Description. A description of the guardrail.
GuardrailIdentifier	System.String	Gets and sets the property GuardrailIdentifier. The unique identifier of the guardrail. This can be an ID or the ARN.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. The ARN of the KMS key with which to encrypt the guardrail.
Name	System.String	Gets and sets the property Name. A name for the guardrail.
SensitiveInformationPolicyConfig	Amazon.Bedrock.Model.GuardrailSensitiveInformationPolicyConfig	Gets and sets the property SensitiveInformationPolicyConfig. The sensitive information policy to configure for the guardrail.
TopicPolicyConfig	Amazon.Bedrock.Model.GuardrailTopicPolicyConfig	Gets and sets the property TopicPolicyConfig. The topic policy to configure for the guardrail.
WordPolicyConfig	Amazon.Bedrock.Model.GuardrailWordPolicyConfig	Gets and sets the property WordPolicyConfig. The word policy to configure for the guardrail.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5