AWS Native v0.105.0, May 2 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.bedrock.getGuardrail

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getGuardrail

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGuardrail(args: GetGuardrailArgs, opts?: InvokeOptions): Promise<GetGuardrailResult>
function getGuardrailOutput(args: GetGuardrailOutputArgs, opts?: InvokeOptions): Output<GetGuardrailResult>

def get_guardrail(guardrail_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetGuardrailResult
def get_guardrail_output(guardrail_arn: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetGuardrailResult]

func LookupGuardrail(ctx *Context, args *LookupGuardrailArgs, opts ...InvokeOption) (*LookupGuardrailResult, error)
func LookupGuardrailOutput(ctx *Context, args *LookupGuardrailOutputArgs, opts ...InvokeOption) LookupGuardrailResultOutput

> Note: This function is named LookupGuardrail in the Go SDK.

public static class GetGuardrail 
{
    public static Task<GetGuardrailResult> InvokeAsync(GetGuardrailArgs args, InvokeOptions? opts = null)
    public static Output<GetGuardrailResult> Invoke(GetGuardrailInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGuardrailResult> getGuardrail(GetGuardrailArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:bedrock:getGuardrail
  arguments:
    # arguments dictionary

The following arguments are supported:

GuardrailArn string: Arn representation for the guardrail

GuardrailArn string: Arn representation for the guardrail

guardrailArn String: Arn representation for the guardrail

guardrailArn string: Arn representation for the guardrail

guardrail_arn str: Arn representation for the guardrail

guardrailArn String: Arn representation for the guardrail

getGuardrail Result

The following output properties are available:

BlockedInputMessaging string: Messaging for when violations are detected in text
BlockedOutputsMessaging string: Messaging for when violations are detected in text
ContentPolicyConfig Pulumi.AwsNative.Bedrock.Outputs.GuardrailContentPolicyConfig
CreatedAt string: Time Stamp
Description string: Description of the guardrail or its version
FailureRecommendations List<string>: List of failure recommendations
GuardrailArn string: Arn representation for the guardrail
GuardrailId string: Unique id for the guardrail
KmsKeyArn string: The KMS key with which the guardrail was encrypted at rest
Name string: Name of the guardrail
SensitiveInformationPolicyConfig Pulumi.AwsNative.Bedrock.Outputs.GuardrailSensitiveInformationPolicyConfig
Status Pulumi.AwsNative.Bedrock.GuardrailStatus
StatusReasons List<string>: List of status reasons
Tags List<Pulumi.AwsNative.Outputs.Tag>: List of Tags
TopicPolicyConfig Pulumi.AwsNative.Bedrock.Outputs.GuardrailTopicPolicyConfig
UpdatedAt string: Time Stamp
Version string: Guardrail version
WordPolicyConfig Pulumi.AwsNative.Bedrock.Outputs.GuardrailWordPolicyConfig

BlockedInputMessaging string: Messaging for when violations are detected in text
BlockedOutputsMessaging string: Messaging for when violations are detected in text
ContentPolicyConfig GuardrailContentPolicyConfig
CreatedAt string: Time Stamp
Description string: Description of the guardrail or its version
FailureRecommendations []string: List of failure recommendations
GuardrailArn string: Arn representation for the guardrail
GuardrailId string: Unique id for the guardrail
KmsKeyArn string: The KMS key with which the guardrail was encrypted at rest
Name string: Name of the guardrail
SensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
Status GuardrailStatus
StatusReasons []string: List of status reasons
Tags Tag: List of Tags
TopicPolicyConfig GuardrailTopicPolicyConfig
UpdatedAt string: Time Stamp
Version string: Guardrail version
WordPolicyConfig GuardrailWordPolicyConfig

blockedInputMessaging String: Messaging for when violations are detected in text
blockedOutputsMessaging String: Messaging for when violations are detected in text
contentPolicyConfig GuardrailContentPolicyConfig
createdAt String: Time Stamp
description String: Description of the guardrail or its version
failureRecommendations List<String>: List of failure recommendations
guardrailArn String: Arn representation for the guardrail
guardrailId String: Unique id for the guardrail
kmsKeyArn String: The KMS key with which the guardrail was encrypted at rest
name String: Name of the guardrail
sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
status GuardrailStatus
statusReasons List<String>: List of status reasons
tags List<Tag>: List of Tags
topicPolicyConfig GuardrailTopicPolicyConfig
updatedAt String: Time Stamp
version String: Guardrail version
wordPolicyConfig GuardrailWordPolicyConfig

blockedInputMessaging string: Messaging for when violations are detected in text
blockedOutputsMessaging string: Messaging for when violations are detected in text
contentPolicyConfig GuardrailContentPolicyConfig
createdAt string: Time Stamp
description string: Description of the guardrail or its version
failureRecommendations string[]: List of failure recommendations
guardrailArn string: Arn representation for the guardrail
guardrailId string: Unique id for the guardrail
kmsKeyArn string: The KMS key with which the guardrail was encrypted at rest
name string: Name of the guardrail
sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
status GuardrailStatus
statusReasons string[]: List of status reasons
tags Tag[]: List of Tags
topicPolicyConfig GuardrailTopicPolicyConfig
updatedAt string: Time Stamp
version string: Guardrail version
wordPolicyConfig GuardrailWordPolicyConfig

blocked_input_messaging str: Messaging for when violations are detected in text
blocked_outputs_messaging str: Messaging for when violations are detected in text
content_policy_config GuardrailContentPolicyConfig
created_at str: Time Stamp
description str: Description of the guardrail or its version
failure_recommendations Sequence[str]: List of failure recommendations
guardrail_arn str: Arn representation for the guardrail
guardrail_id str: Unique id for the guardrail
kms_key_arn str: The KMS key with which the guardrail was encrypted at rest
name str: Name of the guardrail
sensitive_information_policy_config GuardrailSensitiveInformationPolicyConfig
status GuardrailStatus
status_reasons Sequence[str]: List of status reasons
tags Sequence[root_Tag]: List of Tags
topic_policy_config GuardrailTopicPolicyConfig
updated_at str: Time Stamp
version str: Guardrail version
word_policy_config GuardrailWordPolicyConfig

blockedInputMessaging String: Messaging for when violations are detected in text
blockedOutputsMessaging String: Messaging for when violations are detected in text
contentPolicyConfig Property Map
createdAt String: Time Stamp
description String: Description of the guardrail or its version
failureRecommendations List<String>: List of failure recommendations
guardrailArn String: Arn representation for the guardrail
guardrailId String: Unique id for the guardrail
kmsKeyArn String: The KMS key with which the guardrail was encrypted at rest
name String: Name of the guardrail
sensitiveInformationPolicyConfig Property Map
status "CREATING" | "UPDATING" | "VERSIONING" | "READY" | "FAILED" | "DELETING"
statusReasons List<String>: List of status reasons
tags List<Property Map>: List of Tags
topicPolicyConfig Property Map
updatedAt String: Time Stamp
version String: Guardrail version
wordPolicyConfig Property Map

Supporting Types

GuardrailContentFilterConfig

InputStrength Pulumi.AwsNative.Bedrock.GuardrailFilterStrength
OutputStrength Pulumi.AwsNative.Bedrock.GuardrailFilterStrength
Type Pulumi.AwsNative.Bedrock.GuardrailContentFilterType

InputStrength GuardrailFilterStrength
OutputStrength GuardrailFilterStrength
Type GuardrailContentFilterType

inputStrength GuardrailFilterStrength
outputStrength GuardrailFilterStrength
type GuardrailContentFilterType

inputStrength GuardrailFilterStrength
outputStrength GuardrailFilterStrength
type GuardrailContentFilterType

input_strength GuardrailFilterStrength
output_strength GuardrailFilterStrength
type GuardrailContentFilterType

inputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
outputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
type "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"

GuardrailContentFilterType

GuardrailContentPolicyConfig

FiltersConfig List<Pulumi.AwsNative.Bedrock.Inputs.GuardrailContentFilterConfig>: List of content filter configs in content policy.

FiltersConfig []GuardrailContentFilterConfig: List of content filter configs in content policy.

filtersConfig List<GuardrailContentFilterConfig>: List of content filter configs in content policy.

filtersConfig GuardrailContentFilterConfig[]: List of content filter configs in content policy.

filters_config Sequence[GuardrailContentFilterConfig]: List of content filter configs in content policy.

filtersConfig List<Property Map>: List of content filter configs in content policy.

GuardrailFilterStrength

GuardrailManagedWordsConfig

Type Pulumi.AwsNative.Bedrock.GuardrailManagedWordsType

Type GuardrailManagedWordsType

type GuardrailManagedWordsType

type GuardrailManagedWordsType

type GuardrailManagedWordsType

type "PROFANITY"

GuardrailManagedWordsType

GuardrailPiiEntityConfig

Action Pulumi.AwsNative.Bedrock.GuardrailSensitiveInformationAction
Type Pulumi.AwsNative.Bedrock.GuardrailPiiEntityType

Action GuardrailSensitiveInformationAction
Type GuardrailPiiEntityType

action GuardrailSensitiveInformationAction
type GuardrailPiiEntityType

action GuardrailSensitiveInformationAction
type GuardrailPiiEntityType

action GuardrailSensitiveInformationAction
type GuardrailPiiEntityType

action "BLOCK" | "ANONYMIZE"
type "ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"

GuardrailPiiEntityType

GuardrailRegexConfig

Action Pulumi.AwsNative.Bedrock.GuardrailSensitiveInformationAction
Name string: The regex name.
Pattern string: The regex pattern.
Description string: The regex description.

Action GuardrailSensitiveInformationAction
Name string: The regex name.
Pattern string: The regex pattern.
Description string: The regex description.

action GuardrailSensitiveInformationAction
name String: The regex name.
pattern String: The regex pattern.
description String: The regex description.

action GuardrailSensitiveInformationAction
name string: The regex name.
pattern string: The regex pattern.
description string: The regex description.

action GuardrailSensitiveInformationAction
name str: The regex name.
pattern str: The regex pattern.
description str: The regex description.

action "BLOCK" | "ANONYMIZE"
name String: The regex name.
pattern String: The regex pattern.
description String: The regex description.

GuardrailSensitiveInformationAction

GuardrailSensitiveInformationPolicyConfig

PiiEntitiesConfig List<Pulumi.AwsNative.Bedrock.Inputs.GuardrailPiiEntityConfig>: List of entities.
RegexesConfig List<Pulumi.AwsNative.Bedrock.Inputs.GuardrailRegexConfig>: List of regex.

PiiEntitiesConfig []GuardrailPiiEntityConfig: List of entities.
RegexesConfig []GuardrailRegexConfig: List of regex.

piiEntitiesConfig List<GuardrailPiiEntityConfig>: List of entities.
regexesConfig List<GuardrailRegexConfig>: List of regex.

piiEntitiesConfig GuardrailPiiEntityConfig[]: List of entities.
regexesConfig GuardrailRegexConfig[]: List of regex.

pii_entities_config Sequence[GuardrailPiiEntityConfig]: List of entities.
regexes_config Sequence[GuardrailRegexConfig]: List of regex.

piiEntitiesConfig List<Property Map>: List of entities.
regexesConfig List<Property Map>: List of regex.

GuardrailStatus

GuardrailTopicConfig

Definition string: Definition of topic in topic policy
Name string: Name of topic in topic policy
Type Pulumi.AwsNative.Bedrock.GuardrailTopicType
Examples List<string>: List of text examples

Definition string: Definition of topic in topic policy
Name string: Name of topic in topic policy
Type GuardrailTopicType
Examples []string: List of text examples

definition String: Definition of topic in topic policy
name String: Name of topic in topic policy
type GuardrailTopicType
examples List<String>: List of text examples

definition string: Definition of topic in topic policy
name string: Name of topic in topic policy
type GuardrailTopicType
examples string[]: List of text examples

definition str: Definition of topic in topic policy
name str: Name of topic in topic policy
type GuardrailTopicType
examples Sequence[str]: List of text examples

definition String: Definition of topic in topic policy
name String: Name of topic in topic policy
type "DENY"
examples List<String>: List of text examples

GuardrailTopicPolicyConfig

TopicsConfig List<Pulumi.AwsNative.Bedrock.Inputs.GuardrailTopicConfig>: List of topic configs in topic policy.

TopicsConfig []GuardrailTopicConfig: List of topic configs in topic policy.

topicsConfig List<GuardrailTopicConfig>: List of topic configs in topic policy.

topicsConfig GuardrailTopicConfig[]: List of topic configs in topic policy.

topics_config Sequence[GuardrailTopicConfig]: List of topic configs in topic policy.

topicsConfig List<Property Map>: List of topic configs in topic policy.

GuardrailTopicType

GuardrailWordConfig

Text string: The custom word text.

Text string: The custom word text.

text String: The custom word text.

text string: The custom word text.

text str: The custom word text.

text String: The custom word text.

GuardrailWordPolicyConfig

ManagedWordListsConfig List<Pulumi.AwsNative.Bedrock.Inputs.GuardrailManagedWordsConfig>: A config for the list of managed words.
WordsConfig List<Pulumi.AwsNative.Bedrock.Inputs.GuardrailWordConfig>: List of custom word configs.

ManagedWordListsConfig []GuardrailManagedWordsConfig: A config for the list of managed words.
WordsConfig []GuardrailWordConfig: List of custom word configs.

managedWordListsConfig List<GuardrailManagedWordsConfig>: A config for the list of managed words.
wordsConfig List<GuardrailWordConfig>: List of custom word configs.

managedWordListsConfig GuardrailManagedWordsConfig[]: A config for the list of managed words.
wordsConfig GuardrailWordConfig[]: List of custom word configs.

managed_word_lists_config Sequence[GuardrailManagedWordsConfig]: A config for the list of managed words.
words_config Sequence[GuardrailWordConfig]: List of custom word configs.

managedWordListsConfig List<Property Map>: A config for the list of managed words.
wordsConfig List<Property Map>: List of custom word configs.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.bedrock.getGuardrail

On this page

On this page

Using getGuardrail

getGuardrail Result

Supporting Types

GuardrailContentFilterConfig

GuardrailContentFilterType

GuardrailContentPolicyConfig

GuardrailFilterStrength

GuardrailManagedWordsConfig

GuardrailManagedWordsType

GuardrailPiiEntityConfig

GuardrailPiiEntityType

GuardrailRegexConfig

GuardrailSensitiveInformationAction

GuardrailSensitiveInformationPolicyConfig

GuardrailStatus

GuardrailTopicConfig

GuardrailTopicPolicyConfig

GuardrailTopicType

GuardrailWordConfig

GuardrailWordPolicyConfig

Tag

Package Details

On this page

On this page