aws-cdk-lib 2.207.0__py3-none-any.whl → 2.208.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.207.0.jsii.tgz → aws-cdk-lib@2.208.0.jsii.tgz} +0 -0
- aws_cdk/aws_aiops/__init__.py +16 -12
- aws_cdk/aws_amazonmq/__init__.py +8 -18
- aws_cdk/aws_appstream/__init__.py +36 -4
- aws_cdk/aws_bedrock/__init__.py +191 -72
- aws_cdk/aws_certificatemanager/__init__.py +45 -0
- aws_cdk/aws_cloudfront/__init__.py +12 -2
- aws_cdk/aws_connect/__init__.py +107 -3
- aws_cdk/aws_customerprofiles/__init__.py +27 -22
- aws_cdk/aws_docdb/__init__.py +5 -3
- aws_cdk/aws_ec2/__init__.py +53 -11
- aws_cdk/aws_ecs/__init__.py +118 -29
- aws_cdk/aws_events/__init__.py +142 -0
- aws_cdk/aws_gamelift/__init__.py +2 -2
- aws_cdk/aws_guardduty/__init__.py +86 -0
- aws_cdk/aws_kinesisfirehose/__init__.py +377 -4
- aws_cdk/aws_logs/__init__.py +53 -4
- aws_cdk/aws_mediapackagev2/__init__.py +881 -0
- aws_cdk/aws_omics/__init__.py +13 -10
- aws_cdk/aws_quicksight/__init__.py +111 -4
- aws_cdk/aws_rds/__init__.py +208 -10
- aws_cdk/aws_s3/__init__.py +775 -5
- aws_cdk/aws_s3express/__init__.py +61 -3
- aws_cdk/aws_s3tables/__init__.py +254 -0
- aws_cdk/aws_sagemaker/__init__.py +524 -137
- aws_cdk/aws_ssm/__init__.py +48 -0
- aws_cdk/aws_transfer/__init__.py +49 -0
- aws_cdk/aws_wisdom/__init__.py +1185 -100
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/RECORD +35 -35
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.207.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -23387,7 +23387,7 @@ class CfnGuardrail(
|
|
|
23387
23387
|
:param name: The name of the guardrail.
|
|
23388
23388
|
:param content_policy_config: The content filter policies to configure for the guardrail.
|
|
23389
23389
|
:param contextual_grounding_policy_config: Contextual grounding policy config for a guardrail.
|
|
23390
|
-
:param cross_region_config: The system-defined guardrail profile that you
|
|
23390
|
+
:param cross_region_config: The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
23391
23391
|
:param description: A description of the guardrail.
|
|
23392
23392
|
:param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
|
|
23393
23393
|
:param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
|
|
@@ -23615,7 +23615,7 @@ class CfnGuardrail(
|
|
|
23615
23615
|
def cross_region_config(
|
|
23616
23616
|
self,
|
|
23617
23617
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.GuardrailCrossRegionConfigProperty"]]:
|
|
23618
|
-
'''The system-defined guardrail profile that you
|
|
23618
|
+
'''The system-defined guardrail profile that you're using with your guardrail.'''
|
|
23619
23619
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.GuardrailCrossRegionConfigProperty"]], jsii.get(self, "crossRegionConfig"))
|
|
23620
23620
|
|
|
23621
23621
|
@cross_region_config.setter
|
|
@@ -23766,12 +23766,12 @@ class CfnGuardrail(
|
|
|
23766
23766
|
:param input_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.
|
|
23767
23767
|
:param output_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.
|
|
23768
23768
|
:param type: The harmful category that the content filter is applied to.
|
|
23769
|
-
:param input_action:
|
|
23770
|
-
:param input_enabled:
|
|
23771
|
-
:param input_modalities:
|
|
23772
|
-
:param output_action:
|
|
23773
|
-
:param output_enabled:
|
|
23774
|
-
:param output_modalities:
|
|
23769
|
+
:param input_action: Specifies the action to take when harmful content is detected. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
23770
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23771
|
+
:param input_modalities: The input modalities selected for the guardrail content filter configuration.
|
|
23772
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
23773
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23774
|
+
:param output_modalities: The output modalities selected for the guardrail content filter configuration.
|
|
23775
23775
|
|
|
23776
23776
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html
|
|
23777
23777
|
:exampleMetadata: fixture=_generated
|
|
@@ -23861,7 +23861,11 @@ class CfnGuardrail(
|
|
|
23861
23861
|
|
|
23862
23862
|
@builtins.property
|
|
23863
23863
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
23864
|
-
'''
|
|
23864
|
+
'''Specifies the action to take when harmful content is detected. Supported values include:.
|
|
23865
|
+
|
|
23866
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
23867
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
23868
|
+
|
|
23865
23869
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputaction
|
|
23866
23870
|
'''
|
|
23867
23871
|
result = self._values.get("input_action")
|
|
@@ -23871,7 +23875,10 @@ class CfnGuardrail(
|
|
|
23871
23875
|
def input_enabled(
|
|
23872
23876
|
self,
|
|
23873
23877
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
23874
|
-
'''
|
|
23878
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
23879
|
+
|
|
23880
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23881
|
+
|
|
23875
23882
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputenabled
|
|
23876
23883
|
'''
|
|
23877
23884
|
result = self._values.get("input_enabled")
|
|
@@ -23879,7 +23886,7 @@ class CfnGuardrail(
|
|
|
23879
23886
|
|
|
23880
23887
|
@builtins.property
|
|
23881
23888
|
def input_modalities(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
23882
|
-
'''
|
|
23889
|
+
'''The input modalities selected for the guardrail content filter configuration.
|
|
23883
23890
|
|
|
23884
23891
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputmodalities
|
|
23885
23892
|
'''
|
|
@@ -23888,7 +23895,11 @@ class CfnGuardrail(
|
|
|
23888
23895
|
|
|
23889
23896
|
@builtins.property
|
|
23890
23897
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
23891
|
-
'''
|
|
23898
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
23899
|
+
|
|
23900
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
23901
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
23902
|
+
|
|
23892
23903
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputaction
|
|
23893
23904
|
'''
|
|
23894
23905
|
result = self._values.get("output_action")
|
|
@@ -23898,7 +23909,10 @@ class CfnGuardrail(
|
|
|
23898
23909
|
def output_enabled(
|
|
23899
23910
|
self,
|
|
23900
23911
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
23901
|
-
'''
|
|
23912
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
23913
|
+
|
|
23914
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
23915
|
+
|
|
23902
23916
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputenabled
|
|
23903
23917
|
'''
|
|
23904
23918
|
result = self._values.get("output_enabled")
|
|
@@ -23906,7 +23920,7 @@ class CfnGuardrail(
|
|
|
23906
23920
|
|
|
23907
23921
|
@builtins.property
|
|
23908
23922
|
def output_modalities(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
23909
|
-
'''
|
|
23923
|
+
'''The output modalities selected for the guardrail content filter configuration.
|
|
23910
23924
|
|
|
23911
23925
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputmodalities
|
|
23912
23926
|
'''
|
|
@@ -23931,9 +23945,11 @@ class CfnGuardrail(
|
|
|
23931
23945
|
)
|
|
23932
23946
|
class ContentFiltersTierConfigProperty:
|
|
23933
23947
|
def __init__(self, *, tier_name: builtins.str) -> None:
|
|
23934
|
-
'''
|
|
23948
|
+
'''The tier that your guardrail uses for content filters.
|
|
23949
|
+
|
|
23950
|
+
Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
23935
23951
|
|
|
23936
|
-
:param tier_name:
|
|
23952
|
+
:param tier_name: The tier that your guardrail uses for content filters. Valid values include:. - ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages. - ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
23937
23953
|
|
|
23938
23954
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html
|
|
23939
23955
|
:exampleMetadata: fixture=_generated
|
|
@@ -23957,7 +23973,10 @@ class CfnGuardrail(
|
|
|
23957
23973
|
|
|
23958
23974
|
@builtins.property
|
|
23959
23975
|
def tier_name(self) -> builtins.str:
|
|
23960
|
-
'''
|
|
23976
|
+
'''The tier that your guardrail uses for content filters. Valid values include:.
|
|
23977
|
+
|
|
23978
|
+
- ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
|
|
23979
|
+
- ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
23961
23980
|
|
|
23962
23981
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html#cfn-bedrock-guardrail-contentfilterstierconfig-tiername
|
|
23963
23982
|
'''
|
|
@@ -23994,7 +24013,7 @@ class CfnGuardrail(
|
|
|
23994
24013
|
'''Contains details about how to handle harmful content.
|
|
23995
24014
|
|
|
23996
24015
|
:param filters_config: Contains the type of the content filter and how strongly it should apply to prompts and model responses.
|
|
23997
|
-
:param content_filters_tier_config:
|
|
24016
|
+
:param content_filters_tier_config: The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
23998
24017
|
|
|
23999
24018
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html
|
|
24000
24019
|
:exampleMetadata: fixture=_generated
|
|
@@ -24052,7 +24071,9 @@ class CfnGuardrail(
|
|
|
24052
24071
|
def content_filters_tier_config(
|
|
24053
24072
|
self,
|
|
24054
24073
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ContentFiltersTierConfigProperty"]]:
|
|
24055
|
-
'''
|
|
24074
|
+
'''The tier that your guardrail uses for content filters.
|
|
24075
|
+
|
|
24076
|
+
Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
24056
24077
|
|
|
24057
24078
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html#cfn-bedrock-guardrail-contentpolicyconfig-contentfilterstierconfig
|
|
24058
24079
|
'''
|
|
@@ -24093,8 +24114,8 @@ class CfnGuardrail(
|
|
|
24093
24114
|
|
|
24094
24115
|
:param threshold: The threshold details for the guardrails contextual grounding filter.
|
|
24095
24116
|
:param type: The filter details for the guardrails contextual grounding filter.
|
|
24096
|
-
:param action:
|
|
24097
|
-
:param enabled:
|
|
24117
|
+
:param action: Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24118
|
+
:param enabled: Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24098
24119
|
|
|
24099
24120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html
|
|
24100
24121
|
:exampleMetadata: fixture=_generated
|
|
@@ -24151,7 +24172,11 @@ class CfnGuardrail(
|
|
|
24151
24172
|
|
|
24152
24173
|
@builtins.property
|
|
24153
24174
|
def action(self) -> typing.Optional[builtins.str]:
|
|
24154
|
-
'''
|
|
24175
|
+
'''Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:.
|
|
24176
|
+
|
|
24177
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24178
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24179
|
+
|
|
24155
24180
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action
|
|
24156
24181
|
'''
|
|
24157
24182
|
result = self._values.get("action")
|
|
@@ -24161,7 +24186,10 @@ class CfnGuardrail(
|
|
|
24161
24186
|
def enabled(
|
|
24162
24187
|
self,
|
|
24163
24188
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24164
|
-
'''
|
|
24189
|
+
'''Specifies whether to enable contextual grounding evaluation.
|
|
24190
|
+
|
|
24191
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24192
|
+
|
|
24165
24193
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled
|
|
24166
24194
|
'''
|
|
24167
24195
|
result = self._values.get("enabled")
|
|
@@ -24256,7 +24284,7 @@ class CfnGuardrail(
|
|
|
24256
24284
|
|
|
24257
24285
|
For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
24258
24286
|
|
|
24259
|
-
:param guardrail_profile_arn: The Amazon Resource Name (ARN) of the guardrail profile.
|
|
24287
|
+
:param guardrail_profile_arn: The Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current AWS Region . For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html>`_ .
|
|
24260
24288
|
|
|
24261
24289
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html
|
|
24262
24290
|
:exampleMetadata: fixture=_generated
|
|
@@ -24280,7 +24308,9 @@ class CfnGuardrail(
|
|
|
24280
24308
|
|
|
24281
24309
|
@builtins.property
|
|
24282
24310
|
def guardrail_profile_arn(self) -> builtins.str:
|
|
24283
|
-
'''The Amazon Resource Name (ARN) of the guardrail profile.
|
|
24311
|
+
'''The Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using.
|
|
24312
|
+
|
|
24313
|
+
Guardrail profile availability depends on your current AWS Region . For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html>`_ .
|
|
24284
24314
|
|
|
24285
24315
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html#cfn-bedrock-guardrail-guardrailcrossregionconfig-guardrailprofilearn
|
|
24286
24316
|
'''
|
|
@@ -24323,10 +24353,10 @@ class CfnGuardrail(
|
|
|
24323
24353
|
'''The managed word list to configure for the guardrail.
|
|
24324
24354
|
|
|
24325
24355
|
:param type: The managed word type to configure for the guardrail.
|
|
24326
|
-
:param input_action:
|
|
24327
|
-
:param input_enabled:
|
|
24328
|
-
:param output_action:
|
|
24329
|
-
:param output_enabled:
|
|
24356
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24357
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24358
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24359
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24330
24360
|
|
|
24331
24361
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html
|
|
24332
24362
|
:exampleMetadata: fixture=_generated
|
|
@@ -24378,7 +24408,11 @@ class CfnGuardrail(
|
|
|
24378
24408
|
|
|
24379
24409
|
@builtins.property
|
|
24380
24410
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24381
|
-
'''
|
|
24411
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
24412
|
+
|
|
24413
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24414
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24415
|
+
|
|
24382
24416
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputaction
|
|
24383
24417
|
'''
|
|
24384
24418
|
result = self._values.get("input_action")
|
|
@@ -24388,7 +24422,10 @@ class CfnGuardrail(
|
|
|
24388
24422
|
def input_enabled(
|
|
24389
24423
|
self,
|
|
24390
24424
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24391
|
-
'''
|
|
24425
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
24426
|
+
|
|
24427
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24428
|
+
|
|
24392
24429
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputenabled
|
|
24393
24430
|
'''
|
|
24394
24431
|
result = self._values.get("input_enabled")
|
|
@@ -24396,7 +24433,11 @@ class CfnGuardrail(
|
|
|
24396
24433
|
|
|
24397
24434
|
@builtins.property
|
|
24398
24435
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24399
|
-
'''
|
|
24436
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
24437
|
+
|
|
24438
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24439
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24440
|
+
|
|
24400
24441
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputaction
|
|
24401
24442
|
'''
|
|
24402
24443
|
result = self._values.get("output_action")
|
|
@@ -24406,7 +24447,10 @@ class CfnGuardrail(
|
|
|
24406
24447
|
def output_enabled(
|
|
24407
24448
|
self,
|
|
24408
24449
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24409
|
-
'''
|
|
24450
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
24451
|
+
|
|
24452
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24453
|
+
|
|
24410
24454
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputenabled
|
|
24411
24455
|
'''
|
|
24412
24456
|
result = self._values.get("output_enabled")
|
|
@@ -24450,10 +24494,10 @@ class CfnGuardrail(
|
|
|
24450
24494
|
|
|
24451
24495
|
:param action: Configure guardrail action when the PII entity is detected.
|
|
24452
24496
|
:param 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," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. - *EMAIL* An email address, such as *marymajor@email.com* . - *PHONE* A phone number. This entity type also includes fax and pager numbers. - *USERNAME* A user name that identifies an account, such as a login name, screen name, nick name, or handle. - *PASSWORD* An alphanumeric string that is used as a password, such as "* *very20special#pass** ". - *DRIVER_ID* The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. - *LICENSE_PLATE* A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. - *VEHICLE_IDENTIFICATION_NUMBER* A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - *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* . 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 <https://docs.aws.amazon.com/https://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 <https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/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..
|
|
24453
|
-
:param input_action:
|
|
24454
|
-
:param input_enabled:
|
|
24455
|
-
:param output_action:
|
|
24456
|
-
:param output_enabled:
|
|
24497
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``ANONYMIZE`` – Mask the content and replace it with identifier tags. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24498
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24499
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``ANONYMIZE`` – Mask the content and replace it with identifier tags. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24500
|
+
:param output_enabled: Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24457
24501
|
|
|
24458
24502
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html
|
|
24459
24503
|
:exampleMetadata: fixture=_generated
|
|
@@ -24659,7 +24703,11 @@ class CfnGuardrail(
|
|
|
24659
24703
|
|
|
24660
24704
|
@builtins.property
|
|
24661
24705
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24662
|
-
'''
|
|
24706
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
24707
|
+
|
|
24708
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24709
|
+
- ``ANONYMIZE`` – Mask the content and replace it with identifier tags.
|
|
24710
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24663
24711
|
|
|
24664
24712
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputaction
|
|
24665
24713
|
'''
|
|
@@ -24670,7 +24718,10 @@ class CfnGuardrail(
|
|
|
24670
24718
|
def input_enabled(
|
|
24671
24719
|
self,
|
|
24672
24720
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24673
|
-
'''
|
|
24721
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
24722
|
+
|
|
24723
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24724
|
+
|
|
24674
24725
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputenabled
|
|
24675
24726
|
'''
|
|
24676
24727
|
result = self._values.get("input_enabled")
|
|
@@ -24678,7 +24729,11 @@ class CfnGuardrail(
|
|
|
24678
24729
|
|
|
24679
24730
|
@builtins.property
|
|
24680
24731
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24681
|
-
'''
|
|
24732
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
24733
|
+
|
|
24734
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24735
|
+
- ``ANONYMIZE`` – Mask the content and replace it with identifier tags.
|
|
24736
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24682
24737
|
|
|
24683
24738
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputaction
|
|
24684
24739
|
'''
|
|
@@ -24689,7 +24744,10 @@ class CfnGuardrail(
|
|
|
24689
24744
|
def output_enabled(
|
|
24690
24745
|
self,
|
|
24691
24746
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24692
|
-
'''
|
|
24747
|
+
'''Indicates whether guardrail evaluation is enabled on the output.
|
|
24748
|
+
|
|
24749
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24750
|
+
|
|
24693
24751
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputenabled
|
|
24694
24752
|
'''
|
|
24695
24753
|
result = self._values.get("output_enabled")
|
|
@@ -24739,10 +24797,10 @@ class CfnGuardrail(
|
|
|
24739
24797
|
:param name: The name of the regular expression to configure for the guardrail.
|
|
24740
24798
|
:param pattern: The regular expression pattern to configure for the guardrail.
|
|
24741
24799
|
:param description: The description of the regular expression to configure for the guardrail.
|
|
24742
|
-
:param input_action:
|
|
24743
|
-
:param input_enabled:
|
|
24744
|
-
:param output_action:
|
|
24745
|
-
:param output_enabled:
|
|
24800
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24801
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24802
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
24803
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24746
24804
|
|
|
24747
24805
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html
|
|
24748
24806
|
:exampleMetadata: fixture=_generated
|
|
@@ -24833,7 +24891,10 @@ class CfnGuardrail(
|
|
|
24833
24891
|
|
|
24834
24892
|
@builtins.property
|
|
24835
24893
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24836
|
-
'''
|
|
24894
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
24895
|
+
|
|
24896
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24897
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24837
24898
|
|
|
24838
24899
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputaction
|
|
24839
24900
|
'''
|
|
@@ -24844,7 +24905,10 @@ class CfnGuardrail(
|
|
|
24844
24905
|
def input_enabled(
|
|
24845
24906
|
self,
|
|
24846
24907
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24847
|
-
'''
|
|
24908
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
24909
|
+
|
|
24910
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24911
|
+
|
|
24848
24912
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputenabled
|
|
24849
24913
|
'''
|
|
24850
24914
|
result = self._values.get("input_enabled")
|
|
@@ -24852,7 +24916,10 @@ class CfnGuardrail(
|
|
|
24852
24916
|
|
|
24853
24917
|
@builtins.property
|
|
24854
24918
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24855
|
-
'''
|
|
24919
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
24920
|
+
|
|
24921
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
24922
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
24856
24923
|
|
|
24857
24924
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputaction
|
|
24858
24925
|
'''
|
|
@@ -24863,7 +24930,10 @@ class CfnGuardrail(
|
|
|
24863
24930
|
def output_enabled(
|
|
24864
24931
|
self,
|
|
24865
24932
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24866
|
-
'''
|
|
24933
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
24934
|
+
|
|
24935
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
24936
|
+
|
|
24867
24937
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputenabled
|
|
24868
24938
|
'''
|
|
24869
24939
|
result = self._values.get("output_enabled")
|
|
@@ -25010,10 +25080,10 @@ class CfnGuardrail(
|
|
|
25010
25080
|
:param name: The name of the topic to deny.
|
|
25011
25081
|
:param type: Specifies to deny the topic.
|
|
25012
25082
|
:param examples: A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
|
|
25013
|
-
:param input_action:
|
|
25014
|
-
:param input_enabled:
|
|
25015
|
-
:param output_action:
|
|
25016
|
-
:param output_enabled:
|
|
25083
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25084
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25085
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25086
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25017
25087
|
|
|
25018
25088
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html
|
|
25019
25089
|
:exampleMetadata: fixture=_generated
|
|
@@ -25104,7 +25174,11 @@ class CfnGuardrail(
|
|
|
25104
25174
|
|
|
25105
25175
|
@builtins.property
|
|
25106
25176
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
25107
|
-
'''
|
|
25177
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
25178
|
+
|
|
25179
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25180
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25181
|
+
|
|
25108
25182
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputaction
|
|
25109
25183
|
'''
|
|
25110
25184
|
result = self._values.get("input_action")
|
|
@@ -25114,7 +25188,10 @@ class CfnGuardrail(
|
|
|
25114
25188
|
def input_enabled(
|
|
25115
25189
|
self,
|
|
25116
25190
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25117
|
-
'''
|
|
25191
|
+
'''Specifies whether to enable guardrail evaluation on the input.
|
|
25192
|
+
|
|
25193
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25194
|
+
|
|
25118
25195
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputenabled
|
|
25119
25196
|
'''
|
|
25120
25197
|
result = self._values.get("input_enabled")
|
|
@@ -25122,7 +25199,11 @@ class CfnGuardrail(
|
|
|
25122
25199
|
|
|
25123
25200
|
@builtins.property
|
|
25124
25201
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
25125
|
-
'''
|
|
25202
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
25203
|
+
|
|
25204
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25205
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25206
|
+
|
|
25126
25207
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputaction
|
|
25127
25208
|
'''
|
|
25128
25209
|
result = self._values.get("output_action")
|
|
@@ -25132,7 +25213,10 @@ class CfnGuardrail(
|
|
|
25132
25213
|
def output_enabled(
|
|
25133
25214
|
self,
|
|
25134
25215
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25135
|
-
'''
|
|
25216
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
25217
|
+
|
|
25218
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25219
|
+
|
|
25136
25220
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputenabled
|
|
25137
25221
|
'''
|
|
25138
25222
|
result = self._values.get("output_enabled")
|
|
@@ -25167,7 +25251,7 @@ class CfnGuardrail(
|
|
|
25167
25251
|
'''Contains details about topics that the guardrail should identify and deny.
|
|
25168
25252
|
|
|
25169
25253
|
:param topics_config: A list of policies related to topics that the guardrail should deny.
|
|
25170
|
-
:param topics_tier_config:
|
|
25254
|
+
:param topics_tier_config: The tier that your guardrail uses for denied topic filters.
|
|
25171
25255
|
|
|
25172
25256
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html
|
|
25173
25257
|
:exampleMetadata: fixture=_generated
|
|
@@ -25224,7 +25308,7 @@ class CfnGuardrail(
|
|
|
25224
25308
|
def topics_tier_config(
|
|
25225
25309
|
self,
|
|
25226
25310
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.TopicsTierConfigProperty"]]:
|
|
25227
|
-
'''
|
|
25311
|
+
'''The tier that your guardrail uses for denied topic filters.
|
|
25228
25312
|
|
|
25229
25313
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicstierconfig
|
|
25230
25314
|
'''
|
|
@@ -25249,9 +25333,11 @@ class CfnGuardrail(
|
|
|
25249
25333
|
)
|
|
25250
25334
|
class TopicsTierConfigProperty:
|
|
25251
25335
|
def __init__(self, *, tier_name: builtins.str) -> None:
|
|
25252
|
-
'''
|
|
25336
|
+
'''The tier that your guardrail uses for denied topic filters.
|
|
25253
25337
|
|
|
25254
|
-
|
|
25338
|
+
Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
|
|
25339
|
+
|
|
25340
|
+
:param tier_name: The tier that your guardrail uses for denied topic filters. Valid values include:. - ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages. - ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25255
25341
|
|
|
25256
25342
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html
|
|
25257
25343
|
:exampleMetadata: fixture=_generated
|
|
@@ -25275,7 +25361,10 @@ class CfnGuardrail(
|
|
|
25275
25361
|
|
|
25276
25362
|
@builtins.property
|
|
25277
25363
|
def tier_name(self) -> builtins.str:
|
|
25278
|
-
'''
|
|
25364
|
+
'''The tier that your guardrail uses for denied topic filters. Valid values include:.
|
|
25365
|
+
|
|
25366
|
+
- ``CLASSIC`` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
|
|
25367
|
+
- ``STANDARD`` tier – Provides a more robust solution than the ``CLASSIC`` tier and has more comprehensive language support. This tier requires that your guardrail use `cross-Region inference <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25279
25368
|
|
|
25280
25369
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html#cfn-bedrock-guardrail-topicstierconfig-tiername
|
|
25281
25370
|
'''
|
|
@@ -25318,10 +25407,10 @@ class CfnGuardrail(
|
|
|
25318
25407
|
'''A word to configure for the guardrail.
|
|
25319
25408
|
|
|
25320
25409
|
:param text: Text of the word configured for the guardrail to block.
|
|
25321
|
-
:param input_action:
|
|
25322
|
-
:param input_enabled:
|
|
25323
|
-
:param output_action:
|
|
25324
|
-
:param output_enabled:
|
|
25410
|
+
:param input_action: Specifies the action to take when harmful content is detected in the input. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25411
|
+
:param input_enabled: Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25412
|
+
:param output_action: Specifies the action to take when harmful content is detected in the output. Supported values include:. - ``BLOCK`` – Block the content and replace it with blocked messaging. - ``NONE`` – Take no action but return detection information in the trace response.
|
|
25413
|
+
:param output_enabled: Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25325
25414
|
|
|
25326
25415
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html
|
|
25327
25416
|
:exampleMetadata: fixture=_generated
|
|
@@ -25373,7 +25462,11 @@ class CfnGuardrail(
|
|
|
25373
25462
|
|
|
25374
25463
|
@builtins.property
|
|
25375
25464
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
25376
|
-
'''
|
|
25465
|
+
'''Specifies the action to take when harmful content is detected in the input. Supported values include:.
|
|
25466
|
+
|
|
25467
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25468
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25469
|
+
|
|
25377
25470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputaction
|
|
25378
25471
|
'''
|
|
25379
25472
|
result = self._values.get("input_action")
|
|
@@ -25383,7 +25476,10 @@ class CfnGuardrail(
|
|
|
25383
25476
|
def input_enabled(
|
|
25384
25477
|
self,
|
|
25385
25478
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25386
|
-
'''
|
|
25479
|
+
'''Specifies whether to enable guardrail evaluation on the intput.
|
|
25480
|
+
|
|
25481
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25482
|
+
|
|
25387
25483
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputenabled
|
|
25388
25484
|
'''
|
|
25389
25485
|
result = self._values.get("input_enabled")
|
|
@@ -25391,7 +25487,11 @@ class CfnGuardrail(
|
|
|
25391
25487
|
|
|
25392
25488
|
@builtins.property
|
|
25393
25489
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
25394
|
-
'''
|
|
25490
|
+
'''Specifies the action to take when harmful content is detected in the output. Supported values include:.
|
|
25491
|
+
|
|
25492
|
+
- ``BLOCK`` – Block the content and replace it with blocked messaging.
|
|
25493
|
+
- ``NONE`` – Take no action but return detection information in the trace response.
|
|
25494
|
+
|
|
25395
25495
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputaction
|
|
25396
25496
|
'''
|
|
25397
25497
|
result = self._values.get("output_action")
|
|
@@ -25401,7 +25501,10 @@ class CfnGuardrail(
|
|
|
25401
25501
|
def output_enabled(
|
|
25402
25502
|
self,
|
|
25403
25503
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25404
|
-
'''
|
|
25504
|
+
'''Specifies whether to enable guardrail evaluation on the output.
|
|
25505
|
+
|
|
25506
|
+
When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
|
|
25507
|
+
|
|
25405
25508
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputenabled
|
|
25406
25509
|
'''
|
|
25407
25510
|
result = self._values.get("output_enabled")
|
|
@@ -25554,7 +25657,7 @@ class CfnGuardrailProps:
|
|
|
25554
25657
|
:param name: The name of the guardrail.
|
|
25555
25658
|
:param content_policy_config: The content filter policies to configure for the guardrail.
|
|
25556
25659
|
:param contextual_grounding_policy_config: Contextual grounding policy config for a guardrail.
|
|
25557
|
-
:param cross_region_config: The system-defined guardrail profile that you
|
|
25660
|
+
:param cross_region_config: The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25558
25661
|
:param description: A description of the guardrail.
|
|
25559
25662
|
:param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
|
|
25560
25663
|
:param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
|
|
@@ -25775,7 +25878,11 @@ class CfnGuardrailProps:
|
|
|
25775
25878
|
def cross_region_config(
|
|
25776
25879
|
self,
|
|
25777
25880
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.GuardrailCrossRegionConfigProperty]]:
|
|
25778
|
-
'''The system-defined guardrail profile that you
|
|
25881
|
+
'''The system-defined guardrail profile that you're using with your guardrail.
|
|
25882
|
+
|
|
25883
|
+
Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
|
|
25884
|
+
|
|
25885
|
+
For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
25779
25886
|
|
|
25780
25887
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig
|
|
25781
25888
|
'''
|
|
@@ -36623,6 +36730,18 @@ class FoundationModelIdentifier(
|
|
|
36623
36730
|
'''Base model "stability.stable-image-ultra-v1:1".'''
|
|
36624
36731
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "STABILITY_STABLE_IMAGE_ULTRA_V1_1"))
|
|
36625
36732
|
|
|
36733
|
+
@jsii.python.classproperty
|
|
36734
|
+
@jsii.member(jsii_name="TWELVELABS_MARENGO_EMBED_2_7_V1_0")
|
|
36735
|
+
def TWELVELABS_MARENGO_EMBED_2_7_V1_0(cls) -> "FoundationModelIdentifier":
|
|
36736
|
+
'''Base model "twelvelabs.marengo-embed-2-7-v1:0".'''
|
|
36737
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "TWELVELABS_MARENGO_EMBED_2_7_V1_0"))
|
|
36738
|
+
|
|
36739
|
+
@jsii.python.classproperty
|
|
36740
|
+
@jsii.member(jsii_name="TWELVELABS_PEGASUS_1_2_V1_0")
|
|
36741
|
+
def TWELVELABS_PEGASUS_1_2_V1_0(cls) -> "FoundationModelIdentifier":
|
|
36742
|
+
'''Base model "twelvelabs.pegasus-1-2-v1:0".'''
|
|
36743
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "TWELVELABS_PEGASUS_1_2_V1_0"))
|
|
36744
|
+
|
|
36626
36745
|
@jsii.python.classproperty
|
|
36627
36746
|
@jsii.member(jsii_name="WRITER_PALMYRA_X4_V1_0")
|
|
36628
36747
|
def WRITER_PALMYRA_X4_V1_0(cls) -> "FoundationModelIdentifier":
|