aws-cdk-lib 2.177.0__py3-none-any.whl → 2.178.1__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.
Files changed (111) hide show
  1. aws_cdk/__init__.py +95 -61
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.177.0.jsii.tgz → aws-cdk-lib@2.178.1.jsii.tgz} +0 -0
  4. aws_cdk/aws_amplifyuibuilder/__init__.py +8 -8
  5. aws_cdk/aws_apigateway/__init__.py +97 -97
  6. aws_cdk/aws_apigatewayv2/__init__.py +35 -10
  7. aws_cdk/aws_appconfig/__init__.py +10 -10
  8. aws_cdk/aws_appflow/__init__.py +20 -20
  9. aws_cdk/aws_applicationsignals/__init__.py +8 -8
  10. aws_cdk/aws_appmesh/__init__.py +8 -8
  11. aws_cdk/aws_appsync/__init__.py +10383 -7035
  12. aws_cdk/aws_apptest/__init__.py +4 -4
  13. aws_cdk/aws_aps/__init__.py +135 -0
  14. aws_cdk/aws_athena/__init__.py +10 -10
  15. aws_cdk/aws_backup/__init__.py +14 -14
  16. aws_cdk/aws_batch/__init__.py +185 -22
  17. aws_cdk/aws_bcmdataexports/__init__.py +4 -4
  18. aws_cdk/aws_bedrock/__init__.py +266 -177
  19. aws_cdk/aws_certificatemanager/__init__.py +15 -14
  20. aws_cdk/aws_chatbot/__init__.py +4 -4
  21. aws_cdk/aws_cloudformation/__init__.py +22 -18
  22. aws_cdk/aws_cloudfront/__init__.py +674 -7
  23. aws_cdk/aws_cloudfront_origins/__init__.py +40 -0
  24. aws_cdk/aws_cloudtrail/__init__.py +4 -4
  25. aws_cdk/aws_cloudwatch/__init__.py +53 -53
  26. aws_cdk/aws_codedeploy/__init__.py +2 -2
  27. aws_cdk/aws_codepipeline/__init__.py +24 -6
  28. aws_cdk/aws_codepipeline_actions/__init__.py +2 -2
  29. aws_cdk/aws_cognito/__init__.py +42 -20
  30. aws_cdk/aws_connect/__init__.py +4 -4
  31. aws_cdk/aws_customerprofiles/__init__.py +3 -1
  32. aws_cdk/aws_databrew/__init__.py +16 -16
  33. aws_cdk/aws_datasync/__init__.py +14 -11
  34. aws_cdk/aws_datazone/__init__.py +5 -5
  35. aws_cdk/aws_dms/__init__.py +4 -4
  36. aws_cdk/aws_dynamodb/__init__.py +267 -25
  37. aws_cdk/aws_ec2/__init__.py +1137 -181
  38. aws_cdk/aws_ecs/__init__.py +740 -116
  39. aws_cdk/aws_ecs_patterns/__init__.py +49 -0
  40. aws_cdk/aws_efs/__init__.py +3 -3
  41. aws_cdk/aws_eks/__init__.py +31 -32
  42. aws_cdk/aws_elasticache/__init__.py +10 -10
  43. aws_cdk/aws_elasticloadbalancingv2/__init__.py +47 -18
  44. aws_cdk/aws_elasticsearch/__init__.py +10 -10
  45. aws_cdk/aws_emr/__init__.py +16 -16
  46. aws_cdk/aws_emrserverless/__init__.py +12 -9
  47. aws_cdk/aws_entityresolution/__init__.py +31 -17
  48. aws_cdk/aws_events/__init__.py +12 -12
  49. aws_cdk/aws_fis/__init__.py +16 -16
  50. aws_cdk/aws_fms/__init__.py +7 -3
  51. aws_cdk/aws_glue/__init__.py +1326 -7
  52. aws_cdk/aws_greengrassv2/__init__.py +8 -8
  53. aws_cdk/aws_guardduty/__init__.py +521 -0
  54. aws_cdk/aws_healthlake/__init__.py +10 -2
  55. aws_cdk/aws_imagebuilder/__init__.py +26 -26
  56. aws_cdk/aws_iot/__init__.py +40 -40
  57. aws_cdk/aws_iotanalytics/__init__.py +4 -4
  58. aws_cdk/aws_iotfleetwise/__init__.py +424 -10
  59. aws_cdk/aws_iotsitewise/__init__.py +84 -13
  60. aws_cdk/aws_iottwinmaker/__init__.py +18 -18
  61. aws_cdk/aws_iotwireless/__init__.py +4 -4
  62. aws_cdk/aws_kafkaconnect/__init__.py +10 -10
  63. aws_cdk/aws_kendra/__init__.py +0 -10
  64. aws_cdk/aws_kinesisanalytics/__init__.py +4 -4
  65. aws_cdk/aws_kinesisanalyticsv2/__init__.py +4 -4
  66. aws_cdk/aws_kinesisfirehose/__init__.py +4544 -183
  67. aws_cdk/aws_kms/__init__.py +11 -10
  68. aws_cdk/aws_lambda/__init__.py +34 -4
  69. aws_cdk/aws_lambda_nodejs/__init__.py +24 -5
  70. aws_cdk/aws_launchwizard/__init__.py +10 -10
  71. aws_cdk/aws_logs/__init__.py +19 -15
  72. aws_cdk/aws_mediaconnect/__init__.py +509 -12
  73. aws_cdk/aws_medialive/__init__.py +16 -16
  74. aws_cdk/aws_mediatailor/__init__.py +10 -10
  75. aws_cdk/aws_networkfirewall/__init__.py +12 -12
  76. aws_cdk/aws_notifications/__init__.py +602 -65
  77. aws_cdk/aws_omics/__init__.py +4 -4
  78. aws_cdk/aws_opensearchservice/__init__.py +10 -10
  79. aws_cdk/aws_opsworks/__init__.py +58 -58
  80. aws_cdk/aws_personalize/__init__.py +8 -8
  81. aws_cdk/aws_pipes/__init__.py +20 -20
  82. aws_cdk/aws_qbusiness/__init__.py +119 -0
  83. aws_cdk/aws_quicksight/__init__.py +247 -92
  84. aws_cdk/aws_rds/__init__.py +21 -15
  85. aws_cdk/aws_redshift/__init__.py +10 -10
  86. aws_cdk/aws_resiliencehub/__init__.py +0 -41
  87. aws_cdk/aws_route53/__init__.py +6 -0
  88. aws_cdk/aws_rum/__init__.py +4 -4
  89. aws_cdk/aws_s3/__init__.py +12 -2
  90. aws_cdk/aws_sagemaker/__init__.py +84 -60
  91. aws_cdk/aws_sam/__init__.py +48 -48
  92. aws_cdk/aws_secretsmanager/__init__.py +30 -14
  93. aws_cdk/aws_securityhub/__init__.py +12 -12
  94. aws_cdk/aws_sns/__init__.py +101 -15
  95. aws_cdk/aws_ssmquicksetup/__init__.py +10 -10
  96. aws_cdk/aws_stepfunctions/__init__.py +13207 -4740
  97. aws_cdk/aws_stepfunctions_tasks/__init__.py +77615 -22817
  98. aws_cdk/aws_synthetics/__init__.py +4 -4
  99. aws_cdk/aws_timestream/__init__.py +41 -0
  100. aws_cdk/aws_transfer/__init__.py +9 -10
  101. aws_cdk/aws_wafv2/__init__.py +24 -22
  102. aws_cdk/aws_wisdom/__init__.py +8 -8
  103. aws_cdk/aws_workspacesweb/__init__.py +60 -60
  104. aws_cdk/aws_xray/__init__.py +8 -8
  105. aws_cdk/cx_api/__init__.py +18 -0
  106. {aws_cdk_lib-2.177.0.dist-info → aws_cdk_lib-2.178.1.dist-info}/METADATA +1 -1
  107. {aws_cdk_lib-2.177.0.dist-info → aws_cdk_lib-2.178.1.dist-info}/RECORD +111 -111
  108. {aws_cdk_lib-2.177.0.dist-info → aws_cdk_lib-2.178.1.dist-info}/LICENSE +0 -0
  109. {aws_cdk_lib-2.177.0.dist-info → aws_cdk_lib-2.178.1.dist-info}/NOTICE +0 -0
  110. {aws_cdk_lib-2.177.0.dist-info → aws_cdk_lib-2.178.1.dist-info}/WHEEL +0 -0
  111. {aws_cdk_lib-2.177.0.dist-info → aws_cdk_lib-2.178.1.dist-info}/top_level.txt +0 -0
@@ -208,7 +208,7 @@ class CfnAgent(
208
208
  prompt_override_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAgent.PromptOverrideConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
209
209
  skip_resource_in_use_check_on_delete: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
210
210
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
211
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
211
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
212
212
  ) -> None:
213
213
  '''
214
214
  :param scope: Scope in which this resource is defined.
@@ -605,17 +605,17 @@ class CfnAgent(
605
605
  @jsii.member(jsii_name="testAliasTags")
606
606
  def test_alias_tags(
607
607
  self,
608
- ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
608
+ ) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
609
609
  '''Metadata that you can assign to a resource as key-value pairs.
610
610
 
