CfnAIGuardrailPropsMixin

class aws_cdk.cfn_property_mixins.aws_wisdom.CfnAIGuardrailPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon Q in Connect AI Guardrail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html

CloudformationResource:

AWS::Wisdom::AIGuardrail

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_aIGuardrail_props_mixin = wisdom.CfnAIGuardrailPropsMixin(wisdom.CfnAIGuardrailMixinProps(
    assistant_id="assistantId",
    blocked_input_messaging="blockedInputMessaging",
    blocked_outputs_messaging="blockedOutputsMessaging",
    content_policy_config=wisdom.CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty(
        filters_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(
            input_strength="inputStrength",
            output_strength="outputStrength",
            type="type"
        )]
    ),
    contextual_grounding_policy_config=wisdom.CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty(
        filters_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(
            threshold=123,
            type="type"
        )]
    ),
    description="description",
    name="name",
    sensitive_information_policy_config=wisdom.CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty(
        pii_entities_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(
            action="action",
            type="type"
        )],
        regexes_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(
            action="action",
            description="description",
            name="name",
            pattern="pattern"
        )]
    ),
    tags={
        "tags_key": "tags"
    },
    topic_policy_config=wisdom.CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty(
        topics_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(
            definition="definition",
            examples=["examples"],
            name="name",
            type="type"
        )]
    ),
    word_policy_config=wisdom.CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty(
        managed_word_lists_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(
            type="type"
        )],
        words_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(
            text="text"
        )]
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.

Parameters:

  • props (Union[CfnAIGuardrailMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['assistantId', 'blockedInputMessaging', 'blockedOutputsMessaging', 'contentPolicyConfig', 'contextualGroundingPolicyConfig', 'description', 'name', 'sensitiveInformationPolicyConfig', 'tags', 'topicPolicyConfig', 'wordPolicyConfig']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

AIGuardrailContentPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty(*, filters_config=None)

Bases: object

Content policy config for a guardrail.

Parameters:

filters_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailContentFilterConfigProperty, Dict[str, Any]]], None]) – List of content filter configurations in a content policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontentpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

a_iGuardrail_content_policy_config_property = wisdom.CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty(
    filters_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(
        input_strength="inputStrength",
        output_strength="outputStrength",
        type="type"
    )]
)

Attributes

filters_config

List of content filter configurations in a content policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontentpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailcontentpolicyconfig-filtersconfig

AIGuardrailContextualGroundingPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty(*, filters_config=None)

Bases: object

Contextual grounding policy config for a guardrail.

Parameters:

filters_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailContextualGroundingFilterConfigProperty, Dict[str, Any]]], None]) – List of contextual grounding filter configs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

a_iGuardrail_contextual_grounding_policy_config_property = wisdom.CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty(
    filters_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(
        threshold=123,
        type="type"
    )]
)

Attributes

filters_config

List of contextual grounding filter configs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig-filtersconfig

AIGuardrailSensitiveInformationPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty(*, pii_entities_config=None, regexes_config=None)

Bases: object

Sensitive information policy configuration for a guardrail.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

a_iGuardrail_sensitive_information_policy_config_property = wisdom.CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty(
    pii_entities_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(
        action="action",
        type="type"
    )],
    regexes_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(
        action="action",
        description="description",
        name="name",
        pattern="pattern"
    )]
)

Attributes

pii_entities_config

List of entities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig-piientitiesconfig

regexes_config

List of regex.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig-regexesconfig

AIGuardrailTopicPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty(*, topics_config=None)

Bases: object

Topic policy configuration for a guardrail.

Parameters:

topics_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailTopicConfigProperty, Dict[str, Any]]], None]) – List of topic configs in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailtopicpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

a_iGuardrail_topic_policy_config_property = wisdom.CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty(
    topics_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(
        definition="definition",
        examples=["examples"],
        name="name",
        type="type"
    )]
)

Attributes

topics_config

List of topic configs in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailtopicpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailtopicpolicyconfig-topicsconfig

AIGuardrailWordPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty(*, managed_word_lists_config=None, words_config=None)

