AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Bedrock UpdateGuardrail API operation.

Syntax

Update-BDRGuardrail
-GuardrailIdentifier <String>
-BlockedInputMessaging <String>
-BlockedOutputsMessaging <String>
-AutomatedReasoningPolicyConfig_ConfidenceThreshold <Double>
-Description <String>
-ContentPolicyConfig_FiltersConfig <GuardrailContentFilterConfig[]>
-ContextualGroundingPolicyConfig_FiltersConfig <GuardrailContextualGroundingFilterConfig[]>
-CrossRegionConfig_GuardrailProfileIdentifier <String>
-KmsKeyId <String>
-WordPolicyConfig_ManagedWordListsConfig <GuardrailManagedWordsConfig[]>
-Name <String>
-SensitiveInformationPolicyConfig_PiiEntitiesConfig <GuardrailPiiEntityConfig[]>
-AutomatedReasoningPolicyConfig_Policy <String[]>
-SensitiveInformationPolicyConfig_RegexesConfig <GuardrailRegexConfig[]>
-ContentPolicyConfig_TierConfig_TierName <GuardrailContentFiltersTierName>
-TopicPolicyConfig_TierConfig_TierName <GuardrailTopicsTierName>
-TopicPolicyConfig_TopicsConfig <GuardrailTopicConfig[]>
-WordPolicyConfig_WordsConfig <GuardrailWordConfig[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockConfig>

Description

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.

Parameters

-AutomatedReasoningPolicyConfig_ConfidenceThreshold <Double>
The confidence threshold for triggering guardrail actions based on Automated Reasoning policy violations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutomatedReasoningPolicyConfig_Policy <String[]>
The list of Automated Reasoning policy ARNs to include in the guardrail configuration. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutomatedReasoningPolicyConfig_Policies
-BlockedInputMessaging <String>
The message to return when the guardrail blocks a prompt.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BlockedOutputsMessaging <String>
The message to return when the guardrail blocks a model response.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonBedrockConfig>
Amazon.PowerShell.Cmdlets.BDR.AmazonBedrockClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContentPolicyConfig_FiltersConfig <GuardrailContentFilterConfig[]>
Contains the type of the content filter and how strongly it should apply to prompts and model responses. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContentPolicyConfig_TierConfig_TierName <GuardrailContentFiltersTierName>
The tier that your guardrail uses for content filters. Valid values include:
  • CLASSIC tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
  • STANDARD tier – Provides a more robust solution than the CLASSIC tier and has more comprehensive language support. This tier requires that your guardrail use cross-Region inference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContextualGroundingPolicyConfig_FiltersConfig <GuardrailContextualGroundingFilterConfig[]>
The filter configuration details for the guardrails contextual grounding policy. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CrossRegionConfig_GuardrailProfileIdentifier <String>
The ID or Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the guardrail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GuardrailIdentifier <String>
The unique identifier of the guardrail. This can be an ID or the ARN.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-KmsKeyId <String>
The ARN of the KMS key with which to encrypt the guardrail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
A name for the guardrail.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Bedrock.Model.UpdateGuardrailResponse). Specifying the name of a property of type Amazon.Bedrock.Model.UpdateGuardrailResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SensitiveInformationPolicyConfig_PiiEntitiesConfig <GuardrailPiiEntityConfig[]>
A list of PII entities to configure to the guardrail. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SensitiveInformationPolicyConfig_RegexesConfig <GuardrailRegexConfig[]>
A list of regular expressions to configure to the guardrail. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicPolicyConfig_TierConfig_TierName <GuardrailTopicsTierName>
The tier that your guardrail uses for denied topic filters. Valid values include:
  • CLASSIC tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
  • STANDARD tier – Provides a more robust solution than the CLASSIC tier and has more comprehensive language support. This tier requires that your guardrail use cross-Region inference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicPolicyConfig_TopicsConfig <GuardrailTopicConfig[]>
A list of policies related to topics that the guardrail should deny. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WordPolicyConfig_ManagedWordListsConfig <GuardrailManagedWordsConfig[]>
A list of managed words to configure for the guardrail. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WordPolicyConfig_WordsConfig <GuardrailWordConfig[]>
A list of words to configure for the guardrail. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Bedrock.Model.UpdateGuardrailResponse
This cmdlet returns an Amazon.Bedrock.Model.UpdateGuardrailResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z