611
611
  For more information, see the following resources:.
612
612
  '''
613
- return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], jsii.get(self, "testAliasTags"))
613
+ return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], jsii.get(self, "testAliasTags"))
614
614
 
615
615
  @test_alias_tags.setter
616
616
  def test_alias_tags(
617
617
  self,
618
- value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]],
618
+ value: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]],
619
619
  ) -> None:
620
620
  if __debug__:
621
621
  type_hints = typing.get_type_hints(_typecheckingstub__0adf24775a3a1362c3b4eeb79adc26cdf461e3c52ade9a1522d271295bf0d775)
@@ -2484,7 +2484,7 @@ class CfnAgentProps:
2484
2484
  prompt_override_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnAgent.PromptOverrideConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
2485
2485
  skip_resource_in_use_check_on_delete: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
2486
2486
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
2487
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
2487
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
2488
2488
  ) -> None:
2489
2489
  '''Properties for defining a ``CfnAgent``.
2490
2490
 
@@ -2807,7 +2807,7 @@ class CfnAgentProps:
2807
2807
  @builtins.property
2808
2808
  def test_alias_tags(
2809
2809
  self,
2810
- ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
2810
+ ) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
2811
2811
  '''Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
2812
2812
 
2813
2813
  - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_
@@ -2816,7 +2816,7 @@ class CfnAgentProps:
2816
2816
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-testaliastags
2817
2817
  '''
2818
2818
  result = self._values.get("test_alias_tags")
2819
- return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], result)
2819
+ return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], result)
2820
2820
 
2821
2821
  def __eq__(self, rhs: typing.Any) -> builtins.bool:
2822
2822
  return isinstance(rhs, self.__class__) and rhs._values == self._values
@@ -7545,7 +7545,7 @@ class CfnFlow(
7545
7545
  definition_substitutions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, typing.Union[builtins.str, jsii.Number, builtins.bool, _IResolvable_da3f097b]]]] = None,
7546
7546
  description: typing.Optional[builtins.str] = None,
7547
7547
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
7548
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
7548
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
7549
7549
  ) -> None:
7550
7550
  '''
7551
7551
  :param scope: Scope in which this resource is defined.
@@ -7831,14 +7831,14 @@ class CfnFlow(
7831
7831
  @jsii.member(jsii_name="testAliasTags")
7832
7832
  def test_alias_tags(
7833
7833
  self,
7834
- ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
7834
+ ) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
7835
7835
  '''A map of tag keys and values.'''
7836
- return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], jsii.get(self, "testAliasTags"))
7836
+ return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], jsii.get(self, "testAliasTags"))
7837
7837
 
7838
7838
  @test_alias_tags.setter
7839
7839
  def test_alias_tags(
7840
7840
  self,
7841
- value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]],
7841
+ value: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]],
7842
7842
  ) -> None:
7843
7843
  if __debug__:
7844
7844
  type_hints = typing.get_type_hints(_typecheckingstub__0c8f573e426abfd3b90c4d9ff9fecb4f008835544cca9591251c138795f9dac1)
@@ -11320,7 +11320,7 @@ class CfnFlowProps:
11320
11320
  definition_substitutions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, typing.Union[builtins.str, jsii.Number, builtins.bool, _IResolvable_da3f097b]]]] = None,
11321
11321
  description: typing.Optional[builtins.str] = None,
11322
11322
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
11323
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
11323
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
11324
11324
  ) -> None:
11325
11325
  '''Properties for defining a ``CfnFlow``.
11326
11326
 
@@ -11630,13 +11630,13 @@ class CfnFlowProps:
11630
11630
  @builtins.property
11631
11631
  def test_alias_tags(
11632
11632
  self,
11633
- ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
11633
+ ) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
11634
11634
  '''A map of tag keys and values.
11635
11635
 
11636
11636
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-testaliastags
11637
11637
  '''
11638
11638
  result = self._values.get("test_alias_tags")
11639
- return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], result)
11639
+ return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], result)
11640
11640
 
11641
11641
  def __eq__(self, rhs: typing.Any) -> builtins.bool:
11642
11642
  return isinstance(rhs, self.__class__) and rhs._values == self._values
@@ -16876,7 +16876,8 @@ class CfnKnowledgeBase(
16876
16876
  # the properties below are optional
16877
16877
  embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
16878
16878
  bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
16879
- dimensions=123
16879
+ dimensions=123,
16880
+ embedding_data_type="embeddingDataType"
16880
16881
  )
16881
16882
  ),
