Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.bedrock.Guardrail
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Definition of AWS::Bedrock::Guardrail Resource Type
Create Guardrail Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Guardrail(name: string, args: GuardrailArgs, opts?: CustomResourceOptions);@overload
def Guardrail(resource_name: str,
args: GuardrailArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Guardrail(resource_name: str,
opts: Optional[ResourceOptions] = None,
blocked_input_messaging: Optional[str] = None,
blocked_outputs_messaging: Optional[str] = None,
content_policy_config: Optional[GuardrailContentPolicyConfigArgs] = None,
description: Optional[str] = None,
kms_key_arn: Optional[str] = None,
name: Optional[str] = None,
sensitive_information_policy_config: Optional[GuardrailSensitiveInformationPolicyConfigArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
topic_policy_config: Optional[GuardrailTopicPolicyConfigArgs] = None,
word_policy_config: Optional[GuardrailWordPolicyConfigArgs] = None)func NewGuardrail(ctx *Context, name string, args GuardrailArgs, opts ...ResourceOption) (*Guardrail, error)public Guardrail(string name, GuardrailArgs args, CustomResourceOptions? opts = null)
public Guardrail(String name, GuardrailArgs args)
public Guardrail(String name, GuardrailArgs args, CustomResourceOptions options)
type: aws-native:bedrock:Guardrail
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GuardrailArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GuardrailArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GuardrailArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GuardrailArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GuardrailArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Guardrail Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Guardrail resource accepts the following input properties:
- Blocked
Input stringMessaging - Messaging for when violations are detected in text
- Blocked
Outputs stringMessaging - Messaging for when violations are detected in text
- Content
Policy Pulumi.Config Aws Native. Bedrock. Inputs. Guardrail Content Policy Config - The content filter policies to configure for the guardrail.
- Description string
- Description of the guardrail or its version
- Kms
Key stringArn - The KMS key with which the guardrail was encrypted at rest
- Name string
- Name of the guardrail
- Sensitive
Information Pulumi.Policy Config Aws Native. Bedrock. Inputs. Guardrail Sensitive Information Policy Config - The sensitive information policy to configure for the guardrail.
-
List<Pulumi.
Aws Native. Inputs. Tag> - List of Tags
- Topic
Policy Pulumi.Config Aws Native. Bedrock. Inputs. Guardrail Topic Policy Config - The topic policies to configure for the guardrail.
- Word
Policy Pulumi.Config Aws Native. Bedrock. Inputs. Guardrail Word Policy Config - The word policy you configure for the guardrail.
- Blocked
Input stringMessaging - Messaging for when violations are detected in text
- Blocked
Outputs stringMessaging - Messaging for when violations are detected in text
- Content
Policy GuardrailConfig Content Policy Config Args - The content filter policies to configure for the guardrail.
- Description string
- Description of the guardrail or its version
- Kms
Key stringArn - The KMS key with which the guardrail was encrypted at rest
- Name string
- Name of the guardrail
- Sensitive
Information GuardrailPolicy Config Sensitive Information Policy Config Args - The sensitive information policy to configure for the guardrail.
-
Tag
Args - List of Tags
- Topic
Policy GuardrailConfig Topic Policy Config Args - The topic policies to configure for the guardrail.
- Word
Policy GuardrailConfig Word Policy Config Args - The word policy you configure for the guardrail.
- blocked
Input StringMessaging - Messaging for when violations are detected in text
- blocked
Outputs StringMessaging - Messaging for when violations are detected in text
- content
Policy GuardrailConfig Content Policy Config - The content filter policies to configure for the guardrail.
- description String
- Description of the guardrail or its version
- kms
Key StringArn - The KMS key with which the guardrail was encrypted at rest
- name String
- Name of the guardrail
- sensitive
Information GuardrailPolicy Config Sensitive Information Policy Config - The sensitive information policy to configure for the guardrail.
- List<Tag>
- List of Tags
- topic
Policy GuardrailConfig Topic Policy Config - The topic policies to configure for the guardrail.
- word
Policy GuardrailConfig Word Policy Config - The word policy you configure for the guardrail.
- blocked
Input stringMessaging - Messaging for when violations are detected in text
- blocked
Outputs stringMessaging - Messaging for when violations are detected in text
- content
Policy GuardrailConfig Content Policy Config - The content filter policies to configure for the guardrail.
- description string
- Description of the guardrail or its version
- kms
Key stringArn - The KMS key with which the guardrail was encrypted at rest
- name string
- Name of the guardrail
- sensitive
Information GuardrailPolicy Config Sensitive Information Policy Config - The sensitive information policy to configure for the guardrail.
- Tag[]
- List of Tags
- topic
Policy GuardrailConfig Topic Policy Config - The topic policies to configure for the guardrail.
- word
Policy GuardrailConfig Word Policy Config - The word policy you configure for the guardrail.
- blocked_
input_ strmessaging - Messaging for when violations are detected in text
- blocked_
outputs_ strmessaging - Messaging for when violations are detected in text
- content_
policy_ Guardrailconfig Content Policy Config Args - The content filter policies to configure for the guardrail.
- description str
- Description of the guardrail or its version
- kms_
key_ strarn - The KMS key with which the guardrail was encrypted at rest
- name str
- Name of the guardrail
- sensitive_
information_ Guardrailpolicy_ config Sensitive Information Policy Config Args - The sensitive information policy to configure for the guardrail.
-
Sequence[Tag
Args] - List of Tags
- topic_
policy_ Guardrailconfig Topic Policy Config Args - The topic policies to configure for the guardrail.
- word_
policy_ Guardrailconfig Word Policy Config Args - The word policy you configure for the guardrail.
- blocked
Input StringMessaging - Messaging for when violations are detected in text
- blocked
Outputs StringMessaging - Messaging for when violations are detected in text
- content
Policy Property MapConfig - The content filter policies to configure for the guardrail.
- description String
- Description of the guardrail or its version
- kms
Key StringArn - The KMS key with which the guardrail was encrypted at rest
- name String
- Name of the guardrail
- sensitive
Information Property MapPolicy Config - The sensitive information policy to configure for the guardrail.
- List<Property Map>
- List of Tags
- topic
Policy Property MapConfig - The topic policies to configure for the guardrail.
- word
Policy Property MapConfig - The word policy you configure for the guardrail.
Outputs
All input properties are implicitly available as output properties. Additionally, the Guardrail resource produces the following output properties:
- Created
At string - Time Stamp
- Failure
Recommendations List<string> - List of failure recommendations
- Guardrail
Arn string - Arn representation for the guardrail
- Guardrail
Id string - Unique id for the guardrail
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Bedrock. Guardrail Status - The status of the guardrail.
- Status
Reasons List<string> - List of status reasons
- Updated
At string - Time Stamp
- Version string
- Guardrail version
- Created
At string - Time Stamp
- Failure
Recommendations []string - List of failure recommendations
- Guardrail
Arn string - Arn representation for the guardrail
- Guardrail
Id string - Unique id for the guardrail
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Guardrail
Status - The status of the guardrail.
- Status
Reasons []string - List of status reasons
- Updated
At string - Time Stamp
- Version string
- Guardrail version
- created
At String - Time Stamp
- failure
Recommendations List<String> - List of failure recommendations
- guardrail
Arn String - Arn representation for the guardrail
- guardrail
Id String - Unique id for the guardrail
- id String
- The provider-assigned unique ID for this managed resource.
- status
Guardrail
Status - The status of the guardrail.
- status
Reasons List<String> - List of status reasons
- updated
At String - Time Stamp
- version String
- Guardrail version
- created
At string - Time Stamp
- failure
Recommendations string[] - List of failure recommendations
- guardrail
Arn string - Arn representation for the guardrail
- guardrail
Id string - Unique id for the guardrail
- id string
- The provider-assigned unique ID for this managed resource.
- status
Guardrail
Status - The status of the guardrail.
- status
Reasons string[] - List of status reasons
- updated
At string - Time Stamp
- version string
- Guardrail version
- created_
at str - Time Stamp
- failure_
recommendations Sequence[str] - List of failure recommendations
- guardrail_
arn str - Arn representation for the guardrail
- guardrail_
id str - Unique id for the guardrail
- id str
- The provider-assigned unique ID for this managed resource.
- status
Guardrail
Status - The status of the guardrail.
- status_
reasons Sequence[str] - List of status reasons
- updated_
at str - Time Stamp
- version str
- Guardrail version
- created
At String - Time Stamp
- failure
Recommendations List<String> - List of failure recommendations
- guardrail
Arn String - Arn representation for the guardrail
- guardrail
Id String - Unique id for the guardrail
- id String
- The provider-assigned unique ID for this managed resource.
- status "CREATING" | "UPDATING" | "VERSIONING" | "READY" | "FAILED" | "DELETING"
- The status of the guardrail.
- status
Reasons List<String> - List of status reasons
- updated
At String - Time Stamp
- version String
- Guardrail version
Supporting Types
GuardrailContentFilterConfig, GuardrailContentFilterConfigArgs
- Input
Strength Pulumi.Aws Native. Bedrock. Guardrail Filter Strength - 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 Pulumi.Aws Native. Bedrock. Guardrail Filter Strength - 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.
Aws Native. Bedrock. Guardrail Content Filter Type - The harmful category that the content filter is applied to.
- Input
Strength GuardrailFilter Strength - 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 GuardrailFilter Strength - 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
Guardrail
Content Filter Type - The harmful category that the content filter is applied to.
- input
Strength GuardrailFilter Strength - 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 GuardrailFilter Strength - 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
Guardrail
Content Filter Type - The harmful category that the content filter is applied to.
- input
Strength GuardrailFilter Strength - 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 GuardrailFilter Strength - 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
Guardrail
Content Filter Type - The harmful category that the content filter is applied to.
- input_
strength GuardrailFilter Strength - 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 GuardrailFilter Strength - 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
Guardrail
Content Filter Type - The harmful category that the content filter is applied to.
- input
Strength "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.
- output
Strength "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, GuardrailContentFilterTypeArgs
- Sexual
- SEXUAL
- Violence
- VIOLENCE
- Hate
- HATE
- Insults
- INSULTS
- Misconduct
- MISCONDUCT
- Prompt
Attack - PROMPT_ATTACK
- Guardrail
Content Filter Type Sexual - SEXUAL
- Guardrail
Content Filter Type Violence - VIOLENCE
- Guardrail
Content Filter Type Hate - HATE
- Guardrail
Content Filter Type Insults - INSULTS
- Guardrail
Content Filter Type Misconduct - MISCONDUCT
- Guardrail
Content Filter Type Prompt Attack - PROMPT_ATTACK
- Sexual
- SEXUAL
- Violence
- VIOLENCE
- Hate
- HATE
- Insults
- INSULTS
- Misconduct
- MISCONDUCT
- Prompt
Attack - PROMPT_ATTACK
- Sexual
- SEXUAL
- Violence
- VIOLENCE
- Hate
- HATE
- Insults
- INSULTS
- Misconduct
- MISCONDUCT
- Prompt
Attack - PROMPT_ATTACK
- SEXUAL
- SEXUAL
- VIOLENCE
- VIOLENCE
- HATE
- HATE
- INSULTS
- INSULTS
- MISCONDUCT
- MISCONDUCT
- PROMPT_ATTACK
- PROMPT_ATTACK
- "SEXUAL"
- SEXUAL
- "VIOLENCE"
- VIOLENCE
- "HATE"
- HATE
- "INSULTS"
- INSULTS
- "MISCONDUCT"
- MISCONDUCT
- "PROMPT_ATTACK"
- PROMPT_ATTACK
GuardrailContentPolicyConfig, GuardrailContentPolicyConfigArgs
- Filters
Config List<Pulumi.Aws Native. Bedrock. Inputs. Guardrail Content Filter Config> - List of content filter configs in content policy.
- Filters
Config []GuardrailContent Filter Config - List of content filter configs in content policy.
- filters
Config List<GuardrailContent Filter Config> - List of content filter configs in content policy.
- filters
Config GuardrailContent Filter Config[] - List of content filter configs in content policy.
- filters_
config Sequence[GuardrailContent Filter Config] - List of content filter configs in content policy.
- filters
Config List<Property Map> - List of content filter configs in content policy.
GuardrailFilterStrength, GuardrailFilterStrengthArgs
- None
- NONE
- Low
- LOW
- Medium
- MEDIUM
- High
- HIGH
- Guardrail
Filter Strength None - NONE
- Guardrail
Filter Strength Low - LOW
- Guardrail
Filter Strength Medium - MEDIUM
- Guardrail
Filter Strength High - HIGH
- None
- NONE
- Low
- LOW
- Medium
- MEDIUM
- High
- HIGH
- None
- NONE
- Low
- LOW
- Medium
- MEDIUM
- High
- HIGH
- NONE
- NONE
- LOW
- LOW
- MEDIUM
- MEDIUM
- HIGH
- HIGH
- "NONE"
- NONE
- "LOW"
- LOW
- "MEDIUM"
- MEDIUM
- "HIGH"
- HIGH
GuardrailManagedWordsConfig, GuardrailManagedWordsConfigArgs
- Type
Pulumi.
Aws Native. Bedrock. Guardrail Managed Words Type - The managed word type to configure for the guardrail.
- Type
Guardrail
Managed Words Type - The managed word type to configure for the guardrail.
- type
Guardrail
Managed Words Type - The managed word type to configure for the guardrail.
- type
Guardrail
Managed Words Type - The managed word type to configure for the guardrail.
- type
Guardrail
Managed Words Type - The managed word type to configure for the guardrail.
- type "PROFANITY"
- The managed word type to configure for the guardrail.
GuardrailManagedWordsType, GuardrailManagedWordsTypeArgs
- Profanity
- PROFANITY
- Guardrail
Managed Words Type Profanity - PROFANITY
- Profanity
- PROFANITY
- Profanity
- PROFANITY
- PROFANITY
- PROFANITY
- "PROFANITY"
- PROFANITY
GuardrailPiiEntityConfig, GuardrailPiiEntityConfigArgs
- Action
Pulumi.
Aws Native. Bedrock. Guardrail Sensitive Information Action - Configure guardrail action when the PII entity is detected.
- Type
Pulumi.
Aws Native. Bedrock. Guardrail Pii Entity Type 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.
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
Guardrail
Sensitive Information Action - Configure guardrail action when the PII entity is detected.
- Type
Guardrail
Pii Entity Type 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.
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
Guardrail
Sensitive Information Action - Configure guardrail action when the PII entity is detected.
- type
Guardrail
Pii Entity Type 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.
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
Guardrail
Sensitive Information Action - Configure guardrail action when the PII entity is detected.
- type
Guardrail
Pii Entity Type 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.
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
Guardrail
Sensitive Information Action - Configure guardrail action when the PII entity is detected.
- type
Guardrail
Pii Entity Type 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.
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.
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, GuardrailPiiEntityTypeArgs
- Address
- ADDRESS
- Age
- AGE
- Aws
Access Key - AWS_ACCESS_KEY
- Aws
Secret Key - AWS_SECRET_KEY
- Ca
Health Number - CA_HEALTH_NUMBER
- Ca
Social Insurance Number - CA_SOCIAL_INSURANCE_NUMBER
- Credit
Debit Card Cvv - CREDIT_DEBIT_CARD_CVV
- Credit
Debit Card Expiry - CREDIT_DEBIT_CARD_EXPIRY
- Credit
Debit Card Number - CREDIT_DEBIT_CARD_NUMBER
- Driver
Id - DRIVER_ID
- International
Bank Account Number - INTERNATIONAL_BANK_ACCOUNT_NUMBER
- Ip
Address - IP_ADDRESS
- License
Plate - LICENSE_PLATE
- Mac
Address - MAC_ADDRESS
- Name
- NAME
- Password
- PASSWORD
- Phone
- PHONE
- Pin
- PIN
- Swift
Code - SWIFT_CODE
- Uk
National Health Service Number - UK_NATIONAL_HEALTH_SERVICE_NUMBER
- Uk
National Insurance Number - UK_NATIONAL_INSURANCE_NUMBER
- Uk
Unique Taxpayer Reference Number - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- Url
- URL
- Username
- USERNAME
- Us
Bank Account Number - US_BANK_ACCOUNT_NUMBER
- Us
Bank Routing Number - US_BANK_ROUTING_NUMBER
- Us
Individual Tax Identification Number - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- Us
Passport Number - US_PASSPORT_NUMBER
- Us
Social Security Number - US_SOCIAL_SECURITY_NUMBER
- Vehicle
Identification Number - VEHICLE_IDENTIFICATION_NUMBER
- Guardrail
Pii Entity Type Address - ADDRESS
- Guardrail
Pii Entity Type Age - AGE
- Guardrail
Pii Entity Type Aws Access Key - AWS_ACCESS_KEY
- Guardrail
Pii Entity Type Aws Secret Key - AWS_SECRET_KEY
- Guardrail
Pii Entity Type Ca Health Number - CA_HEALTH_NUMBER
- Guardrail
Pii Entity Type Ca Social Insurance Number - CA_SOCIAL_INSURANCE_NUMBER
- Guardrail
Pii Entity Type Credit Debit Card Cvv - CREDIT_DEBIT_CARD_CVV
- Guardrail
Pii Entity Type Credit Debit Card Expiry - CREDIT_DEBIT_CARD_EXPIRY
- Guardrail
Pii Entity Type Credit Debit Card Number - CREDIT_DEBIT_CARD_NUMBER
- Guardrail
Pii Entity Type Driver Id - DRIVER_ID
- Guardrail
Pii Entity Type Email - Guardrail
Pii Entity Type International Bank Account Number - INTERNATIONAL_BANK_ACCOUNT_NUMBER
- Guardrail
Pii Entity Type Ip Address - IP_ADDRESS
- Guardrail
Pii Entity Type License Plate - LICENSE_PLATE
- Guardrail
Pii Entity Type Mac Address - MAC_ADDRESS
- Guardrail
Pii Entity Type Name - NAME
- Guardrail
Pii Entity Type Password - PASSWORD
- Guardrail
Pii Entity Type Phone - PHONE
- Guardrail
Pii Entity Type Pin - PIN
- Guardrail
Pii Entity Type Swift Code - SWIFT_CODE
- Guardrail
Pii Entity Type Uk National Health Service Number - UK_NATIONAL_HEALTH_SERVICE_NUMBER
- Guardrail
Pii Entity Type Uk National Insurance Number - UK_NATIONAL_INSURANCE_NUMBER
- Guardrail
Pii Entity Type Uk Unique Taxpayer Reference Number - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- Guardrail
Pii Entity Type Url - URL
- Guardrail
Pii Entity Type Username - USERNAME
- Guardrail
Pii Entity Type Us Bank Account Number - US_BANK_ACCOUNT_NUMBER
- Guardrail
Pii Entity Type Us Bank Routing Number - US_BANK_ROUTING_NUMBER
- Guardrail
Pii Entity Type Us Individual Tax Identification Number - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- Guardrail
Pii Entity Type Us Passport Number - US_PASSPORT_NUMBER
- Guardrail
Pii Entity Type Us Social Security Number - US_SOCIAL_SECURITY_NUMBER
- Guardrail
Pii Entity Type Vehicle Identification Number - VEHICLE_IDENTIFICATION_NUMBER
- Address
- ADDRESS
- Age
- AGE
- Aws
Access Key - AWS_ACCESS_KEY
- Aws
Secret Key - AWS_SECRET_KEY
- Ca
Health Number - CA_HEALTH_NUMBER
- Ca
Social Insurance Number - CA_SOCIAL_INSURANCE_NUMBER
- Credit
Debit Card Cvv - CREDIT_DEBIT_CARD_CVV
- Credit
Debit Card Expiry - CREDIT_DEBIT_CARD_EXPIRY
- Credit
Debit Card Number - CREDIT_DEBIT_CARD_NUMBER
- Driver
Id - DRIVER_ID
- International
Bank Account Number - INTERNATIONAL_BANK_ACCOUNT_NUMBER
- Ip
Address - IP_ADDRESS
- License
Plate - LICENSE_PLATE
- Mac
Address - MAC_ADDRESS
- Name
- NAME
- Password
- PASSWORD
- Phone
- PHONE
- Pin
- PIN
- Swift
Code - SWIFT_CODE
- Uk
National Health Service Number - UK_NATIONAL_HEALTH_SERVICE_NUMBER
- Uk
National Insurance Number - UK_NATIONAL_INSURANCE_NUMBER
- Uk
Unique Taxpayer Reference Number - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- Url
- URL
- Username
- USERNAME
- Us
Bank Account Number - US_BANK_ACCOUNT_NUMBER
- Us
Bank Routing Number - US_BANK_ROUTING_NUMBER
- Us
Individual Tax Identification Number - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- Us
Passport Number - US_PASSPORT_NUMBER
- Us
Social Security Number - US_SOCIAL_SECURITY_NUMBER
- Vehicle
Identification Number - VEHICLE_IDENTIFICATION_NUMBER
- Address
- ADDRESS
- Age
- AGE
- Aws
Access Key - AWS_ACCESS_KEY
- Aws
Secret Key - AWS_SECRET_KEY
- Ca
Health Number - CA_HEALTH_NUMBER
- Ca
Social Insurance Number - CA_SOCIAL_INSURANCE_NUMBER
- Credit
Debit Card Cvv - CREDIT_DEBIT_CARD_CVV
- Credit
Debit Card Expiry - CREDIT_DEBIT_CARD_EXPIRY
- Credit
Debit Card Number - CREDIT_DEBIT_CARD_NUMBER
- Driver
Id - DRIVER_ID
- International
Bank Account Number - INTERNATIONAL_BANK_ACCOUNT_NUMBER
- Ip
Address - IP_ADDRESS
- License
Plate - LICENSE_PLATE
- Mac
Address - MAC_ADDRESS
- Name
- NAME
- Password
- PASSWORD
- Phone
- PHONE
- Pin
- PIN
- Swift
Code - SWIFT_CODE
- Uk
National Health Service Number - UK_NATIONAL_HEALTH_SERVICE_NUMBER
- Uk
National Insurance Number - UK_NATIONAL_INSURANCE_NUMBER
- Uk
Unique Taxpayer Reference Number - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- Url
- URL
- Username
- USERNAME
- Us
Bank Account Number - US_BANK_ACCOUNT_NUMBER
- Us
Bank Routing Number - US_BANK_ROUTING_NUMBER
- Us
Individual Tax Identification Number - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- Us
Passport Number - US_PASSPORT_NUMBER
- Us
Social Security Number - US_SOCIAL_SECURITY_NUMBER
- Vehicle
Identification Number - VEHICLE_IDENTIFICATION_NUMBER
- ADDRESS
- ADDRESS
- AGE
- AGE
- AWS_ACCESS_KEY
- AWS_ACCESS_KEY
- AWS_SECRET_KEY
- AWS_SECRET_KEY
- CA_HEALTH_NUMBER
- CA_HEALTH_NUMBER
- CA_SOCIAL_INSURANCE_NUMBER
- CA_SOCIAL_INSURANCE_NUMBER
- CREDIT_DEBIT_CARD_CVV
- CREDIT_DEBIT_CARD_CVV
- CREDIT_DEBIT_CARD_EXPIRY
- CREDIT_DEBIT_CARD_EXPIRY
- CREDIT_DEBIT_CARD_NUMBER
- CREDIT_DEBIT_CARD_NUMBER
- DRIVER_ID
- DRIVER_ID
- INTERNATIONAL_BANK_ACCOUNT_NUMBER
- INTERNATIONAL_BANK_ACCOUNT_NUMBER
- IP_ADDRESS
- IP_ADDRESS
- LICENSE_PLATE
- LICENSE_PLATE
- MAC_ADDRESS
- MAC_ADDRESS
- NAME
- NAME
- PASSWORD
- PASSWORD
- PHONE
- PHONE
- PIN
- PIN
- SWIFT_CODE
- SWIFT_CODE
- UK_NATIONAL_HEALTH_SERVICE_NUMBER
- UK_NATIONAL_HEALTH_SERVICE_NUMBER
- UK_NATIONAL_INSURANCE_NUMBER
- UK_NATIONAL_INSURANCE_NUMBER
- UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- URL
- URL
- USERNAME
- USERNAME
- US_BANK_ACCOUNT_NUMBER
- US_BANK_ACCOUNT_NUMBER
- US_BANK_ROUTING_NUMBER
- US_BANK_ROUTING_NUMBER
- US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- US_PASSPORT_NUMBER
- US_PASSPORT_NUMBER
- US_SOCIAL_SECURITY_NUMBER
- US_SOCIAL_SECURITY_NUMBER
- VEHICLE_IDENTIFICATION_NUMBER
- VEHICLE_IDENTIFICATION_NUMBER
- "ADDRESS"
- ADDRESS
- "AGE"
- AGE
- "AWS_ACCESS_KEY"
- AWS_ACCESS_KEY
- "AWS_SECRET_KEY"
- AWS_SECRET_KEY
- "CA_HEALTH_NUMBER"
- CA_HEALTH_NUMBER
- "CA_SOCIAL_INSURANCE_NUMBER"
- CA_SOCIAL_INSURANCE_NUMBER
- "CREDIT_DEBIT_CARD_CVV"
- CREDIT_DEBIT_CARD_CVV
- "CREDIT_DEBIT_CARD_EXPIRY"
- CREDIT_DEBIT_CARD_EXPIRY
- "CREDIT_DEBIT_CARD_NUMBER"
- CREDIT_DEBIT_CARD_NUMBER
- "DRIVER_ID"
- DRIVER_ID
- "EMAIL"
- "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
- INTERNATIONAL_BANK_ACCOUNT_NUMBER
- "IP_ADDRESS"
- IP_ADDRESS
- "LICENSE_PLATE"
- LICENSE_PLATE
- "MAC_ADDRESS"
- MAC_ADDRESS
- "NAME"
- NAME
- "PASSWORD"
- PASSWORD
- "PHONE"
- PHONE
- "PIN"
- PIN
- "SWIFT_CODE"
- SWIFT_CODE
- "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
- UK_NATIONAL_HEALTH_SERVICE_NUMBER
- "UK_NATIONAL_INSURANCE_NUMBER"
- UK_NATIONAL_INSURANCE_NUMBER
- "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
- UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
- "URL"
- URL
- "USERNAME"
- USERNAME
- "US_BANK_ACCOUNT_NUMBER"
- US_BANK_ACCOUNT_NUMBER
- "US_BANK_ROUTING_NUMBER"
- US_BANK_ROUTING_NUMBER
- "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
- US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
- "US_PASSPORT_NUMBER"
- US_PASSPORT_NUMBER
- "US_SOCIAL_SECURITY_NUMBER"
- US_SOCIAL_SECURITY_NUMBER
- "VEHICLE_IDENTIFICATION_NUMBER"
- VEHICLE_IDENTIFICATION_NUMBER
GuardrailRegexConfig, GuardrailRegexConfigArgs
- Action
Pulumi.
Aws Native. Bedrock. Guardrail Sensitive Information Action - 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
Guardrail
Sensitive Information Action - 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
Guardrail
Sensitive Information Action - 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
Guardrail
Sensitive Information Action - 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
Guardrail
Sensitive Information Action - 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, GuardrailSensitiveInformationActionArgs
- Block
- BLOCK
- Anonymize
- ANONYMIZE
- Guardrail
Sensitive Information Action Block - BLOCK
- Guardrail
Sensitive Information Action Anonymize - ANONYMIZE
- Block
- BLOCK
- Anonymize
- ANONYMIZE
- Block
- BLOCK
- Anonymize
- ANONYMIZE
- BLOCK
- BLOCK
- ANONYMIZE
- ANONYMIZE
- "BLOCK"
- BLOCK
- "ANONYMIZE"
- ANONYMIZE
GuardrailSensitiveInformationPolicyConfig, GuardrailSensitiveInformationPolicyConfigArgs
- Pii
Entities []GuardrailConfig Pii Entity Config - List of entities.
- Regexes
Config []GuardrailRegex Config - List of regex.
- pii
Entities List<GuardrailConfig Pii Entity Config> - List of entities.
- regexes
Config List<GuardrailRegex Config> - List of regex.
- pii
Entities GuardrailConfig Pii Entity Config[] - List of entities.
- regexes
Config GuardrailRegex Config[] - List of regex.
- pii_
entities_ Sequence[Guardrailconfig Pii Entity Config] - List of entities.
- regexes_
config Sequence[GuardrailRegex Config] - List of regex.
- pii
Entities List<Property Map>Config - List of entities.
- regexes
Config List<Property Map> - List of regex.
GuardrailStatus, GuardrailStatusArgs
- Creating
- CREATING
- Updating
- UPDATING
- Versioning
- VERSIONING
- Ready
- READY
- Failed
- FAILED
- Deleting
- DELETING
- Guardrail
Status Creating - CREATING
- Guardrail
Status Updating - UPDATING
- Guardrail
Status Versioning - VERSIONING
- Guardrail
Status Ready - READY
- Guardrail
Status Failed - FAILED
- Guardrail
Status Deleting - DELETING
- Creating
- CREATING
- Updating
- UPDATING
- Versioning
- VERSIONING
- Ready
- READY
- Failed
- FAILED
- Deleting
- DELETING
- Creating
- CREATING
- Updating
- UPDATING
- Versioning
- VERSIONING
- Ready
- READY
- Failed
- FAILED
- Deleting
- DELETING
- CREATING
- CREATING
- UPDATING
- UPDATING
- VERSIONING
- VERSIONING
- READY
- READY
- FAILED
- FAILED
- DELETING
- DELETING
- "CREATING"
- CREATING
- "UPDATING"
- UPDATING
- "VERSIONING"
- VERSIONING
- "READY"
- READY
- "FAILED"
- FAILED
- "DELETING"
- DELETING
GuardrailTopicConfig, GuardrailTopicConfigArgs
- Definition string
- Definition of topic in topic policy
- Name string
- Name of topic in topic policy
- Type
Pulumi.
Aws Native. Bedrock. Guardrail Topic Type - 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
Guardrail
Topic Type - 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
Guardrail
Topic Type - 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
Guardrail
Topic Type - 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
Guardrail
Topic Type - 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, GuardrailTopicPolicyConfigArgs
- Topics
Config List<Pulumi.Aws Native. Bedrock. Inputs. Guardrail Topic Config> - List of topic configs in topic policy.
- Topics
Config []GuardrailTopic Config - List of topic configs in topic policy.
- topics
Config List<GuardrailTopic Config> - List of topic configs in topic policy.
- topics
Config GuardrailTopic Config[] - List of topic configs in topic policy.
- topics_
config Sequence[GuardrailTopic Config] - List of topic configs in topic policy.
- topics
Config List<Property Map> - List of topic configs in topic policy.
GuardrailTopicType, GuardrailTopicTypeArgs
- Deny
- DENY
- Guardrail
Topic Type Deny - DENY
- Deny
- DENY
- Deny
- DENY
- DENY
- DENY
- "DENY"
- DENY
GuardrailWordConfig, GuardrailWordConfigArgs
- 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, GuardrailWordPolicyConfigArgs
- Managed
Word List<Pulumi.Lists Config Aws Native. Bedrock. Inputs. Guardrail Managed Words Config> - A config for the list of managed words.
- Words
Config List<Pulumi.Aws Native. Bedrock. Inputs. Guardrail Word Config> - List of custom word configs.
- Managed
Word []GuardrailLists Config Managed Words Config - A config for the list of managed words.
- Words
Config []GuardrailWord Config - List of custom word configs.
- managed
Word List<GuardrailLists Config Managed Words Config> - A config for the list of managed words.
- words
Config List<GuardrailWord Config> - List of custom word configs.
- managed
Word GuardrailLists Config Managed Words Config[] - A config for the list of managed words.
- words
Config GuardrailWord Config[] - List of custom word configs.
- managed_
word_ Sequence[Guardraillists_ config Managed Words Config] - A config for the list of managed words.
- words_
config Sequence[GuardrailWord Config] - List of custom word configs.
- managed
Word List<Property Map>Lists Config - A config for the list of managed words.
- words
Config List<Property Map> - List of custom word configs.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.