Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. bedrock
  5. getGuardrail

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.getGuardrail

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Bedrock::Guardrail Resource Type

    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
    The content filter policies to configure for the guardrail.
    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
    The sensitive information policy to configure for the guardrail.
    Status Pulumi.AwsNative.Bedrock.GuardrailStatus
    The status of the guardrail.
    StatusReasons List<string>
    List of status reasons
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    List of Tags
    TopicPolicyConfig Pulumi.AwsNative.Bedrock.Outputs.GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    UpdatedAt string
    Time Stamp
    Version string
    Guardrail version
    WordPolicyConfig Pulumi.AwsNative.Bedrock.Outputs.GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    BlockedInputMessaging string
    Messaging for when violations are detected in text
    BlockedOutputsMessaging string
    Messaging for when violations are detected in text
    ContentPolicyConfig GuardrailContentPolicyConfig
    The content filter policies to configure for the guardrail.
    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
    The sensitive information policy to configure for the guardrail.
    Status GuardrailStatus
    The status of the guardrail.
    StatusReasons []string
    List of status reasons
    Tags Tag
    List of Tags
    TopicPolicyConfig GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    UpdatedAt string
    Time Stamp
    Version string
    Guardrail version
    WordPolicyConfig GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    blockedInputMessaging String
    Messaging for when violations are detected in text
    blockedOutputsMessaging String
    Messaging for when violations are detected in text
    contentPolicyConfig GuardrailContentPolicyConfig
    The content filter policies to configure for the guardrail.
    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
    The sensitive information policy to configure for the guardrail.
    status GuardrailStatus
    The status of the guardrail.
    statusReasons List<String>
    List of status reasons
    tags List<Tag>
    List of Tags
    topicPolicyConfig GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    updatedAt String
    Time Stamp
    version String
    Guardrail version
    wordPolicyConfig GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    blockedInputMessaging string
    Messaging for when violations are detected in text
    blockedOutputsMessaging string
    Messaging for when violations are detected in text
    contentPolicyConfig GuardrailContentPolicyConfig
    The content filter policies to configure for the guardrail.
    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
    The sensitive information policy to configure for the guardrail.
    status GuardrailStatus
    The status of the guardrail.
    statusReasons string[]
    List of status reasons
    tags Tag[]
    List of Tags
    topicPolicyConfig GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    updatedAt string
    Time Stamp
    version string
    Guardrail version
    wordPolicyConfig GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    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
    The content filter policies to configure for the guardrail.
    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
    The sensitive information policy to configure for the guardrail.
    status GuardrailStatus
    The status of the guardrail.
    status_reasons Sequence[str]
    List of status reasons
    tags Sequence[root_Tag]
    List of Tags
    topic_policy_config GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    updated_at str
    Time Stamp
    version str
    Guardrail version
    word_policy_config GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    blockedInputMessaging String
    Messaging for when violations are detected in text
    blockedOutputsMessaging String
    Messaging for when violations are detected in text
    contentPolicyConfig Property Map
    The content filter policies to configure for the guardrail.
    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
    The sensitive information policy to configure for the guardrail.
    status "CREATING" | "UPDATING" | "VERSIONING" | "READY" | "FAILED" | "DELETING"
    The status of the guardrail.
    statusReasons List<String>
    List of status reasons
    tags List<Property Map>
    List of Tags
    topicPolicyConfig Property Map
    The topic policies to configure for the guardrail.
    updatedAt String
    Time Stamp
    version String
    Guardrail version
    wordPolicyConfig Property Map
    The word policy you configure for the guardrail.

    Supporting Types

    GuardrailContentFilterConfig

    InputStrength Pulumi.AwsNative.Bedrock.GuardrailFilterStrength
    The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    OutputStrength Pulumi.AwsNative.Bedrock.GuardrailFilterStrength
    The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    Type Pulumi.AwsNative.Bedrock.GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    InputStrength GuardrailFilterStrength
    The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    OutputStrength GuardrailFilterStrength
    The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    Type GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    inputStrength GuardrailFilterStrength
    The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    outputStrength GuardrailFilterStrength
    The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    type GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    inputStrength GuardrailFilterStrength
    The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    outputStrength GuardrailFilterStrength
    The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    type GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    input_strength GuardrailFilterStrength
    The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    output_strength GuardrailFilterStrength
    The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    type GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    inputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    outputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
    type "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"
    The harmful category that the content filter is applied to.

    GuardrailContentFilterType

    GuardrailContentPolicyConfig

    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
    The managed word type to configure for the guardrail.
    Type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type "PROFANITY"
    The managed word type to configure for the guardrail.

    GuardrailManagedWordsType

    GuardrailPiiEntityConfig

    Action Pulumi.AwsNative.Bedrock.GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    Type Pulumi.AwsNative.Bedrock.GuardrailPiiEntityType

    Configure guardrail type when the PII entity is detected.

    The following PIIs are used to block or mask sensitive information:

    • General

    • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

    • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.

    • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

    • EMAIL

    An email address, such as marymajor@email.com .

    • PHONE

    A phone number. This entity type also includes fax and pager numbers.

    • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

    • PASSWORD

    An alphanumeric string that is used as a password, such as "* *very20special#pass** ".

    • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

    • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

    • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

    • Finance

    • REDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

    • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . Guardrails recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

    • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

    • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

    • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

    • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

    • IT

    • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0 .

    • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

    • URL

    A web address, such as www.example.com .

    • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • USA specific

    • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

    • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

    • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

    • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

    • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

    • Canada specific

    • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

    • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

    • UK Specific

    • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

    • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

    • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

    • Custom

    • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

    Action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    Type GuardrailPiiEntityType

    Configure guardrail type when the PII entity is detected.

    The following PIIs are used to block or mask sensitive information:

    • General

    • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

    • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.

    • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

    • EMAIL

    An email address, such as marymajor@email.com .

    • PHONE

    A phone number. This entity type also includes fax and pager numbers.

    • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

    • PASSWORD

    An alphanumeric string that is used as a password, such as "* *very20special#pass** ".

    • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

    • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

    • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

    • Finance

    • REDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

    • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . Guardrails recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

    • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

    • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

    • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

    • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

    • IT

    • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0 .

    • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

    • URL

    A web address, such as www.example.com .

    • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • USA specific

    • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

    • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

    • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

    • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

    • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

    • Canada specific

    • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

    • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

    • UK Specific

    • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

    • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

    • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

    • Custom

    • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

    action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    type GuardrailPiiEntityType

    Configure guardrail type when the PII entity is detected.

    The following PIIs are used to block or mask sensitive information:

    • General

    • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

    • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.

    • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

    • EMAIL

    An email address, such as marymajor@email.com .

    • PHONE

    A phone number. This entity type also includes fax and pager numbers.

    • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

    • PASSWORD

    An alphanumeric string that is used as a password, such as "* *very20special#pass** ".

    • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

    • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

    • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

    • Finance

    • REDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

    • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . Guardrails recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

    • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

    • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

    • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

    • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

    • IT

    • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0 .

    • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

    • URL

    A web address, such as www.example.com .

    • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • USA specific

    • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

    • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

    • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

    • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

    • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

    • Canada specific

    • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

    • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

    • UK Specific

    • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

    • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

    • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

    • Custom

    • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

    action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    type GuardrailPiiEntityType

    Configure guardrail type when the PII entity is detected.

    The following PIIs are used to block or mask sensitive information:

    • General

    • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

    • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.

    • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

    • EMAIL

    An email address, such as marymajor@email.com .

    • PHONE

    A phone number. This entity type also includes fax and pager numbers.

    • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

    • PASSWORD

    An alphanumeric string that is used as a password, such as "* *very20special#pass** ".

    • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

    • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

    • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

    • Finance

    • REDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

    • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . Guardrails recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

    • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

    • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

    • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

    • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

    • IT

    • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0 .

    • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

    • URL

    A web address, such as www.example.com .

    • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • USA specific

    • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

    • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

    • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

    • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

    • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

    • Canada specific

    • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

    • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

    • UK Specific

    • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

    • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

    • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

    • Custom

    • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

    action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    type GuardrailPiiEntityType

    Configure guardrail type when the PII entity is detected.

    The following PIIs are used to block or mask sensitive information:

    • General

    • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

    • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.

    • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

    • EMAIL

    An email address, such as marymajor@email.com .

    • PHONE

    A phone number. This entity type also includes fax and pager numbers.

    • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

    • PASSWORD

    An alphanumeric string that is used as a password, such as "* *very20special#pass** ".

    • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

    • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

    • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

    • Finance

    • REDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

    • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . Guardrails recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

    • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

    • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

    • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

    • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

    • IT

    • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0 .

    • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

    • URL

    A web address, such as www.example.com .

    • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • USA specific

    • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

    • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

    • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

    • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

    • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

    • Canada specific

    • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

    • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

    • UK Specific

    • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

    • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

    • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

    • Custom

    • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

    action "BLOCK" | "ANONYMIZE"
    Configure guardrail action when the PII entity is detected.
    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"

    Configure guardrail type when the PII entity is detected.

    The following PIIs are used to block or mask sensitive information:

    • General

    • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

    • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.

    • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

    • EMAIL

    An email address, such as marymajor@email.com .

    • PHONE

    A phone number. This entity type also includes fax and pager numbers.

    • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

    • PASSWORD

    An alphanumeric string that is used as a password, such as "* *very20special#pass** ".

    • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

    • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

    • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

    • Finance

    • REDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

    • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . Guardrails recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

    • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

    • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

    • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

    • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

    • IT

    • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0 .

    • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

    • URL

    A web address, such as www.example.com .

    • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

    • USA specific

    • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

    • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

    • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

    • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

    • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

    • Canada specific

    • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

    • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

    • UK Specific

    • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

    • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

    • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

    • Custom

    • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

    GuardrailPiiEntityType

    GuardrailRegexConfig

    Action Pulumi.AwsNative.Bedrock.GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    Action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.
    action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    name string
    The regex name.
    pattern string
    The regex pattern.
    description string
    The regex description.
    action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    name str
    The regex name.
    pattern str
    The regex pattern.
    description str
    The regex description.
    action "BLOCK" | "ANONYMIZE"
    The guardrail action to configure when matching regular expression is detected.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.

    GuardrailSensitiveInformationAction

    GuardrailSensitiveInformationPolicyConfig

    GuardrailStatus

    GuardrailTopicConfig

    Definition string
    Definition of topic in topic policy
    Name string
    Name of topic in topic policy
    Type Pulumi.AwsNative.Bedrock.GuardrailTopicType
    Specifies to deny the topic.
    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
    Specifies to deny the topic.
    Examples []string
    List of text examples
    definition String
    Definition of topic in topic policy
    name String
    Name of topic in topic policy
    type GuardrailTopicType
    Specifies to deny the topic.
    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
    Specifies to deny the topic.
    examples string[]
    List of text examples
    definition str
    Definition of topic in topic policy
    name str
    Name of topic in topic policy
    type GuardrailTopicType
    Specifies to deny the topic.
    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"
    Specifies to deny the topic.
    examples List<String>
    List of text examples

    GuardrailTopicPolicyConfig

    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 []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.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native