16882
16883
  supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty(
@@ -17168,13 +17169,22 @@ class CfnKnowledgeBase(
17168
17169
  @jsii.data_type(
17169
17170
  jsii_type="aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty",
17170
17171
  jsii_struct_bases=[],
17171
- name_mapping={"dimensions": "dimensions"},
17172
+ name_mapping={
17173
+ "dimensions": "dimensions",
17174
+ "embedding_data_type": "embeddingDataType",
17175
+ },
17172
17176
  )
17173
17177
  class BedrockEmbeddingModelConfigurationProperty:
17174
- def __init__(self, *, dimensions: typing.Optional[jsii.Number] = None) -> None:
17178
+ def __init__(
17179
+ self,
17180
+ *,
17181
+ dimensions: typing.Optional[jsii.Number] = None,
17182
+ embedding_data_type: typing.Optional[builtins.str] = None,
17183
+ ) -> None:
17175
17184
  '''The vector configuration details for the Bedrock embeddings model.
17176
17185
 
17177
17186
  :param dimensions: The dimensions details for the vector configuration used on the Bedrock embeddings model.
17187
+ :param embedding_data_type: The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See `Supported embeddings models <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html>`_ for information on the available models and their vector data types.
17178
17188
 
17179
17189
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html
17180
17190
  :exampleMetadata: fixture=_generated
@@ -17186,15 +17196,19 @@ class CfnKnowledgeBase(
17186
17196
  from aws_cdk import aws_bedrock as bedrock
17187
17197
 
17188
17198
  bedrock_embedding_model_configuration_property = bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
17189
- dimensions=123
17199
+ dimensions=123,
17200
+ embedding_data_type="embeddingDataType"
17190
17201
  )
17191
17202
  '''
17192
17203
  if __debug__:
17193
17204
  type_hints = typing.get_type_hints(_typecheckingstub__4b911df2c776c9053f061cf36e273662447b61302cf3b4d67af08cec4459c308)
17194
17205
  check_type(argname="argument dimensions", value=dimensions, expected_type=type_hints["dimensions"])
17206
+ check_type(argname="argument embedding_data_type", value=embedding_data_type, expected_type=type_hints["embedding_data_type"])
17195
17207
  self._values: typing.Dict[builtins.str, typing.Any] = {}
17196
17208
  if dimensions is not None:
17197
17209
  self._values["dimensions"] = dimensions
17210
+ if embedding_data_type is not None:
17211
+ self._values["embedding_data_type"] = embedding_data_type
17198
17212
 
17199
17213
  @builtins.property
17200
17214
  def dimensions(self) -> typing.Optional[jsii.Number]:
@@ -17205,6 +17219,17 @@ class CfnKnowledgeBase(
17205
17219
  result = self._values.get("dimensions")
17206
17220
  return typing.cast(typing.Optional[jsii.Number], result)
17207
17221
 
17222
+ @builtins.property
17223
+ def embedding_data_type(self) -> typing.Optional[builtins.str]:
17224
+ '''The data type for the vectors when using a model to convert text into vector embeddings.
17225
+
17226
+ The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See `Supported embeddings models <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html>`_ for information on the available models and their vector data types.
17227
+
17228
+ :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-embeddingdatatype
17229
+ '''
17230
+ result = self._values.get("embedding_data_type")
17231
+ return typing.cast(typing.Optional[builtins.str], result)
17232
+
17208
17233
  def __eq__(self, rhs: typing.Any) -> builtins.bool:
17209
17234
  return isinstance(rhs, self.__class__) and rhs._values == self._values
17210
17235
 
@@ -17228,10 +17253,10 @@ class CfnKnowledgeBase(
17228
17253
  natural_language: builtins.str,
17229
17254
  sql: builtins.str,
17230
17255
  ) -> None:
17231
- '''Curated query or question and answer pair.
17256
+ '''Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
17232
17257
 
17233
- :param natural_language: Question for the curated query.
17234
- :param sql: Answer for the curated query.
17258
+ :param natural_language: An example natural language query.
17259
+ :param sql: The SQL equivalent of the natural language query.
17235
17260
 
17236
17261
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-curatedquery.html
17237
17262
  :exampleMetadata: fixture=_generated
@@ -17258,7 +17283,7 @@ class CfnKnowledgeBase(
17258
17283
 
17259
17284
  @builtins.property
17260
17285
  def natural_language(self) -> builtins.str:
17261
- '''Question for the curated query.
17286
+ '''An example natural language query.
17262
17287
 
17263
17288
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-curatedquery.html#cfn-bedrock-knowledgebase-curatedquery-naturallanguage
17264
17289
  '''
@@ -17268,7 +17293,7 @@ class CfnKnowledgeBase(
17268
17293
 
17269
17294
  @builtins.property
17270
17295
  def sql(self) -> builtins.str:
17271
- '''Answer for the curated query.
17296
+ '''The SQL equivalent of the natural language query.
17272
17297
 
17273
17298
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-curatedquery.html#cfn-bedrock-knowledgebase-curatedquery-sql
17274
17299
  '''
@@ -17315,7 +17340,8 @@ class CfnKnowledgeBase(
17315
17340
 
17316
17341
  embedding_model_configuration_property = bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
17317
17342
  bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
17318
- dimensions=123
17343
+ dimensions=123,
17344
+ embedding_data_type="embeddingDataType"
17319
17345
  )
17320
17346
  )
17321
17347
  '''
@@ -17425,7 +17451,7 @@ class CfnKnowledgeBase(
17425
17451
 
17426
17452
  :param type: The type of data that the data source is converted into for the knowledge base.
17427
17453
  :param kendra_knowledge_base_configuration: Settings for an Amazon Kendra knowledge base.
17428
- :param sql_knowledge_base_configuration: Configurations for a SQL knowledge base.
17454
+ :param sql_knowledge_base_configuration: Specifies configurations for a knowledge base connected to an SQL database.
17429
17455
  :param vector_knowledge_base_configuration: Contains details about the model that's used to convert the data source into vector embeddings.
17430
17456
 
17431
17457
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html
@@ -17515,7 +17541,8 @@ class CfnKnowledgeBase(
17515
17541
  # the properties below are optional
17516
17542
  embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
17517
17543
  bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
17518
- dimensions=123
17544
+ dimensions=123,
17545
+ embedding_data_type="embeddingDataType"
17519
17546
  )
17520
17547
  ),
17521
17548
  supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty(
@@ -17572,7 +17599,7 @@ class CfnKnowledgeBase(
17572
17599
  def sql_knowledge_base_configuration(
17573
17600
  self,
17574
17601
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty"]]:
17575
- '''Configurations for a SQL knowledge base.
17602
+ '''Specifies configurations for a knowledge base connected to an SQL database.
17576
17603
 
17577
17604
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-sqlknowledgebaseconfiguration
17578
17605
  '''
@@ -17996,11 +18023,11 @@ class CfnKnowledgeBase(
17996
18023
  inclusion: typing.Optional[builtins.str] = None,
17997
18024
  name: typing.Optional[builtins.str] = None,
17998
18025
  ) -> None:
17999
- '''Redshift query generation column.
18026
+ '''Contains information about a column in the current table for the query engine to consider.
18000
18027
 
18001
- :param description: Description for the attached entity.
18002
- :param inclusion: Include or Exclude status for an entity.
18003
- :param name: Query generation column name.
18028
+ :param description: A description of the column that helps the query engine understand the contents of the column.
18029
+ :param inclusion: Specifies whether to include or exclude the column during query generation. If you specify ``EXCLUDE`` , the column will be ignored. If you specify ``INCLUDE`` , all other columns in the table will be ignored.
18030
+ :param name: The name of the column for which the other fields in this object apply.
18004
18031
 
18005
18032
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html
18006
18033
  :exampleMetadata: fixture=_generated
@@ -18032,7 +18059,7 @@ class CfnKnowledgeBase(
18032
18059
 
18033
18060
  @builtins.property
18034
18061
  def description(self) -> typing.Optional[builtins.str]:
18035
- '''Description for the attached entity.
18062
+ '''A description of the column that helps the query engine understand the contents of the column.
18036
18063
 
18037
18064
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html#cfn-bedrock-knowledgebase-querygenerationcolumn-description
18038
18065
  '''
@@ -18041,7 +18068,9 @@ class CfnKnowledgeBase(
18041
18068
 
18042
18069
  @builtins.property
18043
18070
  def inclusion(self) -> typing.Optional[builtins.str]:
18044
- '''Include or Exclude status for an entity.
18071
+ '''Specifies whether to include or exclude the column during query generation.
18072
+
18073
+ If you specify ``EXCLUDE`` , the column will be ignored. If you specify ``INCLUDE`` , all other columns in the table will be ignored.
18045
18074
 
18046
18075
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html#cfn-bedrock-knowledgebase-querygenerationcolumn-inclusion
18047
18076
  '''
@@ -18050,7 +18079,7 @@ class CfnKnowledgeBase(
18050
18079
 
18051
18080
  @builtins.property
18052
18081
  def name(self) -> typing.Optional[builtins.str]:
18053
- '''Query generation column name.
18082
+ '''The name of the column for which the other fields in this object apply.
18054
18083
 
18055
18084
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html#cfn-bedrock-knowledgebase-querygenerationcolumn-name
18056
18085
  '''
@@ -18083,10 +18112,12 @@ class CfnKnowledgeBase(
18083
18112
  execution_timeout_seconds: typing.Optional[jsii.Number] = None,
18084
18113
  generation_context: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.QueryGenerationContextProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
18085
18114
  ) -> None:
18086
- '''Configurations for generating Redshift engine queries.
18115
+ '''Contains configurations for query generation.
18116
+
18117
+ For more information, see `Build a knowledge base by connecting to a structured data source <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html>`_ in the Amazon Bedrock User Guide..
18087
18118
 
18088
- :param execution_timeout_seconds: Max query execution timeout.
18089
- :param generation_context: Context used to improve query generation.
18119
+ :param execution_timeout_seconds: The time after which query generation will time out.
18120
+ :param generation_context: Specifies configurations for context to use during query generation.
18090
18121
 
18091
18122
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html
18092
18123
  :exampleMetadata: fixture=_generated
@@ -18131,7 +18162,7 @@ class CfnKnowledgeBase(
18131
18162
 
18132
18163
  @builtins.property
18133
18164
  def execution_timeout_seconds(self) -> typing.Optional[jsii.Number]:
18134
- '''Max query execution timeout.
18165
+ '''The time after which query generation will time out.
18135
18166
 
18136
18167
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html#cfn-bedrock-knowledgebase-querygenerationconfiguration-executiontimeoutseconds
18137
18168
  '''
@@ -18142,7 +18173,7 @@ class CfnKnowledgeBase(
18142
18173
  def generation_context(
18143
18174
  self,
18144
18175
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.QueryGenerationContextProperty"]]:
18145
- '''Context used to improve query generation.
18176
+ '''Specifies configurations for context to use during query generation.
18146
18177
 
18147
18178
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html#cfn-bedrock-knowledgebase-querygenerationconfiguration-generationcontext
18148
18179
  '''
@@ -18172,10 +18203,12 @@ class CfnKnowledgeBase(
18172
18203
  curated_queries: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.CuratedQueryProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
18173
18204
  tables: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.QueryGenerationTableProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
18174
18205
  ) -> None:
18175
- '''Context used to improve query generation.
18206
+ '''.. epigraph::
18176
18207
 
18177
- :param curated_queries: List of example queries and results.
18178
- :param tables: List of tables used for Redshift query generation context.
18208
+ Contains configurations for context to use during query generation.
18209
+
18210
+ :param curated_queries: An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
18211
+ :param tables: An array of objects, each of which defines information about a table in the database.
18179
18212
 
18180
18213
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html
18181
18214
  :exampleMetadata: fixture=_generated
@@ -18219,7 +18252,7 @@ class CfnKnowledgeBase(
18219
18252
  def curated_queries(
18220
18253
  self,
18221
18254
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.CuratedQueryProperty"]]]]:
18222
- '''List of example queries and results.
18255
+ '''An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
18223
18256
 
18224
18257
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html#cfn-bedrock-knowledgebase-querygenerationcontext-curatedqueries
18225
18258
  '''
@@ -18230,7 +18263,7 @@ class CfnKnowledgeBase(
18230
18263
  def tables(
18231
18264
  self,
18232
18265
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.QueryGenerationTableProperty"]]]]:
18233
- '''List of tables used for Redshift query generation context.
18266
+ '''An array of objects, each of which defines information about a table in the database.
18234
18267
 
18235
18268
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html#cfn-bedrock-knowledgebase-querygenerationcontext-tables
18236
18269
  '''
@@ -18267,12 +18300,12 @@ class CfnKnowledgeBase(
18267
18300
  description: typing.Optional[builtins.str] = None,
18268
18301
  inclusion: typing.Optional[builtins.str] = None,
18269
18302
  ) -> None:
18270
- '''Tables used for Redshift query generation context.
18303
+ '''Contains information about a table for the query engine to consider.
18271
18304
 
18272
- :param name: Query generation table name. Must follow three-part notation
18273
- :param columns: List of Redshift query generation columns.
18274
- :param description: Description for the attached entity.
18275
- :param inclusion: Include or Exclude status for an entity.
18305
+ :param name: The name of the table for which the other fields in this object apply.
18306
+ :param columns: An array of objects, each of which defines information about a column in the table.
18307
+ :param description: A description of the table that helps the query engine understand the contents of the table.
18308
+ :param inclusion: Specifies whether to include or exclude the table during query generation. If you specify ``EXCLUDE`` , the table will be ignored. If you specify ``INCLUDE`` , all other tables will be ignored.
18276
18309
 
18277
18310
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html
18278
18311
  :exampleMetadata: fixture=_generated
@@ -18314,9 +18347,7 @@ class CfnKnowledgeBase(
18314
18347
 
18315
18348
  @builtins.property
18316
18349
  def name(self) -> builtins.str:
18317
- '''Query generation table name.
18318
-
18319
- Must follow three-part notation
18350
+ '''The name of the table for which the other fields in this object apply.
18320
18351
 
18321
18352
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-name
18322
18353
  '''
@@ -18328,7 +18359,7 @@ class CfnKnowledgeBase(
18328
18359
  def columns(
18329
18360
  self,
18330
18361
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.QueryGenerationColumnProperty"]]]]:
18331
- '''List of Redshift query generation columns.
18362
+ '''An array of objects, each of which defines information about a column in the table.
18332
18363
 
18333
18364
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-columns
18334
18365
  '''
@@ -18337,7 +18368,7 @@ class CfnKnowledgeBase(
18337
18368
 
18338
18369
  @builtins.property
18339
18370
  def description(self) -> typing.Optional[builtins.str]:
18340
- '''Description for the attached entity.
18371
+ '''A description of the table that helps the query engine understand the contents of the table.
18341
18372
 
18342
18373
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-description
18343
18374
  '''
@@ -18346,7 +18377,9 @@ class CfnKnowledgeBase(
18346
18377
 
18347
18378
  @builtins.property
18348
18379
  def inclusion(self) -> typing.Optional[builtins.str]:
18349
- '''Include or Exclude status for an entity.
18380
+ '''Specifies whether to include or exclude the table during query generation.
18381
+
18382
+ If you specify ``EXCLUDE`` , the table will be ignored. If you specify ``INCLUDE`` , all other tables will be ignored.
18350
18383
 
18351
18384
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-inclusion
18352
18385
  '''
@@ -18620,11 +18653,13 @@ class CfnKnowledgeBase(
18620
18653
  storage_configurations: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftQueryEngineStorageConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]]],
18621
18654
  query_generation_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.QueryGenerationConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
18622
18655
  ) -> None:
18623
- '''Configurations for a Redshift knowledge base.
18656
+ '''Contains configurations for an Amazon Redshift database.
18657
+
18658
+ For more information, see `Build a knowledge base by connecting to a structured data source <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html>`_ in the Amazon Bedrock User Guide.
18624
18659
 
18625
- :param query_engine_configuration: Configurations for Redshift query engine.
18626
- :param storage_configurations: List of configurations for available Redshift query engine storage types.
18627
- :param query_generation_configuration: Configurations for generating Redshift engine queries.
18660
+ :param query_engine_configuration: Specifies configurations for an Amazon Redshift query engine.
18661
+ :param storage_configurations: Specifies configurations for Amazon Redshift database storage.
18662
+ :param query_generation_configuration: Specifies configurations for generating queries.
18628
18663
 
18629
18664
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html
18630
18665
  :exampleMetadata: fixture=_generated
@@ -18712,7 +18747,7 @@ class CfnKnowledgeBase(
18712
18747
  def query_engine_configuration(
18713
18748
  self,
18714
18749
  ) -> typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftQueryEngineConfigurationProperty"]:
18715
- '''Configurations for Redshift query engine.
18750
+ '''Specifies configurations for an Amazon Redshift query engine.
18716
18751
 
18717
18752
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html#cfn-bedrock-knowledgebase-redshiftconfiguration-queryengineconfiguration
18718
18753
  '''
@@ -18724,7 +18759,7 @@ class CfnKnowledgeBase(
18724
18759
  def storage_configurations(
18725
18760
  self,
18726
18761
  ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftQueryEngineStorageConfigurationProperty"]]]:
18727
- '''List of configurations for available Redshift query engine storage types.
18762
+ '''Specifies configurations for Amazon Redshift database storage.
18728
18763
 
18729
18764
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html#cfn-bedrock-knowledgebase-redshiftconfiguration-storageconfigurations
18730
18765
  '''
@@ -18736,7 +18771,7 @@ class CfnKnowledgeBase(
18736
18771
  def query_generation_configuration(
18737
18772
  self,
18738
18773
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.QueryGenerationConfigurationProperty"]]:
18739
- '''Configurations for generating Redshift engine queries.
18774
+ '''Specifies configurations for generating queries.
18740
18775
 
18741
18776
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html#cfn-bedrock-knowledgebase-redshiftconfiguration-querygenerationconfiguration
18742
18777
  '''
@@ -18771,11 +18806,13 @@ class CfnKnowledgeBase(
18771
18806
  database_user: typing.Optional[builtins.str] = None,
18772
18807
  username_password_secret_arn: typing.Optional[builtins.str] = None,
18773
18808
  ) -> None:
18774
- '''Configurations for Redshift query engine provisioned auth setup.
18809
+ '''Contains configurations for authentication to an Amazon Redshift provisioned data warehouse.
18775
18810
 
18776
- :param type: Provisioned Redshift auth type.
18777
- :param database_user: Redshift database user.
18778
- :param username_password_secret_arn: Arn of a SecretsManager Secret.
18811
+ Specify the type of authentication to use in the ``type`` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
18812
+
18813
+ :param type: The type of authentication to use.
18814
+ :param database_user: The database username for authentication to an Amazon Redshift provisioned data warehouse.
18815
+ :param username_password_secret_arn: The ARN of an Secrets Manager secret for authentication.
18779
18816
 
18780
18817
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html
18781
18818
  :exampleMetadata: fixture=_generated
@@ -18809,7 +18846,7 @@ class CfnKnowledgeBase(
18809
18846
 
18810
18847
  @builtins.property
18811
18848
  def type(self) -> builtins.str:
18812
- '''Provisioned Redshift auth type.
18849
+ '''The type of authentication to use.
18813
18850
 
18814
18851
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-type
18815
18852
  '''
@@ -18819,7 +18856,7 @@ class CfnKnowledgeBase(
18819
18856
 
18820
18857
  @builtins.property
18821
18858
  def database_user(self) -> typing.Optional[builtins.str]:
18822
- '''Redshift database user.
18859
+ '''The database username for authentication to an Amazon Redshift provisioned data warehouse.
18823
18860
 
18824
18861
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-databaseuser
18825
18862
  '''
@@ -18828,7 +18865,7 @@ class CfnKnowledgeBase(
18828
18865
 
18829
18866
  @builtins.property
18830
18867
  def username_password_secret_arn(self) -> typing.Optional[builtins.str]:
18831
- '''Arn of a SecretsManager Secret.
18868
+ '''The ARN of an Secrets Manager secret for authentication.
18832
18869
 
18833
18870
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-usernamepasswordsecretarn
18834
18871
  '''
@@ -18861,10 +18898,10 @@ class CfnKnowledgeBase(
18861
18898
  auth_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftProvisionedAuthConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
18862
18899
  cluster_identifier: builtins.str,
18863
18900
  ) -> None:
18864
- '''Configurations for provisioned Redshift query engine.
18901
+ '''Contains configurations for a provisioned Amazon Redshift query engine.
18865
18902
 
18866
- :param auth_configuration: Configurations for Redshift query engine provisioned auth setup.
18867
- :param cluster_identifier: Redshift cluster identifier.
18903
+ :param auth_configuration: Specifies configurations for authentication to Amazon Redshift.
18904
+ :param cluster_identifier: The ID of the Amazon Redshift cluster.
18868
18905
 
18869
18906
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html
18870
18907
  :exampleMetadata: fixture=_generated
@@ -18899,7 +18936,7 @@ class CfnKnowledgeBase(
18899
18936
  def auth_configuration(
18900
18937
  self,
18901
18938
  ) -> typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftProvisionedAuthConfigurationProperty"]:
18902
- '''Configurations for Redshift query engine provisioned auth setup.
18939
+ '''Specifies configurations for authentication to Amazon Redshift.
18903
18940
 
18904
18941
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-authconfiguration
18905
18942
  '''
@@ -18909,7 +18946,7 @@ class CfnKnowledgeBase(
18909
18946
 
18910
18947
  @builtins.property
18911
18948
  def cluster_identifier(self) -> builtins.str:
18912
- '''Redshift cluster identifier.
18949
+ '''The ID of the Amazon Redshift cluster.
18913
18950
 
18914
18951
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-clusteridentifier
18915
18952
  '''
@@ -18935,9 +18972,9 @@ class CfnKnowledgeBase(
18935
18972
  )
18936
18973
  class RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty:
18937
18974
  def __init__(self, *, table_names: typing.Sequence[builtins.str]) -> None:
18938
- '''Configurations for Redshift query engine AWS Data Catalog backed storage.
18975
+ '''Contains configurations for storage in AWS Glue Data Catalog.
18939
18976
 
18940
- :param table_names: List of table names in AWS Data Catalog. Must follow two part notation
18977
+ :param table_names: A list of names of the tables to use.
18941
18978
 
18942
18979
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration.html
18943
18980
  :exampleMetadata: fixture=_generated
@@ -18961,9 +18998,7 @@ class CfnKnowledgeBase(
18961
18998
 
18962
18999
  @builtins.property
18963
19000
  def table_names(self) -> typing.List[builtins.str]:
18964
- '''List of table names in AWS Data Catalog.
18965
-
18966
- Must follow two part notation
19001
+ '''A list of names of the tables to use.
18967
19002
 
18968
19003
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration-tablenames
18969
19004
  '''
@@ -18999,11 +19034,13 @@ class CfnKnowledgeBase(
18999
19034
  provisioned_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftProvisionedConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
19000
19035
  serverless_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftServerlessConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
19001
19036
  ) -> None:
19002
- '''Configurations for Redshift query engine.
19037
+ '''Contains configurations for an Amazon Redshift query engine.
19003
19038
 
19004
- :param type: Redshift query engine type.
19005
- :param provisioned_configuration: Configurations for provisioned Redshift query engine.
19006
- :param serverless_configuration: Configurations for serverless Redshift query engine.
19039
+ Specify the type of query engine in ``type`` and include the corresponding field. For more information, see `Build a knowledge base by connecting to a structured data source <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html>`_ in the Amazon Bedrock User Guide.
19040
+
19041
+ :param type: The type of query engine.
19042
+ :param provisioned_configuration: Specifies configurations for a provisioned Amazon Redshift query engine.
19043
+ :param serverless_configuration: Specifies configurations for a serverless Amazon Redshift query engine.
19007
19044
 
19008
19045
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html
19009
19046
  :exampleMetadata: fixture=_generated
@@ -19054,7 +19091,7 @@ class CfnKnowledgeBase(
19054
19091
 
19055
19092
  @builtins.property
19056
19093
  def type(self) -> builtins.str:
19057
- '''Redshift query engine type.
19094
+ '''The type of query engine.
19058
19095
 
19059
19096
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-type
19060
19097
  '''
@@ -19066,7 +19103,7 @@ class CfnKnowledgeBase(
19066
19103
  def provisioned_configuration(
19067
19104
  self,
19068
19105
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftProvisionedConfigurationProperty"]]:
19069
- '''Configurations for provisioned Redshift query engine.
19106
+ '''Specifies configurations for a provisioned Amazon Redshift query engine.
19070
19107
 
19071
19108
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-provisionedconfiguration
19072
19109
  '''
@@ -19077,7 +19114,7 @@ class CfnKnowledgeBase(
19077
19114
  def serverless_configuration(
19078
19115
  self,
19079
19116
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftServerlessConfigurationProperty"]]:
19080
- '''Configurations for serverless Redshift query engine.
19117
+ '''Specifies configurations for a serverless Amazon Redshift query engine.
19081
19118
 
19082
19119
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-serverlessconfiguration
19083
19120
  '''
@@ -19102,9 +19139,9 @@ class CfnKnowledgeBase(
19102
19139
  )
19103
19140
  class RedshiftQueryEngineRedshiftStorageConfigurationProperty:
19104
19141
  def __init__(self, *, database_name: builtins.str) -> None:
19105
- '''Configurations for Redshift query engine Redshift backed storage.
19142
+ '''Contains configurations for storage in Amazon Redshift.
19106
19143
 
19107
- :param database_name: Redshift database name.
19144
+ :param database_name: The name of the Amazon Redshift database.
19108
19145
 
19109
19146
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration.html
19110
19147
  :exampleMetadata: fixture=_generated
@@ -19128,7 +19165,7 @@ class CfnKnowledgeBase(
19128
19165
 
19129
19166
  @builtins.property
19130
19167
  def database_name(self) -> builtins.str:
19131
- '''Redshift database name.
19168
+ '''The name of the Amazon Redshift database.
19132
19169
 
19133
19170
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration-databasename
19134
19171
  '''
@@ -19164,11 +19201,13 @@ class CfnKnowledgeBase(
19164
19201
  aws_data_catalog_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
19165
19202
  redshift_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftQueryEngineRedshiftStorageConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
19166
19203
  ) -> None:
19167
- '''Configurations for available Redshift query engine storage types.
19204
+ '''Contains configurations for Amazon Redshift data storage.
19205
+
19206
+ Specify the data storage service to use in the ``type`` field and include the corresponding field. For more information, see `Build a knowledge base by connecting to a structured data source <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html>`_ in the Amazon Bedrock User Guide.
19168
19207
 
19169
- :param type: Redshift query engine storage type.
19170
- :param aws_data_catalog_configuration: Configurations for Redshift query engine AWS Data Catalog backed storage.
19171
- :param redshift_configuration: Configurations for Redshift query engine Redshift backed storage.
19208
+ :param type: The data storage service to use.
19209
+ :param aws_data_catalog_configuration: Specifies configurations for storage in AWS Glue Data Catalog.
19210
+ :param redshift_configuration: Specifies configurations for storage in Amazon Redshift.
19172
19211
 
19173
19212
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html
19174
19213
  :exampleMetadata: fixture=_generated
@@ -19206,7 +19245,7 @@ class CfnKnowledgeBase(
19206
19245
 
19207
19246
  @builtins.property
19208
19247
  def type(self) -> builtins.str:
19209
- '''Redshift query engine storage type.
19248
+ '''The data storage service to use.
19210
19249
 
19211
19250
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-type
19212
19251
  '''
@@ -19218,7 +19257,7 @@ class CfnKnowledgeBase(
19218
19257
  def aws_data_catalog_configuration(
19219
19258
  self,
19220
19259
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty"]]:
19221
- '''Configurations for Redshift query engine AWS Data Catalog backed storage.
19260
+ '''Specifies configurations for storage in AWS Glue Data Catalog.
19222
19261
 
19223
19262
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-awsdatacatalogconfiguration
19224
19263
  '''
@@ -19229,7 +19268,7 @@ class CfnKnowledgeBase(
19229
19268
  def redshift_configuration(
19230
19269
  self,
19231
19270
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftQueryEngineRedshiftStorageConfigurationProperty"]]:
19232
- '''Configurations for Redshift query engine Redshift backed storage.
19271
+ '''Specifies configurations for storage in Amazon Redshift.
19233
19272
 
19234
19273
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-redshiftconfiguration
19235
19274
  '''
@@ -19262,10 +19301,12 @@ class CfnKnowledgeBase(
19262
19301
  type: builtins.str,
19263
19302
  username_password_secret_arn: typing.Optional[builtins.str] = None,
19264
19303
  ) -> None:
19265
- '''Configurations for Redshift query engine serverless auth setup.
19304
+ '''Specifies configurations for authentication to a Redshift Serverless.
19266
19305
 
19267
- :param type: Serverless Redshift auth type.
19268
- :param username_password_secret_arn: Arn of a SecretsManager Secret.
19306
+ Specify the type of authentication to use in the ``type`` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
19307
+
19308
+ :param type: The type of authentication to use.
19309
+ :param username_password_secret_arn: The ARN of an Secrets Manager secret for authentication.
19269
19310
 
19270
19311
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html
19271
19312
  :exampleMetadata: fixture=_generated
@@ -19295,7 +19336,7 @@ class CfnKnowledgeBase(
19295
19336
 
19296
19337
  @builtins.property
19297
19338
  def type(self) -> builtins.str:
19298
- '''Serverless Redshift auth type.
19339
+ '''The type of authentication to use.
19299
19340
 
19300
19341
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-type
19301
19342
  '''
@@ -19305,7 +19346,7 @@ class CfnKnowledgeBase(
19305
19346
 
19306
19347
  @builtins.property
19307
19348
  def username_password_secret_arn(self) -> typing.Optional[builtins.str]:
19308
- '''Arn of a SecretsManager Secret.
19349
+ '''The ARN of an Secrets Manager secret for authentication.
19309
19350
 
19310
19351
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-usernamepasswordsecretarn
19311
19352
  '''
@@ -19338,10 +19379,10 @@ class CfnKnowledgeBase(
19338
19379
  auth_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftServerlessAuthConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
19339
19380
  workgroup_arn: builtins.str,
19340
19381
  ) -> None:
19341
- '''Configurations for serverless Redshift query engine.
19382
+ '''Contains configurations for authentication to Amazon Redshift Serverless.
19342
19383
 
19343
- :param auth_configuration: Configurations for Redshift query engine serverless auth setup.
19344
- :param workgroup_arn: Workgroup arn.
19384
+ :param auth_configuration: Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
19385
+ :param workgroup_arn: The ARN of the Amazon Redshift workgroup.
19345
19386
 
19346
19387
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html
19347
19388
  :exampleMetadata: fixture=_generated
@@ -19375,7 +19416,7 @@ class CfnKnowledgeBase(
19375
19416
  def auth_configuration(
19376
19417
  self,
19377
19418
  ) -> typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftServerlessAuthConfigurationProperty"]:
19378
- '''Configurations for Redshift query engine serverless auth setup.
19419
+ '''Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
19379
19420
 
19380
19421
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-authconfiguration
19381
19422
  '''
@@ -19385,7 +19426,7 @@ class CfnKnowledgeBase(
19385
19426
 
19386
19427
  @builtins.property
19387
19428
  def workgroup_arn(self) -> builtins.str:
19388
- '''Workgroup arn.
19429
+ '''The ARN of the Amazon Redshift workgroup.
19389
19430
 
19390
19431
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-workgrouparn
19391
19432
  '''
@@ -19471,10 +19512,12 @@ class CfnKnowledgeBase(
19471
19512
  type: builtins.str,
19472
19513
  redshift_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnKnowledgeBase.RedshiftConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
19473
19514
  ) -> None:
19474
- '''Configurations for a SQL knowledge base.
19515
+ '''Contains configurations for a knowledge base connected to an SQL database.
19516
+
19517
+ Specify the SQL database type in the ``type`` field and include the corresponding field. For more information, see `Build a knowledge base by connecting to a structured data source <https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html>`_ in the Amazon Bedrock User Guide.
19475
19518
 
19476
- :param type: SQL query engine type.
19477
- :param redshift_configuration: Configurations for a Redshift knowledge base.
19519
+ :param type: The type of SQL database to connect to the knowledge base.
19520
+ :param redshift_configuration: Specifies configurations for a knowledge base connected to an Amazon Redshift database.
19478
19521
 
19479
19522
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html
19480
19523
  :exampleMetadata: fixture=_generated
@@ -19563,7 +19606,7 @@ class CfnKnowledgeBase(
19563
19606
 
19564
19607
  @builtins.property
19565
19608
  def type(self) -> builtins.str:
19566
- '''SQL query engine type.
19609
+ '''The type of SQL database to connect to the knowledge base.
19567
19610
 
19568
19611
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-type
19569
19612
  '''
@@ -19575,7 +19618,7 @@ class CfnKnowledgeBase(
19575
19618
  def redshift_configuration(
19576
19619
  self,
19577
19620
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnKnowledgeBase.RedshiftConfigurationProperty"]]:
19578
- '''Configurations for a Redshift knowledge base.
19621
+ '''Specifies configurations for a knowledge base connected to an Amazon Redshift database.
19579
19622
 
19580
19623
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-redshiftconfiguration
19581
19624
  '''
@@ -19925,7 +19968,8 @@ class CfnKnowledgeBase(
19925
19968
  # the properties below are optional
19926
19969
  embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
19927
19970
  bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
19928
- dimensions=123
19971
+ dimensions=123,
19972
+ embedding_data_type="embeddingDataType"
19929
19973
  )
19930
19974
  ),
19931
19975
  supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty(
@@ -20119,7 +20163,8 @@ class CfnKnowledgeBaseProps:
20119
20163
  # the properties below are optional
20120
20164
  embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
20121
20165
  bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
20122
- dimensions=123
20166
+ dimensions=123,
20167
+ embedding_data_type="embeddingDataType"
20123
20168
  )
20124
20169
  ),
20125
20170
  supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty(
@@ -22760,12 +22805,14 @@ class CfnPromptVersion(
22760
22805
  system: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.SystemContentBlockProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
22761
22806
  tool_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.ToolConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
22762
22807
  ) -> None:
22763
- '''Configuration for chat prompt template.
22808
+ '''Contains configurations to use a prompt in a conversational format.
22809
+
22810
+ For more information, see `Create a prompt using Prompt management <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html>`_ .
22764
22811
 
22765
- :param messages: List of messages for chat prompt template.
22766
- :param input_variables: List of input variables.
22767
- :param system: Configuration for chat prompt template.
22768
- :param tool_configuration: Tool configuration.
22812
+ :param messages: Contains messages in the chat for the prompt.
22813
+ :param input_variables: An array of the variables in the prompt template.
22814
+ :param system: Contains system prompts to provide context to the model or to describe how it should behave.
22815
+ :param tool_configuration: Configuration information for the tools that the model can use when generating a response.
22769
22816
 
22770
22817
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html
22771
22818
  :exampleMetadata: fixture=_generated
@@ -22839,7 +22886,7 @@ class CfnPromptVersion(
22839
22886
  def messages(
22840
22887
  self,
22841
22888
  ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.MessageProperty"]]]:
22842
- '''List of messages for chat prompt template.
22889
+ '''Contains messages in the chat for the prompt.
22843
22890
 
22844
22891
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-messages
22845
22892
  '''
@@ -22851,7 +22898,7 @@ class CfnPromptVersion(
22851
22898
  def input_variables(
22852
22899
  self,
22853
22900
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.PromptInputVariableProperty"]]]]:
22854
- '''List of input variables.
22901
+ '''An array of the variables in the prompt template.
22855
22902
 
22856
22903
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-inputvariables
22857
22904
  '''
@@ -22862,7 +22909,7 @@ class CfnPromptVersion(
22862
22909
  def system(
22863
22910
  self,
22864
22911
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.SystemContentBlockProperty"]]]]:
22865
- '''Configuration for chat prompt template.
22912
+ '''Contains system prompts to provide context to the model or to describe how it should behave.
22866
22913
 
22867
22914
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-system
22868
22915
  '''
@@ -22873,7 +22920,7 @@ class CfnPromptVersion(
22873
22920
  def tool_configuration(
22874
22921
  self,
22875
22922
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ToolConfigurationProperty"]]:
22876
- '''Tool configuration.
22923
+ '''Configuration information for the tools that the model can use when generating a response.
22877
22924
 
22878
22925
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-toolconfiguration
22879
22926
  '''
@@ -22898,9 +22945,9 @@ class CfnPromptVersion(
22898
22945
  )
22899
22946
  class ContentBlockProperty:
22900
22947
  def __init__(self, *, text: builtins.str) -> None:
22901
- '''Configuration for chat prompt template.
22948
+ '''A block of content for a message that you pass to, or receive from, a model with the `Converse <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html>`_ or `ConverseStream <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html>`_ API operations.
22902
22949
 
22903
- :param text: Configuration for chat prompt template.
22950
+ :param text: Text to include in the message.
22904
22951
 
22905
22952
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-contentblock.html
22906
22953
  :exampleMetadata: fixture=_generated
@@ -22924,7 +22971,7 @@ class CfnPromptVersion(
22924
22971
 
22925
22972
  @builtins.property
22926
22973
  def text(self) -> builtins.str:
22927
- '''Configuration for chat prompt template.
22974
+ '''Text to include in the message.
22928
22975
 
22929
22976
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-contentblock.html#cfn-bedrock-promptversion-contentblock-text
22930
22977
  '''
@@ -22955,10 +23002,10 @@ class CfnPromptVersion(
22955
23002
  content: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.ContentBlockProperty", typing.Dict[builtins.str, typing.Any]]]]],
22956
23003
  role: builtins.str,
22957
23004
  ) -> None:
22958
- '''Chat prompt Message.
23005
+ '''A message input, or returned from, a call to `Converse <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html>`_ or `ConverseStream <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html>`_ .
22959
23006
 
22960
- :param content: List of Content Blocks.
22961
- :param role: Conversation roles for the chat prompt.
23007
+ :param content: The message content. Note the following restrictions:. - You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively. - You can include up to five documents. Each document's size must be no more than 4.5 MB. - If you include a ``ContentBlock`` with a ``document`` field in the array, you must also include a ``ContentBlock`` with a ``text`` field. - You can only include images and documents if the ``role`` is ``user`` .
23008
+ :param role: The role that the message plays in the message.
22962
23009
 
22963
23010
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-message.html
22964
23011
  :exampleMetadata: fixture=_generated
@@ -22989,7 +23036,12 @@ class CfnPromptVersion(
22989
23036
  def content(
22990
23037
  self,
22991
23038
  ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ContentBlockProperty"]]]:
22992
- '''List of Content Blocks.
23039
+ '''The message content. Note the following restrictions:.
23040
+
23041
+ - You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.
23042
+ - You can include up to five documents. Each document's size must be no more than 4.5 MB.
23043
+ - If you include a ``ContentBlock`` with a ``document`` field in the array, you must also include a ``ContentBlock`` with a ``text`` field.
23044
+ - You can only include images and documents if the ``role`` is ``user`` .
22993
23045
 
22994
23046
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-message.html#cfn-bedrock-promptversion-message-content
22995
23047
  '''
@@ -22999,7 +23051,7 @@ class CfnPromptVersion(
22999
23051
 
23000
23052
  @builtins.property
23001
23053
  def role(self) -> builtins.str:
23002
- '''Conversation roles for the chat prompt.
23054
+ '''The role that the message plays in the message.
23003
23055
 
23004
23056
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-message.html#cfn-bedrock-promptversion-message-role
23005
23057
  '''
@@ -23025,9 +23077,11 @@ class CfnPromptVersion(
23025
23077
  )
23026
23078
  class PromptAgentResourceProperty:
23027
23079
  def __init__(self, *, agent_identifier: builtins.str) -> None:
23028
- '''Target Agent to invoke with Prompt.
23080
+ '''Contains specifications for an Amazon Bedrock agent with which to use the prompt.
23081
+
23082
+ For more information, see `Create a prompt using Prompt management <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html>`_ and `Automate tasks in your application using conversational agents <https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html>`_ .
23029
23083
 
23030
- :param agent_identifier: Arn representation of the Agent Alias.
23084
+ :param agent_identifier: The ARN of the agent with which to use the prompt.
23031
23085
 
23032
23086
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptagentresource.html
23033
23087
  :exampleMetadata: fixture=_generated
@@ -23051,7 +23105,7 @@ class CfnPromptVersion(
23051
23105
 
23052
23106
  @builtins.property
23053
23107
  def agent_identifier(self) -> builtins.str:
23054
- '''Arn representation of the Agent Alias.
23108
+ '''The ARN of the agent with which to use the prompt.
23055
23109
 
23056
23110
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptagentresource.html#cfn-bedrock-promptversion-promptagentresource-agentidentifier
23057
23111
  '''
@@ -23081,9 +23135,11 @@ class CfnPromptVersion(
23081
23135
  *,
23082
23136
  agent: typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.PromptAgentResourceProperty", typing.Dict[builtins.str, typing.Any]]],
23083
23137
  ) -> None:
23084
- '''Target resource to invoke with Prompt.
23138
+ '''Contains specifications for a generative AI resource with which to use the prompt.
23085
23139
 
23086
- :param agent: Target Agent to invoke with Prompt.
23140
+ For more information, see `Create a prompt using Prompt management <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html>`_ .
23141
+
23142
+ :param agent: Specifies an Amazon Bedrock agent with which to use the prompt.
23087
23143
 
23088
23144
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptgenairesource.html
23089
23145
  :exampleMetadata: fixture=_generated
@@ -23111,7 +23167,7 @@ class CfnPromptVersion(
23111
23167
  def agent(
23112
23168
  self,
23113
23169
  ) -> typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.PromptAgentResourceProperty"]:
23114
- '''Target Agent to invoke with Prompt.
23170
+ '''Specifies an Amazon Bedrock agent with which to use the prompt.
23115
23171
 
23116
23172
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptgenairesource.html#cfn-bedrock-promptversion-promptgenairesource-agent
23117
23173
  '''
@@ -23369,7 +23425,7 @@ class CfnPromptVersion(
23369
23425
 
23370
23426
  For more information, see `Construct and store reusable prompts with Prompt management in Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html>`_ .
23371
23427
 
23372
- :param chat: Configuration for chat prompt template.
23428
+ :param chat: Contains configurations to use the prompt in a conversational format.
23373
23429
  :param text: Contains configurations for the text in a message for a prompt.
23374
23430
 
23375
23431
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-prompttemplateconfiguration.html
@@ -23448,7 +23504,7 @@ class CfnPromptVersion(
23448
23504
  def chat(
23449
23505
  self,
23450
23506
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ChatPromptTemplateConfigurationProperty"]]:
23451
- '''Configuration for chat prompt template.
23507
+ '''Contains configurations to use the prompt in a conversational format.
23452
23508
 
23453
23509
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-prompttemplateconfiguration.html#cfn-bedrock-promptversion-prompttemplateconfiguration-chat
23454
23510
  '''
@@ -23505,7 +23561,7 @@ class CfnPromptVersion(
23505
23561
  :param name: The name of the prompt variant.
23506
23562
  :param template_configuration: Contains configurations for the prompt template.
23507
23563
  :param template_type: The type of prompt template to use.
23508
- :param gen_ai_resource: Target resource to invoke with Prompt.
23564
+ :param gen_ai_resource: Specifies a generative AI resource with which to use the prompt.
23509
23565
  :param inference_configuration: Contains inference configurations for the prompt variant.
23510
23566
  :param model_id: The unique identifier of the model or `inference profile <https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html>`_ with which to run inference on the prompt.
23511
23567
 
@@ -23647,7 +23703,7 @@ class CfnPromptVersion(
23647
23703
  def gen_ai_resource(
23648
23704
  self,
23649
23705
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.PromptGenAiResourceProperty"]]:
23650
- '''Target resource to invoke with Prompt.
23706
+ '''Specifies a generative AI resource with which to use the prompt.
23651
23707
 
23652
23708
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-genairesource
23653
23709
  '''
@@ -23692,9 +23748,14 @@ class CfnPromptVersion(
23692
23748
  )
23693
23749
  class SpecificToolChoiceProperty:
23694
23750
  def __init__(self, *, name: builtins.str) -> None:
23695
- '''Specific Tool choice.
23751
+ '''The model must request a specific tool.
23752
+
23753
+ For example, ``{"tool" : {"name" : "Your tool name"}}`` . For more information, see `Call a tool with the Converse API <https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html>`_ in the Amazon Bedrock User Guide
23754
+ .. epigraph::
23696
23755
 
23697
- :param name: Tool name.
23756
+ This field is only supported by Anthropic Claude 3 models.
23757
+
23758
+ :param name: The name of the tool that the model must request.
23698
23759
 
23699
23760
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-specifictoolchoice.html
23700
23761
  :exampleMetadata: fixture=_generated
@@ -23718,7 +23779,7 @@ class CfnPromptVersion(
23718
23779
 
23719
23780
  @builtins.property
23720
23781
  def name(self) -> builtins.str:
23721
- '''Tool name.
23782
+ '''The name of the tool that the model must request.
23722
23783
 
23723
23784
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-specifictoolchoice.html#cfn-bedrock-promptversion-specifictoolchoice-name
23724
23785
  '''
@@ -23744,9 +23805,11 @@ class CfnPromptVersion(
23744
23805
  )
23745
23806
  class SystemContentBlockProperty:
23746
23807
  def __init__(self, *, text: builtins.str) -> None:
23747
- '''Configuration for chat prompt template.
23808
+ '''Contains configurations for instructions to provide the model for how to handle input.
23809
+
23810
+ To learn more, see `Using the Converse API <https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html>`_ .
23748
23811
 
23749
- :param text: Configuration for chat prompt template.
23812
+ :param text: A system prompt for the model.
23750
23813
 
23751
23814
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-systemcontentblock.html
23752
23815
  :exampleMetadata: fixture=_generated
@@ -23770,7 +23833,7 @@ class CfnPromptVersion(
23770
23833
 
23771
23834
  @builtins.property
23772
23835
  def text(self) -> builtins.str:
23773
- '''Configuration for chat prompt template.
23836
+ '''A system prompt for the model.
23774
23837
 
23775
23838
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-systemcontentblock.html#cfn-bedrock-promptversion-systemcontentblock-text
23776
23839
  '''
@@ -23881,10 +23944,13 @@ class CfnPromptVersion(
23881
23944
  auto: typing.Any = None,
23882
23945
  tool: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.SpecificToolChoiceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
23883
23946
  ) -> None:
23884
- '''
23885
- :param any: Any Tool choice.
23886
- :param auto: Auto Tool choice.
23887
- :param tool: Specific Tool choice.
23947
+ '''Determines which tools the model should request in a call to ``Converse`` or ``ConverseStream`` .
23948
+
23949
+ ``ToolChoice`` is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large. For more information, see `Call a tool with the Converse API <https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html>`_ in the Amazon Bedrock User Guide.
23950
+
23951
+ :param any: The model must request at least one tool (no text is generated).
23952
+ :param auto: (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
23953
+ :param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
23888
23954
 
23889
23955
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html
23890
23956
  :exampleMetadata: fixture=_generated
@@ -23921,7 +23987,7 @@ class CfnPromptVersion(
23921
23987
 
23922
23988
  @builtins.property
23923
23989
  def any(self) -> typing.Any:
23924
- '''Any Tool choice.
23990
+ '''The model must request at least one tool (no text is generated).
23925
23991
 
23926
23992
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-any
23927
23993
  '''
@@ -23930,7 +23996,9 @@ class CfnPromptVersion(
23930
23996
 
23931
23997
  @builtins.property
23932
23998
  def auto(self) -> typing.Any:
23933
- '''Auto Tool choice.
23999
+ '''(Default).
24000
+
24001
+ The Model automatically decides if a tool should be called or whether to generate text instead.
23934
24002
 
23935
24003
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-auto
23936
24004
  '''
@@ -23941,7 +24009,9 @@ class CfnPromptVersion(
23941
24009
  def tool(
23942
24010
  self,
23943
24011
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.SpecificToolChoiceProperty"]]:
23944
- '''Specific Tool choice.
24012
+ '''The Model must request the specified tool.
24013
+
24014
+ Only supported by Anthropic Claude 3 models.
23945
24015
 
23946
24016
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-tool
23947
24017
  '''
@@ -23971,10 +24041,12 @@ class CfnPromptVersion(
23971
24041
  tools: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.ToolProperty", typing.Dict[builtins.str, typing.Any]]]]],
23972
24042
  tool_choice: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.ToolChoiceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
23973
24043
  ) -> None:
23974
- '''Tool configuration.
24044
+ '''Configuration information for the tools that you pass to a model.
24045
+
24046
+ For more information, see `Tool use (function calling) <https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html>`_ in the Amazon Bedrock User Guide.
23975
24047
 
23976
- :param tools: List of Tools.
23977
- :param tool_choice: Tool choice.
24048
+ :param tools: An array of tools that you want to pass to a model.
24049
+ :param tool_choice: If supported by model, forces the model to request a tool.
23978
24050
 
23979
24051
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolconfiguration.html
23980
24052
  :exampleMetadata: fixture=_generated
@@ -24026,7 +24098,7 @@ class CfnPromptVersion(
24026
24098
  def tools(
24027
24099
  self,
24028
24100
  ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ToolProperty"]]]:
24029
- '''List of Tools.
24101
+ '''An array of tools that you want to pass to a model.
24030
24102
 
24031
24103
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolconfiguration.html#cfn-bedrock-promptversion-toolconfiguration-tools
24032
24104
  '''
@@ -24038,7 +24110,7 @@ class CfnPromptVersion(
24038
24110
  def tool_choice(
24039
24111
  self,
24040
24112
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ToolChoiceProperty"]]:
24041
- '''Tool choice.
24113
+ '''If supported by model, forces the model to request a tool.
24042
24114
 
24043
24115
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolconfiguration.html#cfn-bedrock-promptversion-toolconfiguration-toolchoice
24044
24116
  '''
@@ -24063,9 +24135,11 @@ class CfnPromptVersion(
24063
24135
  )
24064
24136
  class ToolInputSchemaProperty:
24065
24137
  def __init__(self, *, json: typing.Any) -> None:
24066
- '''Tool input schema.
24138
+ '''The schema for the tool.
24139
+
24140
+ The top level schema type must be ``object`` . For more information, see `Call a tool with the Converse API <https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html>`_ in the Amazon Bedrock User Guide.
24067
24141
 
24068
- :param json:
24142
+ :param json: The JSON schema for the tool. For more information, see `JSON Schema Reference <https://docs.aws.amazon.com/https://json-schema.org/understanding-json-schema/reference>`_ .
24069
24143
 
24070
24144
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolinputschema.html
24071
24145
  :exampleMetadata: fixture=_generated
@@ -24091,7 +24165,10 @@ class CfnPromptVersion(
24091
24165
 
24092
24166
  @builtins.property
24093
24167
  def json(self) -> typing.Any:
24094
- '''
24168
+ '''The JSON schema for the tool.
24169
+
24170
+ For more information, see `JSON Schema Reference <https://docs.aws.amazon.com/https://json-schema.org/understanding-json-schema/reference>`_ .
24171
+
24095
24172
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolinputschema.html#cfn-bedrock-promptversion-toolinputschema-json
24096
24173
  '''
24097
24174
  result = self._values.get("json")
@@ -24120,9 +24197,11 @@ class CfnPromptVersion(
24120
24197
  *,
24121
24198
  tool_spec: typing.Union[_IResolvable_da3f097b, typing.Union["CfnPromptVersion.ToolSpecificationProperty", typing.Dict[builtins.str, typing.Any]]],
24122
24199
  ) -> None:
24123
- '''Tool details.
24200
+ '''Information about a tool that you can use with the Converse API.
24124
24201
 
24125
- :param tool_spec: Tool specification.
24202
+ For more information, see `Call a tool with the Converse API <https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html>`_ in the Amazon Bedrock User Guide.
24203
+
24204
+ :param tool_spec: The specfication for the tool.
24126
24205
 
24127
24206
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-tool.html
24128
24207
  :exampleMetadata: fixture=_generated
@@ -24158,7 +24237,7 @@ class CfnPromptVersion(
24158
24237
  def tool_spec(
24159
24238
  self,
24160
24239
  ) -> typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ToolSpecificationProperty"]:
24161
- '''Tool specification.
24240
+ '''The specfication for the tool.
24162
24241
 
24163
24242
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-tool.html#cfn-bedrock-promptversion-tool-toolspec
24164
24243
  '''
@@ -24194,11 +24273,13 @@ class CfnPromptVersion(
24194
24273
  name: builtins.str,
24195
24274
  description: typing.Optional[builtins.str] = None,
24196
24275
  ) -> None:
24197
- '''Tool specification.
24276
+ '''The specification for the tool.
24277
+
24278
+ For more information, see `Call a tool with the Converse API <https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html>`_ in the Amazon Bedrock User Guide.
24198
24279
 
24199
- :param input_schema: Tool input schema.
24200
- :param name: Tool name.
24201
- :param description:
24280
+ :param input_schema: The input schema for the tool in JSON format.
24281
+ :param name: The name for the tool.
24282
+ :param description: The description for the tool.
24202
24283
 
24203
24284
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html
24204
24285
  :exampleMetadata: fixture=_generated
@@ -24237,7 +24318,7 @@ class CfnPromptVersion(
24237
24318
  def input_schema(
24238
24319
  self,
24239
24320
  ) -> typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.ToolInputSchemaProperty"]:
24240
- '''Tool input schema.
24321
+ '''The input schema for the tool in JSON format.
24241
24322
 
24242
24323
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html#cfn-bedrock-promptversion-toolspecification-inputschema
24243
24324
  '''
@@ -24247,7 +24328,7 @@ class CfnPromptVersion(
24247
24328
 
24248
24329
  @builtins.property
24249
24330
  def name(self) -> builtins.str:
24250
- '''Tool name.
24331
+ '''The name for the tool.
24251
24332
 
24252
24333
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html#cfn-bedrock-promptversion-toolspecification-name
24253
24334
  '''
@@ -24257,7 +24338,8 @@ class CfnPromptVersion(
24257
24338
 
24258
24339
  @builtins.property
24259
24340
  def description(self) -> typing.Optional[builtins.str]:
24260
- '''
24341
+ '''The description for the tool.
24342
+
24261
24343
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html#cfn-bedrock-promptversion-toolspecification-description
24262
24344
  '''
24263
24345
  result = self._values.get("description")
@@ -24951,6 +25033,12 @@ class FoundationModelIdentifier(
24951
25033
  '''Base model "cohere.rerank-v3-5:0".'''
24952
25034
  return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "COHERE_RERANK_V3_5"))
24953
25035
 
25036
+ @jsii.python.classproperty
25037
+ @jsii.member(jsii_name="LUMA_RAY_V2_0")
25038
+ def LUMA_RAY_V2_0(cls) -> "FoundationModelIdentifier":
25039
+ '''Base model "luma.ray-v2:0".'''
25040
+ return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "LUMA_RAY_V2_0"))
25041
+
24954
25042
  @jsii.python.classproperty
24955
25043
  @jsii.member(jsii_name="META_LLAMA_2_13B_CHAT_V1_0_4K")
24956
25044
  def META_LLAMA_2_13_B_CHAT_V1_0_4_K(cls) -> "FoundationModelIdentifier":
@@ -25435,7 +25523,7 @@ def _typecheckingstub__facaad57ffe16da42f099d2b7997f3e6fd3b9eba46fd226d8fb5afe28
25435
25523
  prompt_override_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnAgent.PromptOverrideConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
25436
25524
  skip_resource_in_use_check_on_delete: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
25437
25525
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
25438
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
25526
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
25439
25527
  ) -> None:
25440
25528
  """Type checking stubs"""
25441
25529
  pass
@@ -25537,7 +25625,7 @@ def _typecheckingstub__f9e79489cae3525b40539f62fddb8a1f8b194bc0b1d166146c12f85a5
25537
25625
  pass
25538
25626
 
25539
25627
  def _typecheckingstub__0adf24775a3a1362c3b4eeb79adc26cdf461e3c52ade9a1522d271295bf0d775(
25540
- value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]],
25628
+ value: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]],
25541
25629
  ) -> None:
25542
25630
  """Type checking stubs"""
25543
25631
  pass
@@ -25752,7 +25840,7 @@ def _typecheckingstub__b4f714080f6d4f9b0a3fe85a8425a8ba69698695e35d6fbd9d710ca5d
25752
25840
  prompt_override_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnAgent.PromptOverrideConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
25753
25841
  skip_resource_in_use_check_on_delete: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
25754
25842
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
25755
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
25843
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
25756
25844
  ) -> None:
25757
25845
  """Type checking stubs"""
25758
25846
  pass
@@ -26225,7 +26313,7 @@ def _typecheckingstub__de6f163cc9336f6925ec17d7466e0c9a53cd276d201d3e7dcf092e2b1
26225
26313
  definition_substitutions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, typing.Union[builtins.str, jsii.Number, builtins.bool, _IResolvable_da3f097b]]]] = None,
26226
26314
  description: typing.Optional[builtins.str] = None,
26227
26315
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
26228
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
26316
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
26229
26317
  ) -> None:
26230
26318
  """Type checking stubs"""
26231
26319
  pass
@@ -26297,7 +26385,7 @@ def _typecheckingstub__00fc718d7b494a828bea538bc7c10f721679354bb6555d8e15e32b216
26297
26385
  pass
26298
26386
 
26299
26387
  def _typecheckingstub__0c8f573e426abfd3b90c4d9ff9fecb4f008835544cca9591251c138795f9dac1(
26300
- value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]],
26388
+ value: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]],
26301
26389
  ) -> None:
26302
26390
  """Type checking stubs"""
26303
26391
  pass
@@ -26658,7 +26746,7 @@ def _typecheckingstub__bad8ab7f592d2682a6b9c1a504f97fac9b6e0a7bbbfcf4968c42f3a95
26658
26746
  definition_substitutions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, typing.Union[builtins.str, jsii.Number, builtins.bool, _IResolvable_da3f097b]]]] = None,
26659
26747
  description: typing.Optional[builtins.str] = None,
26660
26748
  tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
26661
- test_alias_tags: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
26749
+ test_alias_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
26662
26750
  ) -> None:
26663
26751
  """Type checking stubs"""
26664
26752
  pass
@@ -27278,6 +27366,7 @@ def _typecheckingstub__3aaa5f9544be44cbc2ddb7d96026222438266e370aa05113a01af8f25
27278
27366
  def _typecheckingstub__4b911df2c776c9053f061cf36e273662447b61302cf3b4d67af08cec4459c308(
27279
27367
  *,
27280
27368
  dimensions: typing.Optional[jsii.Number] = None,
27369
+ embedding_data_type: typing.Optional[builtins.str] = None,
27281
27370
  ) -> None:
27282
27371
  """Type checking stubs"""
27283
27372
  pass