aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.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.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +57 -0
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.172.0.jsii.tgz → aws-cdk-lib@2.173.1.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +111 -64
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_autoscaling/__init__.py +15 -6
- aws_cdk/aws_bedrock/__init__.py +32 -44
- aws_cdk/aws_chatbot/__init__.py +72 -46
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudfront/__init__.py +4 -2
- aws_cdk/aws_cloudtrail/__init__.py +104 -68
- aws_cdk/aws_cloudwatch/__init__.py +51 -14
- aws_cdk/aws_codebuild/__init__.py +39 -0
- aws_cdk/aws_codepipeline/__init__.py +4 -4
- aws_cdk/aws_cognito/__init__.py +221 -53
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +25 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +130 -48
- aws_cdk/aws_ecs/__init__.py +25 -13
- aws_cdk/aws_eks/__init__.py +86 -24
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +138 -128
- aws_cdk/aws_events/__init__.py +39 -26
- aws_cdk/aws_fsx/__init__.py +134 -10
- aws_cdk/aws_imagebuilder/__init__.py +8 -8
- aws_cdk/aws_invoicing/__init__.py +651 -0
- aws_cdk/aws_iot/__init__.py +28 -22
- aws_cdk/aws_iotfleetwise/__init__.py +473 -332
- aws_cdk/aws_iotsitewise/__init__.py +6 -4
- aws_cdk/aws_ivs/__init__.py +43 -31
- aws_cdk/aws_kendra/__init__.py +4 -0
- aws_cdk/aws_lakeformation/__init__.py +2 -1
- aws_cdk/aws_lambda/__init__.py +258 -156
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +15 -15
- aws_cdk/aws_mediaconnect/__init__.py +24 -14
- aws_cdk/aws_medialive/__init__.py +2359 -5
- aws_cdk/aws_mediapackage/__init__.py +3 -9
- aws_cdk/aws_mediapackagev2/__init__.py +19 -17
- aws_cdk/aws_memorydb/__init__.py +664 -4
- aws_cdk/aws_qbusiness/__init__.py +2018 -66
- aws_cdk/aws_rds/__init__.py +30 -0
- aws_cdk/aws_resourcegroups/__init__.py +26 -17
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +224 -100
- aws_cdk/aws_route53resolver/__init__.py +4 -2
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +30 -19
- aws_cdk/aws_sagemaker/__init__.py +783 -9
- aws_cdk/aws_secretsmanager/__init__.py +20 -6
- aws_cdk/aws_securityhub/__init__.py +64 -32
- aws_cdk/aws_servicediscovery/__init__.py +43 -0
- aws_cdk/aws_ses/__init__.py +109 -0
- aws_cdk/aws_stepfunctions_tasks/__init__.py +190 -35
- aws_cdk/aws_synthetics/__init__.py +7 -5
- aws_cdk/aws_vpclattice/__init__.py +1479 -122
- aws_cdk/aws_wisdom/__init__.py +2698 -232
- aws_cdk/aws_workspacesweb/__init__.py +118 -61
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/RECORD +69 -68
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/top_level.txt +0 -0
|
@@ -9627,7 +9627,7 @@ class CfnScalingPolicy(
|
|
|
9627
9627
|
:param metric_name: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the `Metric <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html>`_ object that is returned by a call to `ListMetrics <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html>`_ .
|
|
9628
9628
|
:param metrics: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
|
|
9629
9629
|
:param namespace: The namespace of the metric.
|
|
9630
|
-
:param period:
|
|
9630
|
+
:param period: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
9631
9631
|
:param statistic: The statistic of the metric.
|
|
9632
9632
|
:param unit: The unit of the metric. For a complete list of the units that CloudWatch supports, see the `MetricDatum <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html>`_ data type in the *Amazon CloudWatch API Reference* .
|
|
9633
9633
|
|
|
@@ -9751,7 +9751,10 @@ class CfnScalingPolicy(
|
|
|
9751
9751
|
|
|
9752
9752
|
@builtins.property
|
|
9753
9753
|
def period(self) -> typing.Optional[jsii.Number]:
|
|
9754
|
-
'''
|
|
9754
|
+
'''The period of the metric in seconds.
|
|
9755
|
+
|
|
9756
|
+
The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
9757
|
+
|
|
9755
9758
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-period
|
|
9756
9759
|
'''
|
|
9757
9760
|
result = self._values.get("period")
|
|
@@ -11712,7 +11715,7 @@ class CfnScalingPolicy(
|
|
|
11712
11715
|
:param expression: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
11713
11716
|
:param label: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
|
|
11714
11717
|
:param metric_stat: Information about the metric data to return. Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat`` , but not both.
|
|
11715
|
-
:param period:
|
|
11718
|
+
:param period: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11716
11719
|
:param return_data: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData`` . This sets it to its default ( ``true`` ).
|
|
11717
11720
|
|
|
11718
11721
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html
|
|
@@ -11824,7 +11827,10 @@ class CfnScalingPolicy(
|
|
|
11824
11827
|
|
|
11825
11828
|
@builtins.property
|
|
11826
11829
|
def period(self) -> typing.Optional[jsii.Number]:
|
|
11827
|
-
'''
|
|
11830
|
+
'''The period of the metric in seconds.
|
|
11831
|
+
|
|
11832
|
+
The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11833
|
+
|
|
11828
11834
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-period
|
|
11829
11835
|
'''
|
|
11830
11836
|
result = self._values.get("period")
|
|
@@ -11883,7 +11889,7 @@ class CfnScalingPolicy(
|
|
|
11883
11889
|
|
|
11884
11890
|
:param metric: The metric to use.
|
|
11885
11891
|
:param stat: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in `Statistics <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic>`_ in the *Amazon CloudWatch User Guide* . The most commonly used metric for scaling is ``Average`` .
|
|
11886
|
-
:param period:
|
|
11892
|
+
:param period: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11887
11893
|
:param unit: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the `MetricDatum <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html>`_ data type in the *Amazon CloudWatch API Reference* .
|
|
11888
11894
|
|
|
11889
11895
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html
|
|
@@ -11956,7 +11962,10 @@ class CfnScalingPolicy(
|
|
|
11956
11962
|
|
|
11957
11963
|
@builtins.property
|
|
11958
11964
|
def period(self) -> typing.Optional[jsii.Number]:
|
|
11959
|
-
'''
|
|
11965
|
+
'''The period of the metric in seconds.
|
|
11966
|
+
|
|
11967
|
+
The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see `Create a target tracking policy using high-resolution metrics for faster response <https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html>`_ .
|
|
11968
|
+
|
|
11960
11969
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-period
|
|
11961
11970
|
'''
|
|
11962
11971
|
result = self._values.get("period")
|
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -635,10 +635,10 @@ class CfnAgent(
|
|
|
635
635
|
) -> None:
|
|
636
636
|
'''Contains details about the OpenAPI schema for the action group.
|
|
637
637
|
|
|
638
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com
|
|
638
|
+
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html>`_ . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
|
|
639
639
|
|
|
640
|
-
:param payload: The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
641
|
-
:param s3: Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
640
|
+
:param payload: The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
641
|
+
:param s3: Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
642
642
|
|
|
643
643
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html
|
|
644
644
|
:exampleMetadata: fixture=_generated
|
|
@@ -671,8 +671,6 @@ class CfnAgent(
|
|
|
671
671
|
def payload(self) -> typing.Optional[builtins.str]:
|
|
672
672
|
'''The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
673
673
|
|
|
674
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
675
|
-
|
|
676
674
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-payload
|
|
677
675
|
'''
|
|
678
676
|
result = self._values.get("payload")
|
|
@@ -684,8 +682,6 @@ class CfnAgent(
|
|
|
684
682
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAgent.S3IdentifierProperty"]]:
|
|
685
683
|
'''Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
686
684
|
|
|
687
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
688
|
-
|
|
689
685
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-s3
|
|
690
686
|
'''
|
|
691
687
|
result = self._values.get("s3")
|
|
@@ -716,7 +712,7 @@ class CfnAgent(
|
|
|
716
712
|
) -> None:
|
|
717
713
|
'''Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
|
|
718
714
|
|
|
719
|
-
:param custom_control: To return the action group invocation results directly in the ``
|
|
715
|
+
:param custom_control: To return the action group invocation results directly in the ``InvokeInlineAgent`` response, specify ``RETURN_CONTROL`` .
|
|
720
716
|
:param lambda_: The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
|
|
721
717
|
|
|
722
718
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html
|
|
@@ -745,7 +741,7 @@ class CfnAgent(
|
|
|
745
741
|
|
|
746
742
|
@builtins.property
|
|
747
743
|
def custom_control(self) -> typing.Optional[builtins.str]:
|
|
748
|
-
'''To return the action group invocation results directly in the ``
|
|
744
|
+
'''To return the action group invocation results directly in the ``InvokeInlineAgent`` response, specify ``RETURN_CONTROL`` .
|
|
749
745
|
|
|
750
746
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html#cfn-bedrock-agent-actiongroupexecutor-customcontrol
|
|
751
747
|
'''
|
|
@@ -799,14 +795,14 @@ class CfnAgent(
|
|
|
799
795
|
parent_action_group_signature: typing.Optional[builtins.str] = None,
|
|
800
796
|
skip_resource_in_use_check_on_delete: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
801
797
|
) -> None:
|
|
802
|
-
'''Contains details
|
|
798
|
+
'''Contains details of the inline agent's action group.
|
|
803
799
|
|
|
804
800
|
:param action_group_name: The name of the action group.
|
|
805
801
|
:param action_group_executor: The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
|
|
806
802
|
:param action_group_state: Specifies whether the action group is available for the agent to invoke or not when sending an `InvokeAgent <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html>`_ request.
|
|
807
|
-
:param api_schema: Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com
|
|
808
|
-
:param description:
|
|
809
|
-
:param function_schema:
|
|
803
|
+
:param api_schema: Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
804
|
+
:param description: A description of the action group.
|
|
805
|
+
:param function_schema: Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
810
806
|
:param parent_action_group_signature: If this field is set as ``AMAZON.UserInput`` , the agent can request the user for additional information when trying to complete a task. The ``description`` , ``apiSchema`` , and ``actionGroupExecutor`` fields must be blank for this action group. During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an `Observation <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html>`_ reprompting the user for more information.
|
|
811
807
|
:param skip_resource_in_use_check_on_delete: Specifies whether to delete the resource even if it's in use. By default, this value is ``false`` . Default: - false
|
|
812
808
|
|
|
@@ -921,7 +917,7 @@ class CfnAgent(
|
|
|
921
917
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAgent.APISchemaProperty"]]:
|
|
922
918
|
'''Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
923
919
|
|
|
924
|
-
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com
|
|
920
|
+
For more information, see `Action group OpenAPI schemas <https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html>`_ .
|
|
925
921
|
|
|
926
922
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema
|
|
927
923
|
'''
|
|
@@ -930,7 +926,7 @@ class CfnAgent(
|
|
|
930
926
|
|
|
931
927
|
@builtins.property
|
|
932
928
|
def description(self) -> typing.Optional[builtins.str]:
|
|
933
|
-
'''
|
|
929
|
+
'''A description of the action group.
|
|
934
930
|
|
|
935
931
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-description
|
|
936
932
|
'''
|
|
@@ -941,9 +937,7 @@ class CfnAgent(
|
|
|
941
937
|
def function_schema(
|
|
942
938
|
self,
|
|
943
939
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAgent.FunctionSchemaProperty"]]:
|
|
944
|
-
'''
|
|
945
|
-
|
|
946
|
-
Each function represents an action in an action group.
|
|
940
|
+
'''Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
947
941
|
|
|
948
942
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-functionschema
|
|
949
943
|
'''
|
|
@@ -1202,17 +1196,7 @@ class CfnAgent(
|
|
|
1202
1196
|
*,
|
|
1203
1197
|
functions: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAgent.FunctionProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
1204
1198
|
) -> None:
|
|
1205
|
-
'''
|
|
1206
|
-
|
|
1207
|
-
Each function represents an action in an action group.
|
|
1208
|
-
|
|
1209
|
-
This data type is used in the following API operations:
|
|
1210
|
-
|
|
1211
|
-
- `CreateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax>`_
|
|
1212
|
-
- `CreateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax>`_
|
|
1213
|
-
- `UpdateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax>`_
|
|
1214
|
-
- `UpdateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax>`_
|
|
1215
|
-
- `GetAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax>`_
|
|
1199
|
+
'''Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
1216
1200
|
|
|
1217
1201
|
:param functions: A list of functions that each define an action in the action group.
|
|
1218
1202
|
|
|
@@ -1500,14 +1484,6 @@ class CfnAgent(
|
|
|
1500
1484
|
) -> None:
|
|
1501
1485
|
'''Contains details about a parameter in a function for an action group.
|
|
1502
1486
|
|
|
1503
|
-
This data type is used in the following API operations:
|
|
1504
|
-
|
|
1505
|
-
- `CreateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax>`_
|
|
1506
|
-
- `CreateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax>`_
|
|
1507
|
-
- `UpdateAgentActionGroup request <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax>`_
|
|
1508
|
-
- `UpdateAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax>`_
|
|
1509
|
-
- `GetAgentActionGroup response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax>`_
|
|
1510
|
-
|
|
1511
1487
|
:param type: The data type of the parameter.
|
|
1512
1488
|
:param description: A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
|
|
1513
1489
|
:param required: Whether the parameter is required for the agent to complete the function for action group invocation.
|
|
@@ -1616,7 +1592,7 @@ class CfnAgent(
|
|
|
1616
1592
|
:param inference_configuration: Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the ``promptType`` . For more information, see `Inference parameters for foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html>`_ .
|
|
1617
1593
|
:param parser_mode: Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the ``promptType`` . If you set the field as ``OVERRIDEN`` , the ``overrideLambda`` field in the `PromptOverrideConfiguration <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html>`_ must be specified with the ARN of a Lambda function.
|
|
1618
1594
|
:param prompt_creation_mode: Specifies whether to override the default prompt template for this ``promptType`` . Set this value to ``OVERRIDDEN`` to use the prompt that you provide in the ``basePromptTemplate`` . If you leave it as ``DEFAULT`` , the agent uses a default prompt template.
|
|
1619
|
-
:param prompt_state: Specifies whether to allow the agent to carry out the step specified in the ``promptType`` . If you set this value to ``DISABLED`` , the agent skips that step. The default state for each ``promptType`` is as follows. - ``PRE_PROCESSING`` – ``ENABLED`` - ``ORCHESTRATION`` – ``ENABLED`` - ``KNOWLEDGE_BASE_RESPONSE_GENERATION`` – ``ENABLED`` - ``POST_PROCESSING`` – ``DISABLED``
|
|
1595
|
+
:param prompt_state: Specifies whether to allow the inline agent to carry out the step specified in the ``promptType`` . If you set this value to ``DISABLED`` , the agent skips that step. The default state for each ``promptType`` is as follows. - ``PRE_PROCESSING`` – ``ENABLED`` - ``ORCHESTRATION`` – ``ENABLED`` - ``KNOWLEDGE_BASE_RESPONSE_GENERATION`` – ``ENABLED`` - ``POST_PROCESSING`` – ``DISABLED``
|
|
1620
1596
|
:param prompt_type: The step in the agent sequence that this prompt configuration applies to.
|
|
1621
1597
|
|
|
1622
1598
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html
|
|
@@ -1713,7 +1689,7 @@ class CfnAgent(
|
|
|
1713
1689
|
|
|
1714
1690
|
@builtins.property
|
|
1715
1691
|
def prompt_state(self) -> typing.Optional[builtins.str]:
|
|
1716
|
-
'''Specifies whether to allow the agent to carry out the step specified in the ``promptType`` .
|
|
1692
|
+
'''Specifies whether to allow the inline agent to carry out the step specified in the ``promptType`` .
|
|
1717
1693
|
|
|
1718
1694
|
If you set this value to ``DISABLED`` , the agent skips that step. The default state for each ``promptType`` is as follows.
|
|
1719
1695
|
|
|
@@ -16779,7 +16755,7 @@ class CfnKnowledgeBase(
|
|
|
16779
16755
|
:param name: The name of the knowledge base.
|
|
16780
16756
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
|
|
16781
16757
|
:param storage_configuration: Contains details about the storage configuration of the knowledge base.
|
|
16782
|
-
:param description: The description of the knowledge base.
|
|
16758
|
+
:param description: The description of the knowledge base associated with the inline agent.
|
|
16783
16759
|
:param tags: Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
16784
16760
|
'''
|
|
16785
16761
|
if __debug__:
|
|
@@ -16857,7 +16833,7 @@ class CfnKnowledgeBase(
|
|
|
16857
16833
|
@builtins.property
|
|
16858
16834
|
@jsii.member(jsii_name="attrKnowledgeBaseId")
|
|
16859
16835
|
def attr_knowledge_base_id(self) -> builtins.str:
|
|
16860
|
-
'''The unique identifier
|
|
16836
|
+
'''The unique identifier for a knowledge base associated with the inline agent.
|
|
16861
16837
|
|
|
16862
16838
|
:cloudformationAttribute: KnowledgeBaseId
|
|
16863
16839
|
'''
|
|
@@ -16957,7 +16933,7 @@ class CfnKnowledgeBase(
|
|
|
16957
16933
|
@builtins.property
|
|
16958
16934
|
@jsii.member(jsii_name="description")
|
|
16959
16935
|
def description(self) -> typing.Optional[builtins.str]:
|
|
16960
|
-
'''The description of the knowledge base.'''
|
|
16936
|
+
'''The description of the knowledge base associated with the inline agent.'''
|
|
16961
16937
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
16962
16938
|
|
|
16963
16939
|
@description.setter
|
|
@@ -18059,7 +18035,7 @@ class CfnKnowledgeBaseProps:
|
|
|
18059
18035
|
:param name: The name of the knowledge base.
|
|
18060
18036
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
|
|
18061
18037
|
:param storage_configuration: Contains details about the storage configuration of the knowledge base.
|
|
18062
|
-
:param description: The description of the knowledge base.
|
|
18038
|
+
:param description: The description of the knowledge base associated with the inline agent.
|
|
18063
18039
|
:param tags: Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - `Tag naming limits and requirements <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions>`_ - `Tagging best practices <https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices>`_
|
|
18064
18040
|
|
|
18065
18041
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html
|
|
@@ -18197,7 +18173,7 @@ class CfnKnowledgeBaseProps:
|
|
|
18197
18173
|
|
|
18198
18174
|
@builtins.property
|
|
18199
18175
|
def description(self) -> typing.Optional[builtins.str]:
|
|
18200
|
-
'''The description of the knowledge base.
|
|
18176
|
+
'''The description of the knowledge base associated with the inline agent.
|
|
18201
18177
|
|
|
18202
18178
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-description
|
|
18203
18179
|
'''
|
|
@@ -20291,6 +20267,12 @@ class FoundationModelIdentifier(
|
|
|
20291
20267
|
'''Base model "amazon.nova-reel-v1:0".'''
|
|
20292
20268
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_NOVA_REEL_V1_0"))
|
|
20293
20269
|
|
|
20270
|
+
@jsii.python.classproperty
|
|
20271
|
+
@jsii.member(jsii_name="AMAZON_RERANK_V1")
|
|
20272
|
+
def AMAZON_RERANK_V1(cls) -> "FoundationModelIdentifier":
|
|
20273
|
+
'''Base model "amazon.rerank-v1:0".'''
|
|
20274
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "AMAZON_RERANK_V1"))
|
|
20275
|
+
|
|
20294
20276
|
@jsii.python.classproperty
|
|
20295
20277
|
@jsii.member(jsii_name="AMAZON_TITAN_EMBED_G1_TEXT_02")
|
|
20296
20278
|
def AMAZON_TITAN_EMBED_G1_TEXT_02(cls) -> "FoundationModelIdentifier":
|
|
@@ -20578,6 +20560,12 @@ class FoundationModelIdentifier(
|
|
|
20578
20560
|
'''Base model "cohere.embed-multilingual-v3:0:512".'''
|
|
20579
20561
|
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "COHERE_EMBED_MULTILINGUAL_V3_0_512"))
|
|
20580
20562
|
|
|
20563
|
+
@jsii.python.classproperty
|
|
20564
|
+
@jsii.member(jsii_name="COHERE_RERANK_V3_5")
|
|
20565
|
+
def COHERE_RERANK_V3_5(cls) -> "FoundationModelIdentifier":
|
|
20566
|
+
'''Base model "cohere.rerank-v3-5:0".'''
|
|
20567
|
+
return typing.cast("FoundationModelIdentifier", jsii.sget(cls, "COHERE_RERANK_V3_5"))
|
|
20568
|
+
|
|
20581
20569
|
@jsii.python.classproperty
|
|
20582
20570
|
@jsii.member(jsii_name="META_LLAMA_2_13B_CHAT_V1_0_4K")
|
|
20583
20571
|
def META_LLAMA_2_13_B_CHAT_V1_0_4_K(cls) -> "FoundationModelIdentifier":
|