aws-cdk-lib 2.206.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/__init__.py +96 -15
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.206.0.jsii.tgz → aws-cdk-lib@2.208.0.jsii.tgz} +0 -0
- aws_cdk/aws_aiops/__init__.py +70 -76
- aws_cdk/aws_amazonmq/__init__.py +8 -18
- aws_cdk/aws_appstream/__init__.py +36 -4
- aws_cdk/aws_autoscaling/__init__.py +20 -0
- aws_cdk/aws_bedrock/__init__.py +317 -142
- aws_cdk/aws_certificatemanager/__init__.py +48 -3
- aws_cdk/aws_cleanrooms/__init__.py +6 -2
- aws_cdk/aws_cloudformation/__init__.py +28 -15
- aws_cdk/aws_cloudfront/__init__.py +12 -2
- aws_cdk/aws_cloudwatch/__init__.py +574 -33
- aws_cdk/aws_connect/__init__.py +107 -3
- aws_cdk/aws_customerprofiles/__init__.py +27 -22
- aws_cdk/aws_datasync/__init__.py +14 -15
- aws_cdk/aws_docdb/__init__.py +5 -3
- aws_cdk/aws_ec2/__init__.py +59 -13
- aws_cdk/aws_ecs/__init__.py +185 -47
- 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_iotsitewise/__init__.py +13 -9
- aws_cdk/aws_kinesisfirehose/__init__.py +377 -4
- aws_cdk/aws_kms/__init__.py +19 -17
- aws_cdk/aws_logs/__init__.py +4775 -764
- aws_cdk/aws_mediapackagev2/__init__.py +950 -48
- aws_cdk/aws_omics/__init__.py +13 -10
- aws_cdk/aws_opsworkscm/__init__.py +2 -4
- aws_cdk/aws_quicksight/__init__.py +111 -4
- aws_cdk/aws_rds/__init__.py +358 -27
- aws_cdk/aws_s3/__init__.py +781 -8
- aws_cdk/aws_s3express/__init__.py +61 -3
- aws_cdk/aws_s3tables/__init__.py +254 -0
- aws_cdk/aws_sagemaker/__init__.py +527 -140
- aws_cdk/aws_ssm/__init__.py +106 -33
- aws_cdk/aws_transfer/__init__.py +70 -11
- aws_cdk/aws_wisdom/__init__.py +1185 -100
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/RECORD +44 -44
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.208.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -12743,9 +12743,11 @@ class CfnFlow(
|
|
|
12743
12743
|
)
|
|
12744
12744
|
class FieldForRerankingProperty:
|
|
12745
12745
|
def __init__(self, *, field_name: builtins.str) -> None:
|
|
12746
|
-
'''
|
|
12746
|
+
'''Specifies a field to be used during the reranking process in a Knowledge Base vector search.
|
|
12747
12747
|
|
|
12748
|
-
|
|
12748
|
+
This structure identifies metadata fields that should be considered when reordering search results to improve relevance.
|
|
12749
|
+
|
|
12750
|
+
:param field_name: The name of the metadata field to be used during the reranking process.
|
|
12749
12751
|
|
|
12750
12752
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-fieldforreranking.html
|
|
12751
12753
|
:exampleMetadata: fixture=_generated
|
|
@@ -12769,7 +12771,7 @@ class CfnFlow(
|
|
|
12769
12771
|
|
|
12770
12772
|
@builtins.property
|
|
12771
12773
|
def field_name(self) -> builtins.str:
|
|
12772
|
-
'''The name of
|
|
12774
|
+
'''The name of the metadata field to be used during the reranking process.
|
|
12773
12775
|
|
|
12774
12776
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-fieldforreranking.html#cfn-bedrock-flow-fieldforreranking-fieldname
|
|
12775
12777
|
'''
|
|
@@ -15652,10 +15654,12 @@ class CfnFlow(
|
|
|
15652
15654
|
selection_mode: builtins.str,
|
|
15653
15655
|
selective_mode_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
15654
15656
|
) -> None:
|
|
15655
|
-
'''
|
|
15657
|
+
'''Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches.
|
|
15658
|
+
|
|
15659
|
+
This determines which metadata fields are included or excluded when reordering search results.
|
|
15656
15660
|
|
|
15657
|
-
:param selection_mode:
|
|
15658
|
-
:param selective_mode_configuration:
|
|
15661
|
+
:param selection_mode: The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
15662
|
+
:param selective_mode_configuration: Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.
|
|
15659
15663
|
|
|
15660
15664
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html
|
|
15661
15665
|
:exampleMetadata: fixture=_generated
|
|
@@ -15692,9 +15696,9 @@ class CfnFlow(
|
|
|
15692
15696
|
|
|
15693
15697
|
@builtins.property
|
|
15694
15698
|
def selection_mode(self) -> builtins.str:
|
|
15695
|
-
'''
|
|
15699
|
+
'''The mode for selecting which metadata fields to include in the reranking process.
|
|
15696
15700
|
|
|
15697
|
-
|
|
15701
|
+
Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
15698
15702
|
|
|
15699
15703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html#cfn-bedrock-flow-metadataconfigurationforreranking-selectionmode
|
|
15700
15704
|
'''
|
|
@@ -15706,7 +15710,9 @@ class CfnFlow(
|
|
|
15706
15710
|
def selective_mode_configuration(
|
|
15707
15711
|
self,
|
|
15708
15712
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty"]]:
|
|
15709
|
-
'''
|
|
15713
|
+
'''Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.
|
|
15714
|
+
|
|
15715
|
+
This is only used when selectionMode is set to SELECTIVE.
|
|
15710
15716
|
|
|
15711
15717
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html#cfn-bedrock-flow-metadataconfigurationforreranking-selectivemodeconfiguration
|
|
15712
15718
|
'''
|
|
@@ -16472,12 +16478,12 @@ class CfnFlow(
|
|
|
16472
16478
|
fields_to_exclude: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
16473
16479
|
fields_to_include: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
16474
16480
|
) -> None:
|
|
16475
|
-
'''
|
|
16481
|
+
'''Configuration for selectively including or excluding metadata fields during the reranking process.
|
|
16476
16482
|
|
|
16477
|
-
|
|
16483
|
+
This allows you to control which metadata attributes are considered when reordering search results.
|
|
16478
16484
|
|
|
16479
|
-
:param fields_to_exclude:
|
|
16480
|
-
:param fields_to_include:
|
|
16485
|
+
:param fields_to_exclude: A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
16486
|
+
:param fields_to_include: A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
16481
16487
|
|
|
16482
16488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html
|
|
16483
16489
|
:exampleMetadata: fixture=_generated
|
|
@@ -16511,7 +16517,9 @@ class CfnFlow(
|
|
|
16511
16517
|
def fields_to_exclude(
|
|
16512
16518
|
self,
|
|
16513
16519
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlow.FieldForRerankingProperty"]]]]:
|
|
16514
|
-
'''
|
|
16520
|
+
'''A list of metadata field names to explicitly exclude from the reranking process.
|
|
16521
|
+
|
|
16522
|
+
All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
16515
16523
|
|
|
16516
16524
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoexclude
|
|
16517
16525
|
'''
|
|
@@ -16522,9 +16530,9 @@ class CfnFlow(
|
|
|
16522
16530
|
def fields_to_include(
|
|
16523
16531
|
self,
|
|
16524
16532
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlow.FieldForRerankingProperty"]]]]:
|
|
16525
|
-
'''
|
|
16533
|
+
'''A list of metadata field names to explicitly include in the reranking process.
|
|
16526
16534
|
|
|
16527
|
-
|
|
16535
|
+
Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
16528
16536
|
|
|
16529
16537
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoinclude
|
|
16530
16538
|
'''
|
|
@@ -17076,11 +17084,13 @@ class CfnFlow(
|
|
|
17076
17084
|
metadata_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.MetadataConfigurationForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
17077
17085
|
number_of_reranked_results: typing.Optional[jsii.Number] = None,
|
|
17078
17086
|
) -> None:
|
|
17079
|
-
'''
|
|
17087
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results.
|
|
17080
17088
|
|
|
17081
|
-
|
|
17082
|
-
|
|
17083
|
-
:param
|
|
17089
|
+
This enables more sophisticated relevance ranking using large language models.
|
|
17090
|
+
|
|
17091
|
+
:param model_configuration: Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.
|
|
17092
|
+
:param metadata_configuration: Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.
|
|
17093
|
+
:param number_of_reranked_results: The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
17084
17094
|
|
|
17085
17095
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html
|
|
17086
17096
|
:exampleMetadata: fixture=_generated
|
|
@@ -17135,7 +17145,9 @@ class CfnFlow(
|
|
|
17135
17145
|
def model_configuration(
|
|
17136
17146
|
self,
|
|
17137
17147
|
) -> typing.Union[_IResolvable_da3f097b, "CfnFlow.VectorSearchBedrockRerankingModelConfigurationProperty"]:
|
|
17138
|
-
'''
|
|
17148
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking.
|
|
17149
|
+
|
|
17150
|
+
This includes the model ARN and any additional request fields required by the model.
|
|
17139
17151
|
|
|
17140
17152
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-modelconfiguration
|
|
17141
17153
|
'''
|
|
@@ -17147,7 +17159,9 @@ class CfnFlow(
|
|
|
17147
17159
|
def metadata_configuration(
|
|
17148
17160
|
self,
|
|
17149
17161
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlow.MetadataConfigurationForRerankingProperty"]]:
|
|
17150
|
-
'''
|
|
17162
|
+
'''Configuration for how document metadata should be used during the reranking process.
|
|
17163
|
+
|
|
17164
|
+
This determines which metadata fields are included when reordering search results.
|
|
17151
17165
|
|
|
17152
17166
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-metadataconfiguration
|
|
17153
17167
|
'''
|
|
@@ -17156,7 +17170,9 @@ class CfnFlow(
|
|
|
17156
17170
|
|
|
17157
17171
|
@builtins.property
|
|
17158
17172
|
def number_of_reranked_results(self) -> typing.Optional[jsii.Number]:
|
|
17159
|
-
'''The number of results to
|
|
17173
|
+
'''The maximum number of results to rerank.
|
|
17174
|
+
|
|
17175
|
+
This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
17160
17176
|
|
|
17161
17177
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults
|
|
17162
17178
|
'''
|
|
@@ -17189,10 +17205,12 @@ class CfnFlow(
|
|
|
17189
17205
|
model_arn: builtins.str,
|
|
17190
17206
|
additional_model_request_fields: typing.Any = None,
|
|
17191
17207
|
) -> None:
|
|
17192
|
-
'''
|
|
17208
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking vector search results.
|
|
17209
|
+
|
|
17210
|
+
This specifies which model to use and any additional parameters required by the model.
|
|
17193
17211
|
|
|
17194
|
-
:param model_arn: The ARN of the
|
|
17195
|
-
:param additional_model_request_fields: A
|
|
17212
|
+
:param model_arn: The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.
|
|
17213
|
+
:param additional_model_request_fields: A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.
|
|
17196
17214
|
|
|
17197
17215
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html
|
|
17198
17216
|
:exampleMetadata: fixture=_generated
|
|
@@ -17224,7 +17242,9 @@ class CfnFlow(
|
|
|
17224
17242
|
|
|
17225
17243
|
@builtins.property
|
|
17226
17244
|
def model_arn(self) -> builtins.str:
|
|
17227
|
-
'''The ARN of the
|
|
17245
|
+
'''The Amazon Resource Name (ARN) of the foundation model to use for reranking.
|
|
17246
|
+
|
|
17247
|
+
This model processes the query and search results to determine a more relevant ordering.
|
|
17228
17248
|
|
|
17229
17249
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-modelarn
|
|
17230
17250
|
'''
|
|
@@ -17234,7 +17254,9 @@ class CfnFlow(
|
|
|
17234
17254
|
|
|
17235
17255
|
@builtins.property
|
|
17236
17256
|
def additional_model_request_fields(self) -> typing.Any:
|
|
17237
|
-
'''A
|
|
17257
|
+
'''A list of additional fields to include in the model request during reranking.
|
|
17258
|
+
|
|
17259
|
+
These fields provide extra context or configuration options specific to the selected foundation model.
|
|
17238
17260
|
|
|
17239
17261
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields
|
|
17240
17262
|
'''
|
|
@@ -17267,10 +17289,12 @@ class CfnFlow(
|
|
|
17267
17289
|
type: builtins.str,
|
|
17268
17290
|
bedrock_reranking_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.VectorSearchBedrockRerankingConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
17269
17291
|
) -> None:
|
|
17270
|
-
'''
|
|
17292
|
+
'''Configuration for reranking vector search results to improve relevance.
|
|
17271
17293
|
|
|
17272
|
-
|
|
17273
|
-
|
|
17294
|
+
Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.
|
|
17295
|
+
|
|
17296
|
+
:param type: The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
17297
|
+
:param bedrock_reranking_configuration: Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.
|
|
17274
17298
|
|
|
17275
17299
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html
|
|
17276
17300
|
:exampleMetadata: fixture=_generated
|
|
@@ -17325,7 +17349,9 @@ class CfnFlow(
|
|
|
17325
17349
|
|
|
17326
17350
|
@builtins.property
|
|
17327
17351
|
def type(self) -> builtins.str:
|
|
17328
|
-
'''The type of
|
|
17352
|
+
'''The type of reranking to apply to vector search results.
|
|
17353
|
+
|
|
17354
|
+
Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
17329
17355
|
|
|
17330
17356
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-type
|
|
17331
17357
|
'''
|
|
@@ -17337,7 +17363,9 @@ class CfnFlow(
|
|
|
17337
17363
|
def bedrock_reranking_configuration(
|
|
17338
17364
|
self,
|
|
17339
17365
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlow.VectorSearchBedrockRerankingConfigurationProperty"]]:
|
|
17340
|
-
'''
|
|
17366
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank search results.
|
|
17367
|
+
|
|
17368
|
+
This is required when the reranking type is set to BEDROCK.
|
|
17341
17369
|
|
|
17342
17370
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration
|
|
17343
17371
|
'''
|
|
@@ -18662,9 +18690,11 @@ class CfnFlowVersion(
|
|
|
18662
18690
|
)
|
|
18663
18691
|
class FieldForRerankingProperty:
|
|
18664
18692
|
def __init__(self, *, field_name: builtins.str) -> None:
|
|
18665
|
-
'''
|
|
18693
|
+
'''Specifies a field to be used during the reranking process in a Knowledge Base vector search.
|
|
18666
18694
|
|
|
18667
|
-
|
|
18695
|
+
This structure identifies metadata fields that should be considered when reordering search results to improve relevance.
|
|
18696
|
+
|
|
18697
|
+
:param field_name: The name of the metadata field to be used during the reranking process.
|
|
18668
18698
|
|
|
18669
18699
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-fieldforreranking.html
|
|
18670
18700
|
:exampleMetadata: fixture=_generated
|
|
@@ -18688,7 +18718,7 @@ class CfnFlowVersion(
|
|
|
18688
18718
|
|
|
18689
18719
|
@builtins.property
|
|
18690
18720
|
def field_name(self) -> builtins.str:
|
|
18691
|
-
'''The name of
|
|
18721
|
+
'''The name of the metadata field to be used during the reranking process.
|
|
18692
18722
|
|
|
18693
18723
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-fieldforreranking.html#cfn-bedrock-flowversion-fieldforreranking-fieldname
|
|
18694
18724
|
'''
|
|
@@ -21476,10 +21506,12 @@ class CfnFlowVersion(
|
|
|
21476
21506
|
selection_mode: builtins.str,
|
|
21477
21507
|
selective_mode_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
21478
21508
|
) -> None:
|
|
21479
|
-
'''
|
|
21509
|
+
'''Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches.
|
|
21510
|
+
|
|
21511
|
+
This determines which metadata fields are included or excluded when reordering search results.
|
|
21480
21512
|
|
|
21481
|
-
:param selection_mode:
|
|
21482
|
-
:param selective_mode_configuration:
|
|
21513
|
+
:param selection_mode: The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
21514
|
+
:param selective_mode_configuration: Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.
|
|
21483
21515
|
|
|
21484
21516
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html
|
|
21485
21517
|
:exampleMetadata: fixture=_generated
|
|
@@ -21516,9 +21548,9 @@ class CfnFlowVersion(
|
|
|
21516
21548
|
|
|
21517
21549
|
@builtins.property
|
|
21518
21550
|
def selection_mode(self) -> builtins.str:
|
|
21519
|
-
'''
|
|
21551
|
+
'''The mode for selecting which metadata fields to include in the reranking process.
|
|
21520
21552
|
|
|
21521
|
-
|
|
21553
|
+
Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
21522
21554
|
|
|
21523
21555
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectionmode
|
|
21524
21556
|
'''
|
|
@@ -21530,7 +21562,9 @@ class CfnFlowVersion(
|
|
|
21530
21562
|
def selective_mode_configuration(
|
|
21531
21563
|
self,
|
|
21532
21564
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty"]]:
|
|
21533
|
-
'''
|
|
21565
|
+
'''Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.
|
|
21566
|
+
|
|
21567
|
+
This is only used when selectionMode is set to SELECTIVE.
|
|
21534
21568
|
|
|
21535
21569
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectivemodeconfiguration
|
|
21536
21570
|
'''
|
|
@@ -22296,12 +22330,12 @@ class CfnFlowVersion(
|
|
|
22296
22330
|
fields_to_exclude: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
22297
22331
|
fields_to_include: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
22298
22332
|
) -> None:
|
|
22299
|
-
'''
|
|
22333
|
+
'''Configuration for selectively including or excluding metadata fields during the reranking process.
|
|
22300
22334
|
|
|
22301
|
-
|
|
22335
|
+
This allows you to control which metadata attributes are considered when reordering search results.
|
|
22302
22336
|
|
|
22303
|
-
:param fields_to_exclude:
|
|
22304
|
-
:param fields_to_include:
|
|
22337
|
+
:param fields_to_exclude: A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
22338
|
+
:param fields_to_include: A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
22305
22339
|
|
|
22306
22340
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html
|
|
22307
22341
|
:exampleMetadata: fixture=_generated
|
|
@@ -22335,7 +22369,9 @@ class CfnFlowVersion(
|
|
|
22335
22369
|
def fields_to_exclude(
|
|
22336
22370
|
self,
|
|
22337
22371
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.FieldForRerankingProperty"]]]]:
|
|
22338
|
-
'''
|
|
22372
|
+
'''A list of metadata field names to explicitly exclude from the reranking process.
|
|
22373
|
+
|
|
22374
|
+
All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
22339
22375
|
|
|
22340
22376
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoexclude
|
|
22341
22377
|
'''
|
|
@@ -22346,9 +22382,9 @@ class CfnFlowVersion(
|
|
|
22346
22382
|
def fields_to_include(
|
|
22347
22383
|
self,
|
|
22348
22384
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.FieldForRerankingProperty"]]]]:
|
|
22349
|
-
'''
|
|
22385
|
+
'''A list of metadata field names to explicitly include in the reranking process.
|
|
22350
22386
|
|
|
22351
|
-
|
|
22387
|
+
Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
22352
22388
|
|
|
22353
22389
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoinclude
|
|
22354
22390
|
'''
|
|
@@ -22812,11 +22848,13 @@ class CfnFlowVersion(
|
|
|
22812
22848
|
metadata_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.MetadataConfigurationForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
22813
22849
|
number_of_reranked_results: typing.Optional[jsii.Number] = None,
|
|
22814
22850
|
) -> None:
|
|
22815
|
-
'''
|
|
22851
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results.
|
|
22816
22852
|
|
|
22817
|
-
|
|
22818
|
-
|
|
22819
|
-
:param
|
|
22853
|
+
This enables more sophisticated relevance ranking using large language models.
|
|
22854
|
+
|
|
22855
|
+
:param model_configuration: Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.
|
|
22856
|
+
:param metadata_configuration: Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.
|
|
22857
|
+
:param number_of_reranked_results: The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
22820
22858
|
|
|
22821
22859
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html
|
|
22822
22860
|
:exampleMetadata: fixture=_generated
|
|
@@ -22871,7 +22909,9 @@ class CfnFlowVersion(
|
|
|
22871
22909
|
def model_configuration(
|
|
22872
22910
|
self,
|
|
22873
22911
|
) -> typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty"]:
|
|
22874
|
-
'''
|
|
22912
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking.
|
|
22913
|
+
|
|
22914
|
+
This includes the model ARN and any additional request fields required by the model.
|
|
22875
22915
|
|
|
22876
22916
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-modelconfiguration
|
|
22877
22917
|
'''
|
|
@@ -22883,7 +22923,9 @@ class CfnFlowVersion(
|
|
|
22883
22923
|
def metadata_configuration(
|
|
22884
22924
|
self,
|
|
22885
22925
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.MetadataConfigurationForRerankingProperty"]]:
|
|
22886
|
-
'''
|
|
22926
|
+
'''Configuration for how document metadata should be used during the reranking process.
|
|
22927
|
+
|
|
22928
|
+
This determines which metadata fields are included when reordering search results.
|
|
22887
22929
|
|
|
22888
22930
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-metadataconfiguration
|
|
22889
22931
|
'''
|
|
@@ -22892,7 +22934,9 @@ class CfnFlowVersion(
|
|
|
22892
22934
|
|
|
22893
22935
|
@builtins.property
|
|
22894
22936
|
def number_of_reranked_results(self) -> typing.Optional[jsii.Number]:
|
|
22895
|
-
'''The number of results to
|
|
22937
|
+
'''The maximum number of results to rerank.
|
|
22938
|
+
|
|
22939
|
+
This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
22896
22940
|
|
|
22897
22941
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults
|
|
22898
22942
|
'''
|
|
@@ -22925,10 +22969,12 @@ class CfnFlowVersion(
|
|
|
22925
22969
|
model_arn: builtins.str,
|
|
22926
22970
|
additional_model_request_fields: typing.Any = None,
|
|
22927
22971
|
) -> None:
|
|
22928
|
-
'''
|
|
22972
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking vector search results.
|
|
22973
|
+
|
|
22974
|
+
This specifies which model to use and any additional parameters required by the model.
|
|
22929
22975
|
|
|
22930
|
-
:param model_arn: The ARN of the
|
|
22931
|
-
:param additional_model_request_fields: A
|
|
22976
|
+
:param model_arn: The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.
|
|
22977
|
+
:param additional_model_request_fields: A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.
|
|
22932
22978
|
|
|
22933
22979
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html
|
|
22934
22980
|
:exampleMetadata: fixture=_generated
|
|
@@ -22960,7 +23006,9 @@ class CfnFlowVersion(
|
|
|
22960
23006
|
|
|
22961
23007
|
@builtins.property
|
|
22962
23008
|
def model_arn(self) -> builtins.str:
|
|
22963
|
-
'''The ARN of the
|
|
23009
|
+
'''The Amazon Resource Name (ARN) of the foundation model to use for reranking.
|
|
23010
|
+
|
|
23011
|
+
This model processes the query and search results to determine a more relevant ordering.
|
|
22964
23012
|
|
|
22965
23013
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-modelarn
|
|
22966
23014
|
'''
|
|
@@ -22970,7 +23018,9 @@ class CfnFlowVersion(
|
|
|
22970
23018
|
|
|
22971
23019
|
@builtins.property
|
|
22972
23020
|
def additional_model_request_fields(self) -> typing.Any:
|
|
22973
|
-
'''A
|
|
23021
|
+
'''A list of additional fields to include in the model request during reranking.
|
|
23022
|
+
|
|
23023
|
+
These fields provide extra context or configuration options specific to the selected foundation model.
|
|
22974
23024
|
|
|
22975
23025
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields
|
|
22976
23026
|
'''
|
|
@@ -23003,10 +23053,12 @@ class CfnFlowVersion(
|
|
|
23003
23053
|
type: builtins.str,
|
|
23004
23054
|
bedrock_reranking_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
23005
23055
|
) -> None:
|
|
23006
|
-
'''
|
|
23056
|
+
'''Configuration for reranking vector search results to improve relevance.
|
|
23007
23057
|
|
|
23008
|
-
|
|
23009
|
-
|
|
23058
|
+
Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.
|
|
23059
|
+
|
|
23060
|
+
:param type: The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
23061
|
+
:param bedrock_reranking_configuration: Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.
|
|
23010
23062
|
|
|
23011
23063
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html
|
|
23012
23064
|
:exampleMetadata: fixture=_generated
|
|
@@ -23061,7 +23113,9 @@ class CfnFlowVersion(
|
|
|
23061
23113
|
|
|
23062
23114
|
@builtins.property
|
|
23063
23115
|
def type(self) -> builtins.str:
|
|
23064
|
-
'''The type of
|
|
23116
|
+
'''The type of reranking to apply to vector search results.
|
|
23117
|
+
|
|
23118
|
+
Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
23065
23119
|
|
|
23066
23120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-type
|
|
23067
23121
|
'''
|
|
@@ -23073,7 +23127,9 @@ class CfnFlowVersion(
|
|
|
23073
23127
|
def bedrock_reranking_configuration(
|
|
23074
23128
|
self,
|
|
23075
23129
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty"]]:
|
|
23076
|
-
'''
|
|
23130
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank search results.
|
|
23131
|
+
|
|
23132
|
+
This is required when the reranking type is set to BEDROCK.
|
|
23077
23133
|
|
|
23078
23134
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration
|
|
23079
23135
|
'''
|
|
@@ -23331,7 +23387,7 @@ class CfnGuardrail(
|
|
|
23331
23387
|
:param name: The name of the guardrail.
|
|
23332
23388
|
:param content_policy_config: The content filter policies to configure for the guardrail.
|
|
23333
23389
|
:param contextual_grounding_policy_config: Contextual grounding policy config for a guardrail.
|
|
23334
|
-
: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>`_ .
|
|
23335
23391
|
:param description: A description of the guardrail.
|
|
23336
23392
|
:param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
|
|
23337
23393
|
:param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
|
|
@@ -23559,7 +23615,7 @@ class CfnGuardrail(
|
|
|
23559
23615
|
def cross_region_config(
|
|
23560
23616
|
self,
|
|
23561
23617
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.GuardrailCrossRegionConfigProperty"]]:
|
|
23562
|
-
'''The system-defined guardrail profile that you
|
|
23618
|
+
'''The system-defined guardrail profile that you're using with your guardrail.'''
|
|
23563
23619
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.GuardrailCrossRegionConfigProperty"]], jsii.get(self, "crossRegionConfig"))
|
|
23564
23620
|
|
|
23565
23621
|
@cross_region_config.setter
|
|
@@ -23710,12 +23766,12 @@ class CfnGuardrail(
|
|
|
23710
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.
|
|
23711
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.
|
|
23712
23768
|
:param type: The harmful category that the content filter is applied to.
|
|
23713
|
-
:param input_action:
|
|
23714
|
-
:param input_enabled:
|
|
23715
|
-
:param input_modalities:
|
|
23716
|
-
:param output_action:
|
|
23717
|
-
:param output_enabled:
|
|
23718
|
-
: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.
|
|
23719
23775
|
|
|
23720
23776
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html
|
|
23721
23777
|
:exampleMetadata: fixture=_generated
|
|
@@ -23805,7 +23861,11 @@ class CfnGuardrail(
|
|
|
23805
23861
|
|
|
23806
23862
|
@builtins.property
|
|
23807
23863
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
23808
|
-
'''
|
|
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
|
+
|
|
23809
23869
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputaction
|
|
23810
23870
|
'''
|
|
23811
23871
|
result = self._values.get("input_action")
|
|
@@ -23815,7 +23875,10 @@ class CfnGuardrail(
|
|
|
23815
23875
|
def input_enabled(
|
|
23816
23876
|
self,
|
|
23817
23877
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
23818
|
-
'''
|
|
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
|
+
|
|
23819
23882
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputenabled
|
|
23820
23883
|
'''
|
|
23821
23884
|
result = self._values.get("input_enabled")
|
|
@@ -23823,7 +23886,7 @@ class CfnGuardrail(
|
|
|
23823
23886
|
|
|
23824
23887
|
@builtins.property
|
|
23825
23888
|
def input_modalities(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
23826
|
-
'''
|
|
23889
|
+
'''The input modalities selected for the guardrail content filter configuration.
|
|
23827
23890
|
|
|
23828
23891
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputmodalities
|
|
23829
23892
|
'''
|
|
@@ -23832,7 +23895,11 @@ class CfnGuardrail(
|
|
|
23832
23895
|
|
|
23833
23896
|
@builtins.property
|
|
23834
23897
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
23835
|
-
'''
|
|
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
|
+
|
|
23836
23903
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputaction
|
|
23837
23904
|
'''
|
|
23838
23905
|
result = self._values.get("output_action")
|
|
@@ -23842,7 +23909,10 @@ class CfnGuardrail(
|
|
|
23842
23909
|
def output_enabled(
|
|
23843
23910
|
self,
|
|
23844
23911
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
23845
|
-
'''
|
|
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
|
+
|
|
23846
23916
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputenabled
|
|
23847
23917
|
'''
|
|
23848
23918
|
result = self._values.get("output_enabled")
|
|
@@ -23850,7 +23920,7 @@ class CfnGuardrail(
|
|
|
23850
23920
|
|
|
23851
23921
|
@builtins.property
|
|
23852
23922
|
def output_modalities(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
23853
|
-
'''
|
|
23923
|
+
'''The output modalities selected for the guardrail content filter configuration.
|
|
23854
23924
|
|
|
23855
23925
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputmodalities
|
|
23856
23926
|
'''
|
|
@@ -23875,9 +23945,11 @@ class CfnGuardrail(
|
|
|
23875
23945
|
)
|
|
23876
23946
|
class ContentFiltersTierConfigProperty:
|
|
23877
23947
|
def __init__(self, *, tier_name: builtins.str) -> None:
|
|
23878
|
-
'''
|
|
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.
|
|
23879
23951
|
|
|
23880
|
-
: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>`_ .
|
|
23881
23953
|
|
|
23882
23954
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html
|
|
23883
23955
|
:exampleMetadata: fixture=_generated
|
|
@@ -23901,7 +23973,10 @@ class CfnGuardrail(
|
|
|
23901
23973
|
|
|
23902
23974
|
@builtins.property
|
|
23903
23975
|
def tier_name(self) -> builtins.str:
|
|
23904
|
-
'''
|
|
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>`_ .
|
|
23905
23980
|
|
|
23906
23981
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html#cfn-bedrock-guardrail-contentfilterstierconfig-tiername
|
|
23907
23982
|
'''
|
|
@@ -23938,7 +24013,7 @@ class CfnGuardrail(
|
|
|
23938
24013
|
'''Contains details about how to handle harmful content.
|
|
23939
24014
|
|
|
23940
24015
|
:param filters_config: Contains the type of the content filter and how strongly it should apply to prompts and model responses.
|
|
23941
|
-
: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.
|
|
23942
24017
|
|
|
23943
24018
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html
|
|
23944
24019
|
:exampleMetadata: fixture=_generated
|
|
@@ -23996,7 +24071,9 @@ class CfnGuardrail(
|
|
|
23996
24071
|
def content_filters_tier_config(
|
|
23997
24072
|
self,
|
|
23998
24073
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.ContentFiltersTierConfigProperty"]]:
|
|
23999
|
-
'''
|
|
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.
|
|
24000
24077
|
|
|
24001
24078
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html#cfn-bedrock-guardrail-contentpolicyconfig-contentfilterstierconfig
|
|
24002
24079
|
'''
|
|
@@ -24037,8 +24114,8 @@ class CfnGuardrail(
|
|
|
24037
24114
|
|
|
24038
24115
|
:param threshold: The threshold details for the guardrails contextual grounding filter.
|
|
24039
24116
|
:param type: The filter details for the guardrails contextual grounding filter.
|
|
24040
|
-
:param action:
|
|
24041
|
-
: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.
|
|
24042
24119
|
|
|
24043
24120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html
|
|
24044
24121
|
:exampleMetadata: fixture=_generated
|
|
@@ -24095,7 +24172,11 @@ class CfnGuardrail(
|
|
|
24095
24172
|
|
|
24096
24173
|
@builtins.property
|
|
24097
24174
|
def action(self) -> typing.Optional[builtins.str]:
|
|
24098
|
-
'''
|
|
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
|
+
|
|
24099
24180
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action
|
|
24100
24181
|
'''
|
|
24101
24182
|
result = self._values.get("action")
|
|
@@ -24105,7 +24186,10 @@ class CfnGuardrail(
|
|
|
24105
24186
|
def enabled(
|
|
24106
24187
|
self,
|
|
24107
24188
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24108
|
-
'''
|
|
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
|
+
|
|
24109
24193
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled
|
|
24110
24194
|
'''
|
|
24111
24195
|
result = self._values.get("enabled")
|
|
@@ -24200,7 +24284,7 @@ class CfnGuardrail(
|
|
|
24200
24284
|
|
|
24201
24285
|
For more information, see the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html>`_ .
|
|
24202
24286
|
|
|
24203
|
-
: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>`_ .
|
|
24204
24288
|
|
|
24205
24289
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html
|
|
24206
24290
|
:exampleMetadata: fixture=_generated
|
|
@@ -24224,7 +24308,9 @@ class CfnGuardrail(
|
|
|
24224
24308
|
|
|
24225
24309
|
@builtins.property
|
|
24226
24310
|
def guardrail_profile_arn(self) -> builtins.str:
|
|
24227
|
-
'''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>`_ .
|
|
24228
24314
|
|
|
24229
24315
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html#cfn-bedrock-guardrail-guardrailcrossregionconfig-guardrailprofilearn
|
|
24230
24316
|
'''
|
|
@@ -24267,10 +24353,10 @@ class CfnGuardrail(
|
|
|
24267
24353
|
'''The managed word list to configure for the guardrail.
|
|
24268
24354
|
|
|
24269
24355
|
:param type: The managed word type to configure for the guardrail.
|
|
24270
|
-
:param input_action:
|
|
24271
|
-
:param input_enabled:
|
|
24272
|
-
:param output_action:
|
|
24273
|
-
: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.
|
|
24274
24360
|
|
|
24275
24361
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html
|
|
24276
24362
|
:exampleMetadata: fixture=_generated
|
|
@@ -24322,7 +24408,11 @@ class CfnGuardrail(
|
|
|
24322
24408
|
|
|
24323
24409
|
@builtins.property
|
|
24324
24410
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24325
|
-
'''
|
|
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
|
+
|
|
24326
24416
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputaction
|
|
24327
24417
|
'''
|
|
24328
24418
|
result = self._values.get("input_action")
|
|
@@ -24332,7 +24422,10 @@ class CfnGuardrail(
|
|
|
24332
24422
|
def input_enabled(
|
|
24333
24423
|
self,
|
|
24334
24424
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24335
|
-
'''
|
|
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
|
+
|
|
24336
24429
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputenabled
|
|
24337
24430
|
'''
|
|
24338
24431
|
result = self._values.get("input_enabled")
|
|
@@ -24340,7 +24433,11 @@ class CfnGuardrail(
|
|
|
24340
24433
|
|
|
24341
24434
|
@builtins.property
|
|
24342
24435
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24343
|
-
'''
|
|
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
|
+
|
|
24344
24441
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputaction
|
|
24345
24442
|
'''
|
|
24346
24443
|
result = self._values.get("output_action")
|
|
@@ -24350,7 +24447,10 @@ class CfnGuardrail(
|
|
|
24350
24447
|
def output_enabled(
|
|
24351
24448
|
self,
|
|
24352
24449
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24353
|
-
'''
|
|
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
|
+
|
|
24354
24454
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputenabled
|
|
24355
24455
|
'''
|
|
24356
24456
|
result = self._values.get("output_enabled")
|
|
@@ -24394,10 +24494,10 @@ class CfnGuardrail(
|
|
|
24394
24494
|
|
|
24395
24495
|
:param action: Configure guardrail action when the PII entity is detected.
|
|
24396
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..
|
|
24397
|
-
:param input_action:
|
|
24398
|
-
:param input_enabled:
|
|
24399
|
-
:param output_action:
|
|
24400
|
-
: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.
|
|
24401
24501
|
|
|
24402
24502
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html
|
|
24403
24503
|
:exampleMetadata: fixture=_generated
|
|
@@ -24603,7 +24703,11 @@ class CfnGuardrail(
|
|
|
24603
24703
|
|
|
24604
24704
|
@builtins.property
|
|
24605
24705
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24606
|
-
'''
|
|
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.
|
|
24607
24711
|
|
|
24608
24712
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputaction
|
|
24609
24713
|
'''
|
|
@@ -24614,7 +24718,10 @@ class CfnGuardrail(
|
|
|
24614
24718
|
def input_enabled(
|
|
24615
24719
|
self,
|
|
24616
24720
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24617
|
-
'''
|
|
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
|
+
|
|
24618
24725
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputenabled
|
|
24619
24726
|
'''
|
|
24620
24727
|
result = self._values.get("input_enabled")
|
|
@@ -24622,7 +24729,11 @@ class CfnGuardrail(
|
|
|
24622
24729
|
|
|
24623
24730
|
@builtins.property
|
|
24624
24731
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24625
|
-
'''
|
|
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.
|
|
24626
24737
|
|
|
24627
24738
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputaction
|
|
24628
24739
|
'''
|
|
@@ -24633,7 +24744,10 @@ class CfnGuardrail(
|
|
|
24633
24744
|
def output_enabled(
|
|
24634
24745
|
self,
|
|
24635
24746
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24636
|
-
'''
|
|
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
|
+
|
|
24637
24751
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputenabled
|
|
24638
24752
|
'''
|
|
24639
24753
|
result = self._values.get("output_enabled")
|
|
@@ -24683,10 +24797,10 @@ class CfnGuardrail(
|
|
|
24683
24797
|
:param name: The name of the regular expression to configure for the guardrail.
|
|
24684
24798
|
:param pattern: The regular expression pattern to configure for the guardrail.
|
|
24685
24799
|
:param description: The description of the regular expression to configure for the guardrail.
|
|
24686
|
-
:param input_action:
|
|
24687
|
-
:param input_enabled:
|
|
24688
|
-
:param output_action:
|
|
24689
|
-
: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.
|
|
24690
24804
|
|
|
24691
24805
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html
|
|
24692
24806
|
:exampleMetadata: fixture=_generated
|
|
@@ -24777,7 +24891,10 @@ class CfnGuardrail(
|
|
|
24777
24891
|
|
|
24778
24892
|
@builtins.property
|
|
24779
24893
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
24780
|
-
'''
|
|
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.
|
|
24781
24898
|
|
|
24782
24899
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputaction
|
|
24783
24900
|
'''
|
|
@@ -24788,7 +24905,10 @@ class CfnGuardrail(
|
|
|
24788
24905
|
def input_enabled(
|
|
24789
24906
|
self,
|
|
24790
24907
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24791
|
-
'''
|
|
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
|
+
|
|
24792
24912
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputenabled
|
|
24793
24913
|
'''
|
|
24794
24914
|
result = self._values.get("input_enabled")
|
|
@@ -24796,7 +24916,10 @@ class CfnGuardrail(
|
|
|
24796
24916
|
|
|
24797
24917
|
@builtins.property
|
|
24798
24918
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
24799
|
-
'''
|
|
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.
|
|
24800
24923
|
|
|
24801
24924
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputaction
|
|
24802
24925
|
'''
|
|
@@ -24807,7 +24930,10 @@ class CfnGuardrail(
|
|
|
24807
24930
|
def output_enabled(
|
|
24808
24931
|
self,
|
|
24809
24932
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
24810
|
-
'''
|
|
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
|
+
|
|
24811
24937
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputenabled
|
|
24812
24938
|
'''
|
|
24813
24939
|
result = self._values.get("output_enabled")
|
|
@@ -24954,10 +25080,10 @@ class CfnGuardrail(
|
|
|
24954
25080
|
:param name: The name of the topic to deny.
|
|
24955
25081
|
:param type: Specifies to deny the topic.
|
|
24956
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.
|
|
24957
|
-
:param input_action:
|
|
24958
|
-
:param input_enabled:
|
|
24959
|
-
:param output_action:
|
|
24960
|
-
: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.
|
|
24961
25087
|
|
|
24962
25088
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html
|
|
24963
25089
|
:exampleMetadata: fixture=_generated
|
|
@@ -25048,7 +25174,11 @@ class CfnGuardrail(
|
|
|
25048
25174
|
|
|
25049
25175
|
@builtins.property
|
|
25050
25176
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
25051
|
-
'''
|
|
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
|
+
|
|
25052
25182
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputaction
|
|
25053
25183
|
'''
|
|
25054
25184
|
result = self._values.get("input_action")
|
|
@@ -25058,7 +25188,10 @@ class CfnGuardrail(
|
|
|
25058
25188
|
def input_enabled(
|
|
25059
25189
|
self,
|
|
25060
25190
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25061
|
-
'''
|
|
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
|
+
|
|
25062
25195
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputenabled
|
|
25063
25196
|
'''
|
|
25064
25197
|
result = self._values.get("input_enabled")
|
|
@@ -25066,7 +25199,11 @@ class CfnGuardrail(
|
|
|
25066
25199
|
|
|
25067
25200
|
@builtins.property
|
|
25068
25201
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
25069
|
-
'''
|
|
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
|
+
|
|
25070
25207
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputaction
|
|
25071
25208
|
'''
|
|
25072
25209
|
result = self._values.get("output_action")
|
|
@@ -25076,7 +25213,10 @@ class CfnGuardrail(
|
|
|
25076
25213
|
def output_enabled(
|
|
25077
25214
|
self,
|
|
25078
25215
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25079
|
-
'''
|
|
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
|
+
|
|
25080
25220
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputenabled
|
|
25081
25221
|
'''
|
|
25082
25222
|
result = self._values.get("output_enabled")
|
|
@@ -25111,7 +25251,7 @@ class CfnGuardrail(
|
|
|
25111
25251
|
'''Contains details about topics that the guardrail should identify and deny.
|
|
25112
25252
|
|
|
25113
25253
|
:param topics_config: A list of policies related to topics that the guardrail should deny.
|
|
25114
|
-
:param topics_tier_config:
|
|
25254
|
+
:param topics_tier_config: The tier that your guardrail uses for denied topic filters.
|
|
25115
25255
|
|
|
25116
25256
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html
|
|
25117
25257
|
:exampleMetadata: fixture=_generated
|
|
@@ -25168,7 +25308,7 @@ class CfnGuardrail(
|
|
|
25168
25308
|
def topics_tier_config(
|
|
25169
25309
|
self,
|
|
25170
25310
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGuardrail.TopicsTierConfigProperty"]]:
|
|
25171
|
-
'''
|
|
25311
|
+
'''The tier that your guardrail uses for denied topic filters.
|
|
25172
25312
|
|
|
25173
25313
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicstierconfig
|
|
25174
25314
|
'''
|
|
@@ -25193,9 +25333,11 @@ class CfnGuardrail(
|
|
|
25193
25333
|
)
|
|
25194
25334
|
class TopicsTierConfigProperty:
|
|
25195
25335
|
def __init__(self, *, tier_name: builtins.str) -> None:
|
|
25196
|
-
'''
|
|
25336
|
+
'''The tier that your guardrail uses for denied topic filters.
|
|
25197
25337
|
|
|
25198
|
-
|
|
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>`_ .
|
|
25199
25341
|
|
|
25200
25342
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html
|
|
25201
25343
|
:exampleMetadata: fixture=_generated
|
|
@@ -25219,7 +25361,10 @@ class CfnGuardrail(
|
|
|
25219
25361
|
|
|
25220
25362
|
@builtins.property
|
|
25221
25363
|
def tier_name(self) -> builtins.str:
|
|
25222
|
-
'''
|
|
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>`_ .
|
|
25223
25368
|
|
|
25224
25369
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html#cfn-bedrock-guardrail-topicstierconfig-tiername
|
|
25225
25370
|
'''
|
|
@@ -25262,10 +25407,10 @@ class CfnGuardrail(
|
|
|
25262
25407
|
'''A word to configure for the guardrail.
|
|
25263
25408
|
|
|
25264
25409
|
:param text: Text of the word configured for the guardrail to block.
|
|
25265
|
-
:param input_action:
|
|
25266
|
-
:param input_enabled:
|
|
25267
|
-
:param output_action:
|
|
25268
|
-
: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.
|
|
25269
25414
|
|
|
25270
25415
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html
|
|
25271
25416
|
:exampleMetadata: fixture=_generated
|
|
@@ -25317,7 +25462,11 @@ class CfnGuardrail(
|
|
|
25317
25462
|
|
|
25318
25463
|
@builtins.property
|
|
25319
25464
|
def input_action(self) -> typing.Optional[builtins.str]:
|
|
25320
|
-
'''
|
|
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
|
+
|
|
25321
25470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputaction
|
|
25322
25471
|
'''
|
|
25323
25472
|
result = self._values.get("input_action")
|
|
@@ -25327,7 +25476,10 @@ class CfnGuardrail(
|
|
|
25327
25476
|
def input_enabled(
|
|
25328
25477
|
self,
|
|
25329
25478
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25330
|
-
'''
|
|
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
|
+
|
|
25331
25483
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputenabled
|
|
25332
25484
|
'''
|
|
25333
25485
|
result = self._values.get("input_enabled")
|
|
@@ -25335,7 +25487,11 @@ class CfnGuardrail(
|
|
|
25335
25487
|
|
|
25336
25488
|
@builtins.property
|
|
25337
25489
|
def output_action(self) -> typing.Optional[builtins.str]:
|
|
25338
|
-
'''
|
|
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
|
+
|
|
25339
25495
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputaction
|
|
25340
25496
|
'''
|
|
25341
25497
|
result = self._values.get("output_action")
|
|
@@ -25345,7 +25501,10 @@ class CfnGuardrail(
|
|
|
25345
25501
|
def output_enabled(
|
|
25346
25502
|
self,
|
|
25347
25503
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
25348
|
-
'''
|
|
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
|
+
|
|
25349
25508
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputenabled
|
|
25350
25509
|
'''
|
|
25351
25510
|
result = self._values.get("output_enabled")
|
|
@@ -25498,7 +25657,7 @@ class CfnGuardrailProps:
|
|
|
25498
25657
|
:param name: The name of the guardrail.
|
|
25499
25658
|
:param content_policy_config: The content filter policies to configure for the guardrail.
|
|
25500
25659
|
:param contextual_grounding_policy_config: Contextual grounding policy config for a guardrail.
|
|
25501
|
-
: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>`_ .
|
|
25502
25661
|
:param description: A description of the guardrail.
|
|
25503
25662
|
:param kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.
|
|
25504
25663
|
:param sensitive_information_policy_config: The sensitive information policy to configure for the guardrail.
|
|
@@ -25719,7 +25878,11 @@ class CfnGuardrailProps:
|
|
|
25719
25878
|
def cross_region_config(
|
|
25720
25879
|
self,
|
|
25721
25880
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnGuardrail.GuardrailCrossRegionConfigProperty]]:
|
|
25722
|
-
'''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>`_ .
|
|
25723
25886
|
|
|
25724
25887
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig
|
|
25725
25888
|
'''
|
|
@@ -32797,7 +32960,7 @@ class CfnPrompt(
|
|
|
32797
32960
|
|
|
32798
32961
|
:param any: The model must request at least one tool (no text is generated).
|
|
32799
32962
|
:param auto: (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
|
|
32800
|
-
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
|
|
32963
|
+
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
32801
32964
|
|
|
32802
32965
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html
|
|
32803
32966
|
:exampleMetadata: fixture=_generated
|
|
@@ -32858,7 +33021,7 @@ class CfnPrompt(
|
|
|
32858
33021
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPrompt.SpecificToolChoiceProperty"]]:
|
|
32859
33022
|
'''The Model must request the specified tool.
|
|
32860
33023
|
|
|
32861
|
-
Only supported by Anthropic Claude 3 models.
|
|
33024
|
+
Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
32862
33025
|
|
|
32863
33026
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-tool
|
|
32864
33027
|
'''
|
|
@@ -35119,7 +35282,7 @@ class CfnPromptVersion(
|
|
|
35119
35282
|
|
|
35120
35283
|
:param any: The model must request at least one tool (no text is generated).
|
|
35121
35284
|
:param auto: (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
|
|
35122
|
-
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
|
|
35285
|
+
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
35123
35286
|
|
|
35124
35287
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html
|
|
35125
35288
|
:exampleMetadata: fixture=_generated
|
|
@@ -35180,7 +35343,7 @@ class CfnPromptVersion(
|
|
|
35180
35343
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.SpecificToolChoiceProperty"]]:
|
|
35181
35344
|
'''The Model must request the specified tool.
|
|
35182
35345
|
|
|
35183
|
-
Only supported by Anthropic Claude 3 models.
|
|
35346
|
+
Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
35184
35347
|
|
|
35185
35348
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-tool
|
|
35186
35349
|
'''
|
|
@@ -36567,6 +36730,18 @@ class FoundationModelIdentifier(
|
|
|
36567
36730
|
'''Base model "stability.stable-image-ultra-v1:1".'''
|
|
36568
36731
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "STABILITY_STABLE_IMAGE_ULTRA_V1_1"))
|
|
36569
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
|
+
|
|
36570
36745
|
@jsii.python.classproperty
|
|
36571
36746
|
@jsii.member(jsii_name="WRITER_PALMYRA_X4_V1_0")
|
|
36572
36747
|
def WRITER_PALMYRA_X4_V1_0(cls) -> "FoundationModelIdentifier":
|