Bases: object

Word policy config for a guardrail.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

a_iGuardrail_word_policy_config_property = wisdom.CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty(
    managed_word_lists_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(
        type="type"
    )],
    words_config=[wisdom.CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(
        text="text"
    )]
)

Attributes

managed_word_lists_config

A config for the list of managed words.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailwordpolicyconfig-managedwordlistsconfig

words_config

List of custom word configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailwordpolicyconfig-wordsconfig

GuardrailContentFilterConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(*, input_strength=None, output_strength=None, type=None)

Bases: object

Content filter configuration in content policy.

Parameters:

  • input_strength (Optional[str]) – The strength of the input for the guardrail content filter.

  • output_strength (Optional[str]) – The output strength of the guardrail content filter.

  • type (Optional[str]) – The type of the guardrail content filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_content_filter_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(
    input_strength="inputStrength",
    output_strength="outputStrength",
    type="type"
)

Attributes

input_strength

The strength of the input for the guardrail content filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-inputstrength

output_strength

The output strength of the guardrail content filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-outputstrength

type

The type of the guardrail content filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-type

GuardrailContextualGroundingFilterConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(*, threshold=None, type=None)

Bases: object

A configuration for grounding filter.

Parameters:

  • threshold (Union[int, float, None]) – The threshold for this filter. Default: - 0

  • type (Optional[str]) – The type of this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_contextual_grounding_filter_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(
    threshold=123,
    type="type"
)

Attributes

threshold

The threshold for this filter.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig-threshold

type

The type of this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig-type

GuardrailManagedWordsConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(*, type=None)

Bases: object

A managed words config.

Parameters:

type (Optional[str]) – The type of guardrail managed words.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailmanagedwordsconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_managed_words_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(
    type="type"
)

Attributes

type

The type of guardrail managed words.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailmanagedwordsconfig.html#cfn-wisdom-aiguardrail-guardrailmanagedwordsconfig-type

GuardrailPiiEntityConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(*, action=None, type=None)

Bases: object

PII entity configuration.

Parameters:

  • action (Optional[str]) – The action of guardrail PII entity configuration.

  • type (Optional[str]) – 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..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_pii_entity_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(
    action="action",
    type="type"
)

Attributes

action

The action of guardrail PII entity configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html#cfn-wisdom-aiguardrail-guardrailpiientityconfig-action

type

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html#cfn-wisdom-aiguardrail-guardrailpiientityconfig-type

GuardrailRegexConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(*, action=None, description=None, name=None, pattern=None)

Bases: object

A regex configuration.

Parameters:

  • action (Optional[str]) – The action of the guardrail regex configuration.

  • description (Optional[str]) – The regex description.

  • name (Optional[str]) – A regex configuration.

  • pattern (Optional[str]) – The regex pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_regex_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(
    action="action",
    description="description",
    name="name",
    pattern="pattern"
)

Attributes

action

The action of the guardrail regex configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-action

description

The regex description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-description

name

A regex configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-name

pattern

The regex pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-pattern

GuardrailTopicConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(*, definition=None, examples=None, name=None, type=None)

Bases: object

Topic configuration in topic policy.

Parameters:

  • definition (Optional[str]) – Definition of topic in topic policy.

  • examples (Optional[Sequence[str]]) – Text example in topic policy.

  • name (Optional[str]) – Name of topic in topic policy.

  • type (Optional[str]) – Type of topic in a policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_topic_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(
    definition="definition",
    examples=["examples"],
    name="name",
    type="type"
)

Attributes

definition

Definition of topic in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-definition

examples

Text example in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-examples

name

Name of topic in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-name

type

Type of topic in a policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-type

GuardrailWordConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(*, text=None)

Bases: object

A custom word config.

Parameters:

text (Optional[str]) – The custom word text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailwordconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_wisdom as wisdom

guardrail_word_config_property = wisdom.CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(
    text="text"
)

Attributes

text

The custom word text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailwordconfig.html#cfn-wisdom-aiguardrail-guardrailwordconfig-text