1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. getAiGuardrail

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.48.0 published on Monday, Jan 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.wisdom.getAiGuardrail

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.48.0 published on Monday, Jan 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Definition of AWS::Wisdom::AIGuardrail Resource Type

    Using getAiGuardrail

    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 getAiGuardrail(args: GetAiGuardrailArgs, opts?: InvokeOptions): Promise<GetAiGuardrailResult>
function getAiGuardrailOutput(args: GetAiGuardrailOutputArgs, opts?: InvokeOptions): Output<GetAiGuardrailResult>
    def get_ai_guardrail(ai_guardrail_id: Optional[str] = None,
                     assistant_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAiGuardrailResult
def get_ai_guardrail_output(ai_guardrail_id: Optional[pulumi.Input[str]] = None,
                     assistant_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAiGuardrailResult]
    func LookupAiGuardrail(ctx *Context, args *LookupAiGuardrailArgs, opts ...InvokeOption) (*LookupAiGuardrailResult, error)
func LookupAiGuardrailOutput(ctx *Context, args *LookupAiGuardrailOutputArgs, opts ...InvokeOption) LookupAiGuardrailResultOutput

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

    public static class GetAiGuardrail 
{
    public static Task<GetAiGuardrailResult> InvokeAsync(GetAiGuardrailArgs args, InvokeOptions? opts = null)
    public static Output<GetAiGuardrailResult> Invoke(GetAiGuardrailInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAiGuardrailResult> getAiGuardrail(GetAiGuardrailArgs args, InvokeOptions options)
public static Output<GetAiGuardrailResult> getAiGuardrail(GetAiGuardrailArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:wisdom:getAiGuardrail
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    AssistantId string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    AiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    AssistantId string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    aiGuardrailId String
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantId String
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    aiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantId string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    ai_guardrail_id str
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistant_id str
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    aiGuardrailId String
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantId String
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    getAiGuardrail Result

    The following output properties are available:

    AiGuardrailArn string
    The Amazon Resource Name (ARN) of the AI Guardrail.
    AiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    AssistantArn string
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    BlockedInputMessaging string
    Messaging for when violations are detected in text
    BlockedOutputsMessaging string
    Messaging for when violations are detected in text
    ContentPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailContentPolicyConfig
    Contains details about how to handle harmful content.
    ContextualGroundingPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailContextualGroundingPolicyConfig
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    Description string
    Description of the guardrail or its version
    SensitiveInformationPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    TopicPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailTopicPolicyConfig
    Contains details about topics that the AI Guardrail should identify and deny.
    WordPolicyConfig Pulumi.AwsNative.Wisdom.Outputs.AiGuardrailAiGuardrailWordPolicyConfig
    Contains details about the word policy to configured for the AI Guardrail.
    AiGuardrailArn string
    The Amazon Resource Name (ARN) of the AI Guardrail.
    AiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    AssistantArn string
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    BlockedInputMessaging string
    Messaging for when violations are detected in text
    BlockedOutputsMessaging string
    Messaging for when violations are detected in text
    ContentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig
    Contains details about how to handle harmful content.
    ContextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    Description string
    Description of the guardrail or its version
    SensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    TopicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig
    Contains details about topics that the AI Guardrail should identify and deny.
    WordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig
    Contains details about the word policy to configured for the AI Guardrail.
    aiGuardrailArn String
    The Amazon Resource Name (ARN) of the AI Guardrail.
    aiGuardrailId String
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantArn String
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    blockedInputMessaging String
    Messaging for when violations are detected in text
    blockedOutputsMessaging String
    Messaging for when violations are detected in text
    contentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig
    Contains details about how to handle harmful content.
    contextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    description String
    Description of the guardrail or its version
    sensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    topicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig
    Contains details about topics that the AI Guardrail should identify and deny.
    wordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig
    Contains details about the word policy to configured for the AI Guardrail.
    aiGuardrailArn string
    The Amazon Resource Name (ARN) of the AI Guardrail.
    aiGuardrailId string
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantArn string
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    blockedInputMessaging string
    Messaging for when violations are detected in text
    blockedOutputsMessaging string
    Messaging for when violations are detected in text
    contentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig
    Contains details about how to handle harmful content.
    contextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    description string
    Description of the guardrail or its version
    sensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    topicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig
    Contains details about topics that the AI Guardrail should identify and deny.
    wordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig
    Contains details about the word policy to configured for the AI Guardrail.
    ai_guardrail_arn str
    The Amazon Resource Name (ARN) of the AI Guardrail.
    ai_guardrail_id str
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistant_arn str
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    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 AiGuardrailAiGuardrailContentPolicyConfig
    Contains details about how to handle harmful content.
    contextual_grounding_policy_config AiGuardrailAiGuardrailContextualGroundingPolicyConfig
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    description str
    Description of the guardrail or its version
    sensitive_information_policy_config AiGuardrailAiGuardrailSensitiveInformationPolicyConfig
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    topic_policy_config AiGuardrailAiGuardrailTopicPolicyConfig
    Contains details about topics that the AI Guardrail should identify and deny.
    word_policy_config AiGuardrailAiGuardrailWordPolicyConfig
    Contains details about the word policy to configured for the AI Guardrail.
    aiGuardrailArn String
    The Amazon Resource Name (ARN) of the AI Guardrail.
    aiGuardrailId String
    The identifier of the Amazon Q in Connect AI Guardrail.
    assistantArn String
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    blockedInputMessaging String
    Messaging for when violations are detected in text
    blockedOutputsMessaging String
    Messaging for when violations are detected in text
    contentPolicyConfig Property Map
    Contains details about how to handle harmful content.
    contextualGroundingPolicyConfig Property Map
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    description String
    Description of the guardrail or its version
    sensitiveInformationPolicyConfig Property Map
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    topicPolicyConfig Property Map
    Contains details about topics that the AI Guardrail should identify and deny.
    wordPolicyConfig Property Map
    Contains details about the word policy to configured for the AI Guardrail.

    Supporting Types

    AiGuardrailAiGuardrailContentPolicyConfig

    FiltersConfig []AiGuardrailGuardrailContentFilterConfig
    List of content filter configs in content policy.
    filtersConfig List<AiGuardrailGuardrailContentFilterConfig>
    List of content filter configs in content policy.
    filtersConfig AiGuardrailGuardrailContentFilterConfig[]
    List of content filter configs in content policy.
    filters_config Sequence[AiGuardrailGuardrailContentFilterConfig]
    List of content filter configs in content policy.
    filtersConfig List<Property Map>
    List of content filter configs in content policy.

    AiGuardrailAiGuardrailContextualGroundingPolicyConfig

    FiltersConfig []AiGuardrailGuardrailContextualGroundingFilterConfig
    List of contextual grounding filter configs.
    filtersConfig AiGuardrailGuardrailContextualGroundingFilterConfig[]
    List of contextual grounding filter configs.
    filtersConfig List<Property Map>
    List of contextual grounding filter configs.

    AiGuardrailAiGuardrailSensitiveInformationPolicyConfig

    AiGuardrailAiGuardrailTopicPolicyConfig

    TopicsConfig []AiGuardrailGuardrailTopicConfig
    List of topic configs in topic policy.
    topicsConfig List<AiGuardrailGuardrailTopicConfig>
    List of topic configs in topic policy.
    topicsConfig AiGuardrailGuardrailTopicConfig[]
    List of topic configs in topic policy.
    topics_config Sequence[AiGuardrailGuardrailTopicConfig]
    List of topic configs in topic policy.
    topicsConfig List<Property Map>
    List of topic configs in topic policy.

    AiGuardrailAiGuardrailWordPolicyConfig

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

    AiGuardrailGuardrailContentFilterConfig

    InputStrength Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    OutputStrength Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    InputStrength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    OutputStrength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    Type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    inputStrength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    outputStrength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    inputStrength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    outputStrength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    input_strength AiGuardrailGuardrailFilterStrength
    The strength of the input for the guardrail content filter.
    output_strength AiGuardrailGuardrailFilterStrength
    The output strength of the guardrail content filter.
    type AiGuardrailGuardrailContentFilterType
    The type of the guardrail content filter.
    inputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    The strength of the input for the guardrail content filter.
    outputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    The output strength of the guardrail content filter.
    type "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"
    The type of the guardrail content filter.

    AiGuardrailGuardrailContentFilterType

    AiGuardrailGuardrailContextualGroundingFilterConfig

    Threshold double
    The threshold for this filter.
    Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContextualGroundingFilterType
    The type of this filter.
    Threshold float64
    The threshold for this filter.
    Type AiGuardrailGuardrailContextualGroundingFilterType
    The type of this filter.
    threshold Double
    The threshold for this filter.
    type AiGuardrailGuardrailContextualGroundingFilterType
    The type of this filter.
    threshold number
    The threshold for this filter.
    type AiGuardrailGuardrailContextualGroundingFilterType
    The type of this filter.
    threshold float
    The threshold for this filter.
    type AiGuardrailGuardrailContextualGroundingFilterType
    The type of this filter.
    threshold Number
    The threshold for this filter.
    type "GROUNDING" | "RELEVANCE"
    The type of this filter.

    AiGuardrailGuardrailContextualGroundingFilterType

    AiGuardrailGuardrailFilterStrength

    AiGuardrailGuardrailManagedWordsConfig

    Type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type AiGuardrailGuardrailManagedWordsType
    The type of guardrail managed words.
    type "PROFANITY"
    The type of guardrail managed words.

    AiGuardrailGuardrailManagedWordsType

    AiGuardrailGuardrailPiiEntityConfig

    Action Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailSensitiveInformationAction
    The action of guardrail PII entity configuration.
    Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailPiiEntityType

    Configure AI 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. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail 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

    • CREDIT_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 . AI Guardrail 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 555 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 an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

    Action AiGuardrailGuardrailSensitiveInformationAction
    The action of guardrail PII entity configuration.
    Type AiGuardrailGuardrailPiiEntityType

    Configure AI 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. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail 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

    • CREDIT_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 . AI Guardrail 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 555 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 an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

    action AiGuardrailGuardrailSensitiveInformationAction
    The action of guardrail PII entity configuration.
    type AiGuardrailGuardrailPiiEntityType

    Configure AI 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. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail 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

    • CREDIT_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 . AI Guardrail 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 555 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 an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

    action AiGuardrailGuardrailSensitiveInformationAction
    The action of guardrail PII entity configuration.
    type AiGuardrailGuardrailPiiEntityType

    Configure AI 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. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail 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

    • CREDIT_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 . AI Guardrail 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 555 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 an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

    action AiGuardrailGuardrailSensitiveInformationAction
    The action of guardrail PII entity configuration.
    type AiGuardrailGuardrailPiiEntityType

    Configure AI 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. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail 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

    • CREDIT_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 . AI Guardrail 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 555 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 an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

    action "BLOCK" | "ANONYMIZE"
    The action of guardrail PII entity configuration.
    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 AI 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. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail 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

    • CREDIT_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 . AI Guardrail 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 555 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 an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

    AiGuardrailGuardrailPiiEntityType

    AiGuardrailGuardrailRegexConfig

    Action Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailSensitiveInformationAction
    The action of the guardrail regex configuration.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    Action AiGuardrailGuardrailSensitiveInformationAction
    The action of the guardrail regex configuration.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    action AiGuardrailGuardrailSensitiveInformationAction
    The action of the guardrail regex configuration.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.
    action AiGuardrailGuardrailSensitiveInformationAction
    The action of the guardrail regex configuration.
    name string
    The regex name.
    pattern string
    The regex pattern.
    description string
    The regex description.
    action AiGuardrailGuardrailSensitiveInformationAction
    The action of the guardrail regex configuration.
    name str
    The regex name.
    pattern str
    The regex pattern.
    description str
    The regex description.
    action "BLOCK" | "ANONYMIZE"
    The action of the guardrail regex configuration.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.

    AiGuardrailGuardrailSensitiveInformationAction

    AiGuardrailGuardrailTopicConfig

    Definition string
    Definition of topic in topic policy
    Name string
    Name of topic in topic policy
    Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailTopicType
    Type of topic in a policy.
    Examples List<string>
    List of text examples
    Definition string
    Definition of topic in topic policy
    Name string
    Name of topic in topic policy
    Type AiGuardrailGuardrailTopicType
    Type of topic in a policy.
    Examples []string
    List of text examples
    definition String
    Definition of topic in topic policy
    name String
    Name of topic in topic policy
    type AiGuardrailGuardrailTopicType
    Type of topic in a policy.
    examples List<String>
    List of text examples
    definition string
    Definition of topic in topic policy
    name string
    Name of topic in topic policy
    type AiGuardrailGuardrailTopicType
    Type of topic in a policy.
    examples string[]
    List of text examples
    definition str
    Definition of topic in topic policy
    name str
    Name of topic in topic policy
    type AiGuardrailGuardrailTopicType
    Type of topic in a policy.
    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"
    Type of topic in a policy.
    examples List<String>
    List of text examples

    AiGuardrailGuardrailTopicType

    AiGuardrailGuardrailWordConfig

    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.

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.48.0 published on Monday, Jan 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate