aws-sdk-bedrockagent 1.4.0 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5e55f4e9dbac237e10a442cfe52ce159403aefe67d887d5c1ff064ee254d0bfc
4
- data.tar.gz: 921863e83864cec6455f9573fb3faba4460072b50e734902776bbefd12fcb636
3
+ metadata.gz: 4143ef9fc133a2aa9e2e22ab708a4cb72745bc76f1cd11abe0ac678d5650d6f0
4
+ data.tar.gz: cf65e144ace6118b6f5df92b22f0890281f2ae19dc8f1546a575d19e8b2b8ffa
5
5
  SHA512:
6
- metadata.gz: b3a40e8f0ca0233154eea5a994d84a0d1419e1eb0765b0ec10259a87eec8535934778358572c7d94d23e7d2d43932439f6885a4912c8a2ebac0a867303fc3634
7
- data.tar.gz: c30f3e73e63b04a8634247922a69ff6cc49de93790f821fc30d98df92329517f17b0cc15bbc4952e6caede6c14709e5eb371d348db7a0409469198fe4e0f1d97
6
+ metadata.gz: 232bbcb77048085704f02652b46fcf8ff483c89c1274cfcdf5279d9911a50a077ff9427c847960517e46d5fbdd756849bd7a882898aef9df89052ef000648433
7
+ data.tar.gz: d26a5cb5f8b3a0601b0a5fd7f89c48c181a0dfdc4616cc496f56a3d75154de4fe175b1702e8981a57dfedea5e16950160acfd1ca59a9584049fa6433ed33e064
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.6.0 (2024-04-22)
5
+ ------------------
6
+
7
+ * Feature - Releasing the support for simplified configuration and return of control
8
+
9
+ 1.5.0 (2024-04-16)
10
+ ------------------
11
+
12
+ * Feature - For Create Agent API, the agentResourceRoleArn parameter is no longer required.
13
+
4
14
  1.4.0 (2024-03-27)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.4.0
1
+ 1.6.0
@@ -455,11 +455,11 @@ module Aws::BedrockAgent
455
455
  #
456
456
  # * Specify the following fields for security purposes.
457
457
  #
458
- # * `agentResourceRoleArn` – The ARN of the role with permissions to
459
- # create an agent.
458
+ # * `agentResourceRoleArn` – The Amazon Resource Name (ARN) of the
459
+ # role with permissions to invoke API operations on an agent.
460
460
  #
461
- # * (Optional) `customerEncryptionKeyArn` – The ARN of a KMS key to
462
- # encrypt the creation of the agent.
461
+ # * (Optional) `customerEncryptionKeyArn` – The Amazon Resource Name
462
+ # (ARN) of a KMS key to encrypt the creation of the agent.
463
463
  #
464
464
  # * (Optional) `idleSessionTTLinSeconds` – Specify the number of
465
465
  # seconds for which the agent should maintain session information.
@@ -481,9 +481,9 @@ module Aws::BedrockAgent
481
481
  # @option params [required, String] :agent_name
482
482
  # A name for the agent that you create.
483
483
  #
484
- # @option params [required, String] :agent_resource_role_arn
485
- # The ARN of the IAM role with permissions to create the agent. The ARN
486
- # must begin with `AmazonBedrockExecutionRoleForAgents_`.
484
+ # @option params [String] :agent_resource_role_arn
485
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
486
+ # invoke API operations on the agent.
487
487
  #
488
488
  # @option params [String] :client_token
489
489
  # A unique, case-sensitive identifier to ensure that the API request
@@ -499,7 +499,8 @@ module Aws::BedrockAgent
499
499
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
500
500
  #
501
501
  # @option params [String] :customer_encryption_key_arn
502
- # The ARN of the KMS key with which to encrypt the agent.
502
+ # The Amazon Resource Name (ARN) of the KMS key with which to encrypt
503
+ # the agent.
503
504
  #
504
505
  # @option params [String] :description
505
506
  # A description of the agent.
@@ -539,7 +540,7 @@ module Aws::BedrockAgent
539
540
  #
540
541
  # resp = client.create_agent({
541
542
  # agent_name: "Name", # required
542
- # agent_resource_role_arn: "AgentRoleArn", # required
543
+ # agent_resource_role_arn: "AgentRoleArn",
543
544
  # client_token: "ClientToken",
544
545
  # customer_encryption_key_arn: "KmsKeyArn",
545
546
  # description: "Description",
@@ -633,8 +634,8 @@ module Aws::BedrockAgent
633
634
  # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
634
635
  #
635
636
  # @option params [Types::ActionGroupExecutor] :action_group_executor
636
- # The ARN of the Lambda function containing the business logic that is
637
- # carried out upon invoking the action.
637
+ # The Amazon Resource Name (ARN) of the Lambda function containing the
638
+ # business logic that is carried out upon invoking the action.
638
639
  #
639
640
  # @option params [required, String] :action_group_name
640
641
  # The name to give the action group.
@@ -680,6 +681,10 @@ module Aws::BedrockAgent
680
681
  # @option params [String] :description
681
682
  # A description of the action group.
682
683
  #
684
+ # @option params [Types::FunctionSchema] :function_schema
685
+ # Contains details about the function schema for the action group or the
686
+ # JSON or YAML-formatted payload defining the schema.
687
+ #
683
688
  # @option params [String] :parent_action_group_signature
684
689
  # To allow your agent to request the user for additional information
685
690
  # when trying to complete a task, set this field to `AMAZON.UserInput`.
@@ -703,6 +708,7 @@ module Aws::BedrockAgent
703
708
  #
704
709
  # resp = client.create_agent_action_group({
705
710
  # action_group_executor: {
711
+ # custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
706
712
  # lambda: "LambdaArn",
707
713
  # },
708
714
  # action_group_name: "Name", # required
@@ -718,11 +724,27 @@ module Aws::BedrockAgent
718
724
  # },
719
725
  # client_token: "ClientToken",
720
726
  # description: "Description",
727
+ # function_schema: {
728
+ # functions: [
729
+ # {
730
+ # description: "FunctionDescription",
731
+ # name: "Name", # required
732
+ # parameters: {
733
+ # "Name" => {
734
+ # description: "ParameterDescription",
735
+ # required: false,
736
+ # type: "string", # required, accepts string, number, integer, boolean, array
737
+ # },
738
+ # },
739
+ # },
740
+ # ],
741
+ # },
721
742
  # parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
722
743
  # })
723
744
  #
724
745
  # @example Response structure
725
746
  #
747
+ # resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
726
748
  # resp.agent_action_group.action_group_executor.lambda #=> String
727
749
  # resp.agent_action_group.action_group_id #=> String
728
750
  # resp.agent_action_group.action_group_name #=> String
@@ -735,6 +757,13 @@ module Aws::BedrockAgent
735
757
  # resp.agent_action_group.client_token #=> String
736
758
  # resp.agent_action_group.created_at #=> Time
737
759
  # resp.agent_action_group.description #=> String
760
+ # resp.agent_action_group.function_schema.functions #=> Array
761
+ # resp.agent_action_group.function_schema.functions[0].description #=> String
762
+ # resp.agent_action_group.function_schema.functions[0].name #=> String
763
+ # resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
764
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
765
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
766
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
738
767
  # resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
739
768
  # resp.agent_action_group.updated_at #=> Time
740
769
  #
@@ -936,8 +965,8 @@ module Aws::BedrockAgent
936
965
  #
937
966
  # * Provide the `name` and an optional `description`.
938
967
  #
939
- # * Provide the ARN with permissions to create a knowledge base in the
940
- # `roleArn` field.
968
+ # * Provide the Amazon Resource Name (ARN) with permissions to create a
969
+ # knowledge base in the `roleArn` field.
941
970
  #
942
971
  # * Provide the embedding model to use in the `embeddingModelArn` field
943
972
  # in the `knowledgeBaseConfiguration` object.
@@ -993,7 +1022,8 @@ module Aws::BedrockAgent
993
1022
  # A name for the knowledge base.
994
1023
  #
995
1024
  # @option params [required, String] :role_arn
996
- # The ARN of the IAM role with permissions to create the knowledge base.
1025
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
1026
+ # invoke API operations on the knowledge base.
997
1027
  #
998
1028
  # @option params [required, Types::StorageConfiguration] :storage_configuration
999
1029
  # Contains details about the configuration of the vector database used
@@ -1457,6 +1487,7 @@ module Aws::BedrockAgent
1457
1487
  #
1458
1488
  # @example Response structure
1459
1489
  #
1490
+ # resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
1460
1491
  # resp.agent_action_group.action_group_executor.lambda #=> String
1461
1492
  # resp.agent_action_group.action_group_id #=> String
1462
1493
  # resp.agent_action_group.action_group_name #=> String
@@ -1469,6 +1500,13 @@ module Aws::BedrockAgent
1469
1500
  # resp.agent_action_group.client_token #=> String
1470
1501
  # resp.agent_action_group.created_at #=> Time
1471
1502
  # resp.agent_action_group.description #=> String
1503
+ # resp.agent_action_group.function_schema.functions #=> Array
1504
+ # resp.agent_action_group.function_schema.functions[0].description #=> String
1505
+ # resp.agent_action_group.function_schema.functions[0].name #=> String
1506
+ # resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
1507
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
1508
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
1509
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
1472
1510
  # resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
1473
1511
  # resp.agent_action_group.updated_at #=> Time
1474
1512
  #
@@ -2254,7 +2292,7 @@ module Aws::BedrockAgent
2254
2292
  # List all the tags for the resource you specify.
2255
2293
  #
2256
2294
  # @option params [required, String] :resource_arn
2257
- # The ARN of the resource for which to list tags.
2295
+ # The Amazon Resource Name (ARN) of the resource for which to list tags.
2258
2296
  #
2259
2297
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2260
2298
  #
@@ -2391,7 +2429,7 @@ module Aws::BedrockAgent
2391
2429
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
2392
2430
  #
2393
2431
  # @option params [required, String] :resource_arn
2394
- # The ARN of the resource to tag.
2432
+ # The Amazon Resource Name (ARN) of the resource to tag.
2395
2433
  #
2396
2434
  # @option params [required, Hash<String,String>] :tags
2397
2435
  # An object containing key-value pairs that define the tags to attach to
@@ -2420,7 +2458,8 @@ module Aws::BedrockAgent
2420
2458
  # Remove tags from a resource.
2421
2459
  #
2422
2460
  # @option params [required, String] :resource_arn
2423
- # The ARN of the resource from which to remove tags.
2461
+ # The Amazon Resource Name (ARN) of the resource from which to remove
2462
+ # tags.
2424
2463
  #
2425
2464
  # @option params [required, Array<String>] :tag_keys
2426
2465
  # A list of keys of the tags to remove from the resource.
@@ -2452,11 +2491,12 @@ module Aws::BedrockAgent
2452
2491
  # Specifies a new name for the agent.
2453
2492
  #
2454
2493
  # @option params [required, String] :agent_resource_role_arn
2455
- # The ARN of the IAM role with permissions to update the agent. The ARN
2456
- # must begin with `AmazonBedrockExecutionRoleForAgents_`.
2494
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
2495
+ # invoke API operations on the agent.
2457
2496
  #
2458
2497
  # @option params [String] :customer_encryption_key_arn
2459
- # The ARN of the KMS key with which to encrypt the agent.
2498
+ # The Amazon Resource Name (ARN) of the KMS key with which to encrypt
2499
+ # the agent.
2460
2500
  #
2461
2501
  # @option params [String] :description
2462
2502
  # Specifies a new description of the agent.
@@ -2568,8 +2608,8 @@ module Aws::BedrockAgent
2568
2608
  # Updates the configuration for an action group for an agent.
2569
2609
  #
2570
2610
  # @option params [Types::ActionGroupExecutor] :action_group_executor
2571
- # The ARN of the Lambda function containing the business logic that is
2572
- # carried out upon invoking the action.
2611
+ # The Amazon Resource Name (ARN) of the Lambda function containing the
2612
+ # business logic that is carried out upon invoking the action.
2573
2613
  #
2574
2614
  # @option params [required, String] :action_group_id
2575
2615
  # The unique identifier of the action group.
@@ -2606,6 +2646,10 @@ module Aws::BedrockAgent
2606
2646
  # @option params [String] :description
2607
2647
  # Specifies a new name for the action group.
2608
2648
  #
2649
+ # @option params [Types::FunctionSchema] :function_schema
2650
+ # Contains details about the function schema for the action group or the
2651
+ # JSON or YAML-formatted payload defining the schema.
2652
+ #
2609
2653
  # @option params [String] :parent_action_group_signature
2610
2654
  # To allow your agent to request the user for additional information
2611
2655
  # when trying to complete a task, set this field to `AMAZON.UserInput`.
@@ -2629,6 +2673,7 @@ module Aws::BedrockAgent
2629
2673
  #
2630
2674
  # resp = client.update_agent_action_group({
2631
2675
  # action_group_executor: {
2676
+ # custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
2632
2677
  # lambda: "LambdaArn",
2633
2678
  # },
2634
2679
  # action_group_id: "Id", # required
@@ -2644,11 +2689,27 @@ module Aws::BedrockAgent
2644
2689
  # },
2645
2690
  # },
2646
2691
  # description: "Description",
2692
+ # function_schema: {
2693
+ # functions: [
2694
+ # {
2695
+ # description: "FunctionDescription",
2696
+ # name: "Name", # required
2697
+ # parameters: {
2698
+ # "Name" => {
2699
+ # description: "ParameterDescription",
2700
+ # required: false,
2701
+ # type: "string", # required, accepts string, number, integer, boolean, array
2702
+ # },
2703
+ # },
2704
+ # },
2705
+ # ],
2706
+ # },
2647
2707
  # parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
2648
2708
  # })
2649
2709
  #
2650
2710
  # @example Response structure
2651
2711
  #
2712
+ # resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
2652
2713
  # resp.agent_action_group.action_group_executor.lambda #=> String
2653
2714
  # resp.agent_action_group.action_group_id #=> String
2654
2715
  # resp.agent_action_group.action_group_name #=> String
@@ -2661,6 +2722,13 @@ module Aws::BedrockAgent
2661
2722
  # resp.agent_action_group.client_token #=> String
2662
2723
  # resp.agent_action_group.created_at #=> Time
2663
2724
  # resp.agent_action_group.description #=> String
2725
+ # resp.agent_action_group.function_schema.functions #=> Array
2726
+ # resp.agent_action_group.function_schema.functions[0].description #=> String
2727
+ # resp.agent_action_group.function_schema.functions[0].name #=> String
2728
+ # resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
2729
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
2730
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
2731
+ # resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
2664
2732
  # resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
2665
2733
  # resp.agent_action_group.updated_at #=> Time
2666
2734
  #
@@ -2919,7 +2987,7 @@ module Aws::BedrockAgent
2919
2987
  #
2920
2988
  # @option params [required, String] :role_arn
2921
2989
  # Specifies a different Amazon Resource Name (ARN) of the IAM role with
2922
- # permissions to modify the knowledge base.
2990
+ # permissions to invoke API operations on the knowledge base.
2923
2991
  #
2924
2992
  # @option params [required, Types::StorageConfiguration] :storage_configuration
2925
2993
  # Specifies the configuration for the vector store used for the
@@ -3050,7 +3118,7 @@ module Aws::BedrockAgent
3050
3118
  params: params,
3051
3119
  config: config)
3052
3120
  context[:gem_name] = 'aws-sdk-bedrockagent'
3053
- context[:gem_version] = '1.4.0'
3121
+ context[:gem_version] = '1.6.0'
3054
3122
  Seahorse::Client::Request.new(handlers, context)
3055
3123
  end
3056
3124
 
@@ -64,6 +64,7 @@ module Aws::BedrockAgent
64
64
  CreateKnowledgeBaseRequest = Shapes::StructureShape.new(name: 'CreateKnowledgeBaseRequest')
65
65
  CreateKnowledgeBaseResponse = Shapes::StructureShape.new(name: 'CreateKnowledgeBaseResponse')
66
66
  CreationMode = Shapes::StringShape.new(name: 'CreationMode')
67
+ CustomControlMethod = Shapes::StringShape.new(name: 'CustomControlMethod')
67
68
  DataSource = Shapes::StructureShape.new(name: 'DataSource')
68
69
  DataSourceConfiguration = Shapes::StructureShape.new(name: 'DataSourceConfiguration')
69
70
  DataSourceStatus = Shapes::StringShape.new(name: 'DataSourceStatus')
@@ -93,6 +94,10 @@ module Aws::BedrockAgent
93
94
  FixedSizeChunkingConfiguration = Shapes::StructureShape.new(name: 'FixedSizeChunkingConfiguration')
94
95
  FixedSizeChunkingConfigurationMaxTokensInteger = Shapes::IntegerShape.new(name: 'FixedSizeChunkingConfigurationMaxTokensInteger')
95
96
  FixedSizeChunkingConfigurationOverlapPercentageInteger = Shapes::IntegerShape.new(name: 'FixedSizeChunkingConfigurationOverlapPercentageInteger')
97
+ Function = Shapes::StructureShape.new(name: 'Function')
98
+ FunctionDescription = Shapes::StringShape.new(name: 'FunctionDescription')
99
+ FunctionSchema = Shapes::UnionShape.new(name: 'FunctionSchema')
100
+ Functions = Shapes::ListShape.new(name: 'Functions')
96
101
  GetAgentActionGroupRequest = Shapes::StructureShape.new(name: 'GetAgentActionGroupRequest')
97
102
  GetAgentActionGroupResponse = Shapes::StructureShape.new(name: 'GetAgentActionGroupResponse')
98
103
  GetAgentAliasRequest = Shapes::StructureShape.new(name: 'GetAgentAliasRequest')
@@ -167,6 +172,9 @@ module Aws::BedrockAgent
167
172
  OpenSearchServerlessConfiguration = Shapes::StructureShape.new(name: 'OpenSearchServerlessConfiguration')
168
173
  OpenSearchServerlessFieldMapping = Shapes::StructureShape.new(name: 'OpenSearchServerlessFieldMapping')
169
174
  OpenSearchServerlessIndexName = Shapes::StringShape.new(name: 'OpenSearchServerlessIndexName')
175
+ ParameterDescription = Shapes::StringShape.new(name: 'ParameterDescription')
176
+ ParameterDetail = Shapes::StructureShape.new(name: 'ParameterDetail')
177
+ ParameterMap = Shapes::MapShape.new(name: 'ParameterMap')
170
178
  Payload = Shapes::StringShape.new(name: 'Payload')
171
179
  PineconeConfiguration = Shapes::StructureShape.new(name: 'PineconeConfiguration')
172
180
  PineconeConnectionString = Shapes::StringShape.new(name: 'PineconeConnectionString')
@@ -220,6 +228,7 @@ module Aws::BedrockAgent
220
228
  ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
221
229
  TopK = Shapes::IntegerShape.new(name: 'TopK')
222
230
  TopP = Shapes::FloatShape.new(name: 'TopP')
231
+ Type = Shapes::StringShape.new(name: 'Type')
223
232
  UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
224
233
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
225
234
  UpdateAgentActionGroupRequest = Shapes::StructureShape.new(name: 'UpdateAgentActionGroupRequest')
@@ -252,8 +261,10 @@ module Aws::BedrockAgent
252
261
  AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
253
262
  AccessDeniedException.struct_class = Types::AccessDeniedException
254
263
 
264
+ ActionGroupExecutor.add_member(:custom_control, Shapes::ShapeRef.new(shape: CustomControlMethod, location_name: "customControl"))
255
265
  ActionGroupExecutor.add_member(:lambda, Shapes::ShapeRef.new(shape: LambdaArn, location_name: "lambda"))
256
266
  ActionGroupExecutor.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
267
+ ActionGroupExecutor.add_member_subclass(:custom_control, Types::ActionGroupExecutor::CustomControl)
257
268
  ActionGroupExecutor.add_member_subclass(:lambda, Types::ActionGroupExecutor::Lambda)
258
269
  ActionGroupExecutor.add_member_subclass(:unknown, Types::ActionGroupExecutor::Unknown)
259
270
  ActionGroupExecutor.struct_class = Types::ActionGroupExecutor
@@ -297,6 +308,7 @@ module Aws::BedrockAgent
297
308
  AgentActionGroup.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken"))
298
309
  AgentActionGroup.add_member(:created_at, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "createdAt"))
299
310
  AgentActionGroup.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
311
+ AgentActionGroup.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
300
312
  AgentActionGroup.add_member(:parent_action_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionSignature"))
301
313
  AgentActionGroup.add_member(:updated_at, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "updatedAt"))
302
314
  AgentActionGroup.struct_class = Types::AgentActionGroup
@@ -417,6 +429,7 @@ module Aws::BedrockAgent
417
429
  CreateAgentActionGroupRequest.add_member(:api_schema, Shapes::ShapeRef.new(shape: APISchema, location_name: "apiSchema"))
418
430
  CreateAgentActionGroupRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
419
431
  CreateAgentActionGroupRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
432
+ CreateAgentActionGroupRequest.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
420
433
  CreateAgentActionGroupRequest.add_member(:parent_action_group_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionGroupSignature"))
421
434
  CreateAgentActionGroupRequest.struct_class = Types::CreateAgentActionGroupRequest
422
435
 
@@ -435,7 +448,7 @@ module Aws::BedrockAgent
435
448
  CreateAgentAliasResponse.struct_class = Types::CreateAgentAliasResponse
436
449
 
437
450
  CreateAgentRequest.add_member(:agent_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "agentName"))
438
- CreateAgentRequest.add_member(:agent_resource_role_arn, Shapes::ShapeRef.new(shape: AgentRoleArn, required: true, location_name: "agentResourceRoleArn"))
451
+ CreateAgentRequest.add_member(:agent_resource_role_arn, Shapes::ShapeRef.new(shape: AgentRoleArn, location_name: "agentResourceRoleArn"))
439
452
  CreateAgentRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
440
453
  CreateAgentRequest.add_member(:customer_encryption_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "customerEncryptionKeyArn"))
441
454
  CreateAgentRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
@@ -563,6 +576,19 @@ module Aws::BedrockAgent
563
576
  FixedSizeChunkingConfiguration.add_member(:overlap_percentage, Shapes::ShapeRef.new(shape: FixedSizeChunkingConfigurationOverlapPercentageInteger, required: true, location_name: "overlapPercentage"))
564
577
  FixedSizeChunkingConfiguration.struct_class = Types::FixedSizeChunkingConfiguration
565
578
 
579
+ Function.add_member(:description, Shapes::ShapeRef.new(shape: FunctionDescription, location_name: "description"))
580
+ Function.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
581
+ Function.add_member(:parameters, Shapes::ShapeRef.new(shape: ParameterMap, location_name: "parameters"))
582
+ Function.struct_class = Types::Function
583
+
584
+ FunctionSchema.add_member(:functions, Shapes::ShapeRef.new(shape: Functions, location_name: "functions"))
585
+ FunctionSchema.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
586
+ FunctionSchema.add_member_subclass(:functions, Types::FunctionSchema::Functions)
587
+ FunctionSchema.add_member_subclass(:unknown, Types::FunctionSchema::Unknown)
588
+ FunctionSchema.struct_class = Types::FunctionSchema
589
+
590
+ Functions.member = Shapes::ShapeRef.new(shape: Function)
591
+
566
592
  GetAgentActionGroupRequest.add_member(:action_group_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "actionGroupId"))
567
593
  GetAgentActionGroupRequest.add_member(:agent_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "agentId"))
568
594
  GetAgentActionGroupRequest.add_member(:agent_version, Shapes::ShapeRef.new(shape: Version, required: true, location: "uri", location_name: "agentVersion"))
@@ -792,6 +818,14 @@ module Aws::BedrockAgent
792
818
  OpenSearchServerlessFieldMapping.add_member(:vector_field, Shapes::ShapeRef.new(shape: FieldName, required: true, location_name: "vectorField"))
793
819
  OpenSearchServerlessFieldMapping.struct_class = Types::OpenSearchServerlessFieldMapping
794
820
 
821
+ ParameterDetail.add_member(:description, Shapes::ShapeRef.new(shape: ParameterDescription, location_name: "description"))
822
+ ParameterDetail.add_member(:required, Shapes::ShapeRef.new(shape: Boolean, location_name: "required"))
823
+ ParameterDetail.add_member(:type, Shapes::ShapeRef.new(shape: Type, required: true, location_name: "type"))
824
+ ParameterDetail.struct_class = Types::ParameterDetail
825
+
826
+ ParameterMap.key = Shapes::ShapeRef.new(shape: Name)
827
+ ParameterMap.value = Shapes::ShapeRef.new(shape: ParameterDetail)
828
+
795
829
  PineconeConfiguration.add_member(:connection_string, Shapes::ShapeRef.new(shape: PineconeConnectionString, required: true, location_name: "connectionString"))
796
830
  PineconeConfiguration.add_member(:credentials_secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "credentialsSecretArn"))
797
831
  PineconeConfiguration.add_member(:field_mapping, Shapes::ShapeRef.new(shape: PineconeFieldMapping, required: true, location_name: "fieldMapping"))
@@ -916,6 +950,7 @@ module Aws::BedrockAgent
916
950
  UpdateAgentActionGroupRequest.add_member(:agent_version, Shapes::ShapeRef.new(shape: DraftVersion, required: true, location: "uri", location_name: "agentVersion"))
917
951
  UpdateAgentActionGroupRequest.add_member(:api_schema, Shapes::ShapeRef.new(shape: APISchema, location_name: "apiSchema"))
918
952
  UpdateAgentActionGroupRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
953
+ UpdateAgentActionGroupRequest.add_member(:function_schema, Shapes::ShapeRef.new(shape: FunctionSchema, location_name: "functionSchema"))
919
954
  UpdateAgentActionGroupRequest.add_member(:parent_action_group_signature, Shapes::ShapeRef.new(shape: ActionGroupSignature, location_name: "parentActionGroupSignature"))
920
955
  UpdateAgentActionGroupRequest.struct_class = Types::UpdateAgentActionGroupRequest
921
956
 
@@ -79,20 +79,27 @@ module Aws::BedrockAgent
79
79
  #
80
80
  # @note ActionGroupExecutor is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ActionGroupExecutor corresponding to the set member.
81
81
  #
82
+ # @!attribute [rw] custom_control
83
+ # To return the action group invocation results directly in the
84
+ # `InvokeAgent` response, specify `RETURN_CONTROL`.
85
+ # @return [String]
86
+ #
82
87
  # @!attribute [rw] lambda
83
- # The ARN of the Lambda function containing the business logic that is
84
- # carried out upon invoking the action.
88
+ # The Amazon Resource Name (ARN) of the Lambda function containing the
89
+ # business logic that is carried out upon invoking the action.
85
90
  # @return [String]
86
91
  #
87
92
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ActionGroupExecutor AWS API Documentation
88
93
  #
89
94
  class ActionGroupExecutor < Struct.new(
95
+ :custom_control,
90
96
  :lambda,
91
97
  :unknown)
92
98
  SENSITIVE = []
93
99
  include Aws::Structure
94
100
  include Aws::Structure::Union
95
101
 
102
+ class CustomControl < ActionGroupExecutor; end
96
103
  class Lambda < ActionGroupExecutor; end
97
104
  class Unknown < ActionGroupExecutor; end
98
105
  end
@@ -139,7 +146,7 @@ module Aws::BedrockAgent
139
146
  # Contains details about an agent.
140
147
  #
141
148
  # @!attribute [rw] agent_arn
142
- # The ARN of the agent.
149
+ # The Amazon Resource Name (ARN) of the agent.
143
150
  # @return [String]
144
151
  #
145
152
  # @!attribute [rw] agent_id
@@ -151,9 +158,8 @@ module Aws::BedrockAgent
151
158
  # @return [String]
152
159
  #
153
160
  # @!attribute [rw] agent_resource_role_arn
154
- # The ARN of the IAM role with permissions to call API operations on
155
- # the agent. The ARN must begin with
156
- # `AmazonBedrockExecutionRoleForAgents_`.
161
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
162
+ # invoke API operations on the agent.
157
163
  # @return [String]
158
164
  #
159
165
  # @!attribute [rw] agent_status
@@ -195,7 +201,8 @@ module Aws::BedrockAgent
195
201
  # @return [Time]
196
202
  #
197
203
  # @!attribute [rw] customer_encryption_key_arn
198
- # The ARN of the KMS key that encrypts the agent.
204
+ # The Amazon Resource Name (ARN) of the KMS key that encrypts the
205
+ # agent.
199
206
  # @return [String]
200
207
  #
201
208
  # @!attribute [rw] description
@@ -275,8 +282,8 @@ module Aws::BedrockAgent
275
282
  # Contains details about an action group.
276
283
  #
277
284
  # @!attribute [rw] action_group_executor
278
- # The ARN of the Lambda function containing the business logic that is
279
- # carried out upon invoking the action.
285
+ # The Amazon Resource Name (ARN) of the Lambda function containing the
286
+ # business logic that is carried out upon invoking the action.
280
287
  # @return [Types::ActionGroupExecutor]
281
288
  #
282
289
  # @!attribute [rw] action_group_id
@@ -335,6 +342,12 @@ module Aws::BedrockAgent
335
342
  # The description of the action group.
336
343
  # @return [String]
337
344
  #
345
+ # @!attribute [rw] function_schema
346
+ # Defines functions that each define parameters that the agent needs
347
+ # to invoke from the user. Each function represents an action in an
348
+ # action group.
349
+ # @return [Types::FunctionSchema]
350
+ #
338
351
  # @!attribute [rw] parent_action_signature
339
352
  # If this field is set as `AMAZON.UserInput`, the agent can request
340
353
  # the user for additional information when trying to complete a task.
@@ -369,6 +382,7 @@ module Aws::BedrockAgent
369
382
  :client_token,
370
383
  :created_at,
371
384
  :description,
385
+ :function_schema,
372
386
  :parent_action_signature,
373
387
  :updated_at)
374
388
  SENSITIVE = []
@@ -378,7 +392,7 @@ module Aws::BedrockAgent
378
392
  # Contains details about an alias of an agent.
379
393
  #
380
394
  # @!attribute [rw] agent_alias_arn
381
- # The ARN of the alias of the agent.
395
+ # The Amazon Resource Name (ARN) of the alias of the agent.
382
396
  # @return [String]
383
397
  #
384
398
  # @!attribute [rw] agent_alias_history_events
@@ -678,7 +692,8 @@ module Aws::BedrockAgent
678
692
  # Contains details about a version of an agent.
679
693
  #
680
694
  # @!attribute [rw] agent_arn
681
- # The ARN of the agent that the version belongs to.
695
+ # The Amazon Resource Name (ARN) of the agent that the version belongs
696
+ # to.
682
697
  # @return [String]
683
698
  #
684
699
  # @!attribute [rw] agent_id
@@ -690,9 +705,8 @@ module Aws::BedrockAgent
690
705
  # @return [String]
691
706
  #
692
707
  # @!attribute [rw] agent_resource_role_arn
693
- # The ARN of the IAM role with permissions to invoke API operations on
694
- # the agent. The ARN must begin with
695
- # `AmazonBedrockExecutionRoleForAgents_`.
708
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
709
+ # invoke API operations on the agent.
696
710
  # @return [String]
697
711
  #
698
712
  # @!attribute [rw] agent_status
@@ -704,7 +718,8 @@ module Aws::BedrockAgent
704
718
  # @return [Time]
705
719
  #
706
720
  # @!attribute [rw] customer_encryption_key_arn
707
- # The ARN of the KMS key that encrypts the agent.
721
+ # The Amazon Resource Name (ARN) of the KMS key that encrypts the
722
+ # agent.
708
723
  # @return [String]
709
724
  #
710
725
  # @!attribute [rw] description
@@ -919,8 +934,8 @@ module Aws::BedrockAgent
919
934
  end
920
935
 
921
936
  # @!attribute [rw] action_group_executor
922
- # The ARN of the Lambda function containing the business logic that is
923
- # carried out upon invoking the action.
937
+ # The Amazon Resource Name (ARN) of the Lambda function containing the
938
+ # business logic that is carried out upon invoking the action.
924
939
  # @return [Types::ActionGroupExecutor]
925
940
  #
926
941
  # @!attribute [rw] action_group_name
@@ -974,6 +989,11 @@ module Aws::BedrockAgent
974
989
  # A description of the action group.
975
990
  # @return [String]
976
991
  #
992
+ # @!attribute [rw] function_schema
993
+ # Contains details about the function schema for the action group or
994
+ # the JSON or YAML-formatted payload defining the schema.
995
+ # @return [Types::FunctionSchema]
996
+ #
977
997
  # @!attribute [rw] parent_action_group_signature
978
998
  # To allow your agent to request the user for additional information
979
999
  # when trying to complete a task, set this field to
@@ -1002,6 +1022,7 @@ module Aws::BedrockAgent
1002
1022
  :api_schema,
1003
1023
  :client_token,
1004
1024
  :description,
1025
+ :function_schema,
1005
1026
  :parent_action_group_signature)
1006
1027
  SENSITIVE = []
1007
1028
  include Aws::Structure
@@ -1083,8 +1104,8 @@ module Aws::BedrockAgent
1083
1104
  # @return [String]
1084
1105
  #
1085
1106
  # @!attribute [rw] agent_resource_role_arn
1086
- # The ARN of the IAM role with permissions to create the agent. The
1087
- # ARN must begin with `AmazonBedrockExecutionRoleForAgents_`.
1107
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
1108
+ # invoke API operations on the agent.
1088
1109
  # @return [String]
1089
1110
  #
1090
1111
  # @!attribute [rw] client_token
@@ -1102,7 +1123,8 @@ module Aws::BedrockAgent
1102
1123
  # @return [String]
1103
1124
  #
1104
1125
  # @!attribute [rw] customer_encryption_key_arn
1105
- # The ARN of the KMS key with which to encrypt the agent.
1126
+ # The Amazon Resource Name (ARN) of the KMS key with which to encrypt
1127
+ # the agent.
1106
1128
  # @return [String]
1107
1129
  #
1108
1130
  # @!attribute [rw] description
@@ -1265,8 +1287,8 @@ module Aws::BedrockAgent
1265
1287
  # @return [String]
1266
1288
  #
1267
1289
  # @!attribute [rw] role_arn
1268
- # The ARN of the IAM role with permissions to create the knowledge
1269
- # base.
1290
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
1291
+ # invoke API operations on the knowledge base.
1270
1292
  # @return [String]
1271
1293
  #
1272
1294
  # @!attribute [rw] storage_configuration
@@ -1705,6 +1727,97 @@ module Aws::BedrockAgent
1705
1727
  include Aws::Structure
1706
1728
  end
1707
1729
 
1730
+ # Defines parameters that the agent needs to invoke from the user to
1731
+ # complete the function. Corresponds to an action in an action group.
1732
+ #
1733
+ # This data type is used in the following API operations:
1734
+ #
1735
+ # * [CreateAgentActionGroup request][1]
1736
+ #
1737
+ # * [CreateAgentActionGroup response][2]
1738
+ #
1739
+ # * [UpdateAgentActionGroup request][3]
1740
+ #
1741
+ # * [UpdateAgentActionGroup response][4]
1742
+ #
1743
+ # * [GetAgentActionGroup response][5]
1744
+ #
1745
+ #
1746
+ #
1747
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax
1748
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax
1749
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax
1750
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax
1751
+ # [5]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax
1752
+ #
1753
+ # @!attribute [rw] description
1754
+ # A description of the function and its purpose.
1755
+ # @return [String]
1756
+ #
1757
+ # @!attribute [rw] name
1758
+ # A name for the function.
1759
+ # @return [String]
1760
+ #
1761
+ # @!attribute [rw] parameters
1762
+ # The parameters that the agent elicits from the user to fulfill the
1763
+ # function.
1764
+ # @return [Hash<String,Types::ParameterDetail>]
1765
+ #
1766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/Function AWS API Documentation
1767
+ #
1768
+ class Function < Struct.new(
1769
+ :description,
1770
+ :name,
1771
+ :parameters)
1772
+ SENSITIVE = []
1773
+ include Aws::Structure
1774
+ end
1775
+
1776
+ # Defines functions that each define parameters that the agent needs to
1777
+ # invoke from the user. Each function represents an action in an action
1778
+ # group.
1779
+ #
1780
+ # This data type is used in the following API operations:
1781
+ #
1782
+ # * [CreateAgentActionGroup request][1]
1783
+ #
1784
+ # * [CreateAgentActionGroup response][2]
1785
+ #
1786
+ # * [UpdateAgentActionGroup request][3]
1787
+ #
1788
+ # * [UpdateAgentActionGroup response][4]
1789
+ #
1790
+ # * [GetAgentActionGroup response][5]
1791
+ #
1792
+ #
1793
+ #
1794
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax
1795
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax
1796
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax
1797
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax
1798
+ # [5]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax
1799
+ #
1800
+ # @note FunctionSchema is a union - when making an API calls you must set exactly one of the members.
1801
+ #
1802
+ # @note FunctionSchema is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FunctionSchema corresponding to the set member.
1803
+ #
1804
+ # @!attribute [rw] functions
1805
+ # A list of functions that each define an action in the action group.
1806
+ # @return [Array<Types::Function>]
1807
+ #
1808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FunctionSchema AWS API Documentation
1809
+ #
1810
+ class FunctionSchema < Struct.new(
1811
+ :functions,
1812
+ :unknown)
1813
+ SENSITIVE = []
1814
+ include Aws::Structure
1815
+ include Aws::Structure::Union
1816
+
1817
+ class Functions < FunctionSchema; end
1818
+ class Unknown < FunctionSchema; end
1819
+ end
1820
+
1708
1821
  # @!attribute [rw] action_group_id
1709
1822
  # The unique identifier of the action group for which to get
1710
1823
  # information.
@@ -2020,7 +2133,7 @@ module Aws::BedrockAgent
2020
2133
  #
2021
2134
  # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax
2022
2135
  # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax
2023
- # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJob.html#API_agent_ListIngestionJob_ResponseSyntax
2136
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax
2024
2137
  #
2025
2138
  # @!attribute [rw] data_source_id
2026
2139
  # The unique identifier of the ingested data source.
@@ -2245,7 +2358,7 @@ module Aws::BedrockAgent
2245
2358
  # @return [Array<String>]
2246
2359
  #
2247
2360
  # @!attribute [rw] knowledge_base_arn
2248
- # The ARN of the knowledge base.
2361
+ # The Amazon Resource Name (ARN) of the knowledge base.
2249
2362
  # @return [String]
2250
2363
  #
2251
2364
  # @!attribute [rw] knowledge_base_configuration
@@ -2262,9 +2375,8 @@ module Aws::BedrockAgent
2262
2375
  # @return [String]
2263
2376
  #
2264
2377
  # @!attribute [rw] role_arn
2265
- # The ARN of the IAM role with permissions to invoke API operations on
2266
- # the knowledge base. The ARN must begin with
2267
- # `AmazonBedrockExecutionRoleForKnowledgeBase_`.
2378
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
2379
+ # invoke API operations on the knowledge base.
2268
2380
  # @return [String]
2269
2381
  #
2270
2382
  # @!attribute [rw] status
@@ -2778,7 +2890,8 @@ module Aws::BedrockAgent
2778
2890
  end
2779
2891
 
2780
2892
  # @!attribute [rw] resource_arn
2781
- # The ARN of the resource for which to list tags.
2893
+ # The Amazon Resource Name (ARN) of the resource for which to list
2894
+ # tags.
2782
2895
  # @return [String]
2783
2896
  #
2784
2897
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResourceRequest AWS API Documentation
@@ -2810,7 +2923,8 @@ module Aws::BedrockAgent
2810
2923
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
2811
2924
  #
2812
2925
  # @!attribute [rw] collection_arn
2813
- # The ARN of the OpenSearch Service vector store.
2926
+ # The Amazon Resource Name (ARN) of the OpenSearch Service vector
2927
+ # store.
2814
2928
  # @return [String]
2815
2929
  #
2816
2930
  # @!attribute [rw] field_mapping
@@ -2861,6 +2975,52 @@ module Aws::BedrockAgent
2861
2975
  include Aws::Structure
2862
2976
  end
2863
2977
 
2978
+ # Contains details about a parameter in a function for an action group.
2979
+ #
2980
+ # This data type is used in the following API operations:
2981
+ #
2982
+ # * [CreateAgentActionGroup request][1]
2983
+ #
2984
+ # * [CreateAgentActionGroup response][2]
2985
+ #
2986
+ # * [UpdateAgentActionGroup request][3]
2987
+ #
2988
+ # * [UpdateAgentActionGroup response][4]
2989
+ #
2990
+ # * [GetAgentActionGroup response][5]
2991
+ #
2992
+ #
2993
+ #
2994
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax
2995
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax
2996
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax
2997
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax
2998
+ # [5]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax
2999
+ #
3000
+ # @!attribute [rw] description
3001
+ # A description of the parameter. Helps the foundation model determine
3002
+ # how to elicit the parameters from the user.
3003
+ # @return [String]
3004
+ #
3005
+ # @!attribute [rw] required
3006
+ # Whether the parameter is required for the agent to complete the
3007
+ # function for action group invocation.
3008
+ # @return [Boolean]
3009
+ #
3010
+ # @!attribute [rw] type
3011
+ # The data type of the parameter.
3012
+ # @return [String]
3013
+ #
3014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ParameterDetail AWS API Documentation
3015
+ #
3016
+ class ParameterDetail < Struct.new(
3017
+ :description,
3018
+ :required,
3019
+ :type)
3020
+ SENSITIVE = []
3021
+ include Aws::Structure
3022
+ end
3023
+
2864
3024
  # Contains details about the storage configuration of the knowledge base
2865
3025
  # in Pinecone. For more information, see [Create a vector index in
2866
3026
  # Pinecone][1].
@@ -2874,8 +3034,8 @@ module Aws::BedrockAgent
2874
3034
  # @return [String]
2875
3035
  #
2876
3036
  # @!attribute [rw] credentials_secret_arn
2877
- # The ARN of the secret that you created in Secrets Manager that is
2878
- # linked to your Pinecone API key.
3037
+ # The Amazon Resource Name (ARN) of the secret that you created in
3038
+ # Secrets Manager that is linked to your Pinecone API key.
2879
3039
  # @return [String]
2880
3040
  #
2881
3041
  # @!attribute [rw] field_mapping
@@ -3086,8 +3246,8 @@ module Aws::BedrockAgent
3086
3246
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
3087
3247
  #
3088
3248
  # @!attribute [rw] credentials_secret_arn
3089
- # The ARN of the secret that you created in Secrets Manager that is
3090
- # linked to your Amazon RDS database.
3249
+ # The Amazon Resource Name (ARN) of the secret that you created in
3250
+ # Secrets Manager that is linked to your Amazon RDS database.
3091
3251
  # @return [String]
3092
3252
  #
3093
3253
  # @!attribute [rw] database_name
@@ -3100,7 +3260,7 @@ module Aws::BedrockAgent
3100
3260
  # @return [Types::RdsFieldMapping]
3101
3261
  #
3102
3262
  # @!attribute [rw] resource_arn
3103
- # The ARN of the vector store.
3263
+ # The Amazon Resource Name (ARN) of the vector store.
3104
3264
  # @return [String]
3105
3265
  #
3106
3266
  # @!attribute [rw] table_name
@@ -3163,8 +3323,9 @@ module Aws::BedrockAgent
3163
3323
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
3164
3324
  #
3165
3325
  # @!attribute [rw] credentials_secret_arn
3166
- # The ARN of the secret that you created in Secrets Manager that is
3167
- # linked to your Redis Enterprise Cloud database.
3326
+ # The Amazon Resource Name (ARN) of the secret that you created in
3327
+ # Secrets Manager that is linked to your Redis Enterprise Cloud
3328
+ # database.
3168
3329
  # @return [String]
3169
3330
  #
3170
3331
  # @!attribute [rw] endpoint
@@ -3220,8 +3381,8 @@ module Aws::BedrockAgent
3220
3381
  include Aws::Structure
3221
3382
  end
3222
3383
 
3223
- # The specified resource ARN was not found. Check the ARN and try your
3224
- # request again.
3384
+ # The specified resource Amazon Resource Name (ARN) was not found. Check
3385
+ # the Amazon Resource Name (ARN) and try your request again.
3225
3386
  #
3226
3387
  # @!attribute [rw] message
3227
3388
  # @return [String]
@@ -3237,7 +3398,8 @@ module Aws::BedrockAgent
3237
3398
  # Contains information about the S3 configuration of the data source.
3238
3399
  #
3239
3400
  # @!attribute [rw] bucket_arn
3240
- # The ARN of the bucket that contains the data source.
3401
+ # The Amazon Resource Name (ARN) of the bucket that contains the data
3402
+ # source.
3241
3403
  # @return [String]
3242
3404
  #
3243
3405
  # @!attribute [rw] inclusion_prefixes
@@ -3281,7 +3443,8 @@ module Aws::BedrockAgent
3281
3443
  # Contains the configuration for server-side encryption.
3282
3444
  #
3283
3445
  # @!attribute [rw] kms_key_arn
3284
- # The ARN of the KMS key used to encrypt the resource.
3446
+ # The Amazon Resource Name (ARN) of the KMS key used to encrypt the
3447
+ # resource.
3285
3448
  # @return [String]
3286
3449
  #
3287
3450
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ServerSideEncryptionConfiguration AWS API Documentation
@@ -3400,7 +3563,7 @@ module Aws::BedrockAgent
3400
3563
  end
3401
3564
 
3402
3565
  # @!attribute [rw] resource_arn
3403
- # The ARN of the resource to tag.
3566
+ # The Amazon Resource Name (ARN) of the resource to tag.
3404
3567
  # @return [String]
3405
3568
  #
3406
3569
  # @!attribute [rw] tags
@@ -3435,7 +3598,8 @@ module Aws::BedrockAgent
3435
3598
  end
3436
3599
 
3437
3600
  # @!attribute [rw] resource_arn
3438
- # The ARN of the resource from which to remove tags.
3601
+ # The Amazon Resource Name (ARN) of the resource from which to remove
3602
+ # tags.
3439
3603
  # @return [String]
3440
3604
  #
3441
3605
  # @!attribute [rw] tag_keys
@@ -3456,8 +3620,8 @@ module Aws::BedrockAgent
3456
3620
  class UntagResourceResponse < Aws::EmptyStructure; end
3457
3621
 
3458
3622
  # @!attribute [rw] action_group_executor
3459
- # The ARN of the Lambda function containing the business logic that is
3460
- # carried out upon invoking the action.
3623
+ # The Amazon Resource Name (ARN) of the Lambda function containing the
3624
+ # business logic that is carried out upon invoking the action.
3461
3625
  # @return [Types::ActionGroupExecutor]
3462
3626
  #
3463
3627
  # @!attribute [rw] action_group_id
@@ -3502,6 +3666,11 @@ module Aws::BedrockAgent
3502
3666
  # Specifies a new name for the action group.
3503
3667
  # @return [String]
3504
3668
  #
3669
+ # @!attribute [rw] function_schema
3670
+ # Contains details about the function schema for the action group or
3671
+ # the JSON or YAML-formatted payload defining the schema.
3672
+ # @return [Types::FunctionSchema]
3673
+ #
3505
3674
  # @!attribute [rw] parent_action_group_signature
3506
3675
  # To allow your agent to request the user for additional information
3507
3676
  # when trying to complete a task, set this field to
@@ -3530,6 +3699,7 @@ module Aws::BedrockAgent
3530
3699
  :agent_version,
3531
3700
  :api_schema,
3532
3701
  :description,
3702
+ :function_schema,
3533
3703
  :parent_action_group_signature)
3534
3704
  SENSITIVE = []
3535
3705
  include Aws::Structure
@@ -3654,12 +3824,13 @@ module Aws::BedrockAgent
3654
3824
  # @return [String]
3655
3825
  #
3656
3826
  # @!attribute [rw] agent_resource_role_arn
3657
- # The ARN of the IAM role with permissions to update the agent. The
3658
- # ARN must begin with `AmazonBedrockExecutionRoleForAgents_`.
3827
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
3828
+ # invoke API operations on the agent.
3659
3829
  # @return [String]
3660
3830
  #
3661
3831
  # @!attribute [rw] customer_encryption_key_arn
3662
- # The ARN of the KMS key with which to encrypt the agent.
3832
+ # The Amazon Resource Name (ARN) of the KMS key with which to encrypt
3833
+ # the agent.
3663
3834
  # @return [String]
3664
3835
  #
3665
3836
  # @!attribute [rw] description
@@ -3798,7 +3969,7 @@ module Aws::BedrockAgent
3798
3969
  #
3799
3970
  # @!attribute [rw] role_arn
3800
3971
  # Specifies a different Amazon Resource Name (ARN) of the IAM role
3801
- # with permissions to modify the knowledge base.
3972
+ # with permissions to invoke API operations on the knowledge base.
3802
3973
  # @return [String]
3803
3974
  #
3804
3975
  # @!attribute [rw] storage_configuration
@@ -3892,8 +4063,8 @@ module Aws::BedrockAgent
3892
4063
  # the knowledge base.
3893
4064
  #
3894
4065
  # @!attribute [rw] embedding_model_arn
3895
- # The ARN of the model used to create vector embeddings for the
3896
- # knowledge base.
4066
+ # The Amazon Resource Name (ARN) of the model used to create vector
4067
+ # embeddings for the knowledge base.
3897
4068
  # @return [String]
3898
4069
  #
3899
4070
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration AWS API Documentation
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-bedrockagent/customizations'
52
52
  # @!group service
53
53
  module Aws::BedrockAgent
54
54
 
55
- GEM_VERSION = '1.4.0'
55
+ GEM_VERSION = '1.6.0'
56
56
 
57
57
  end
data/sig/client.rbs CHANGED
@@ -93,7 +93,7 @@ module Aws
93
93
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_agent-instance_method
94
94
  def create_agent: (
95
95
  agent_name: ::String,
96
- agent_resource_role_arn: ::String,
96
+ ?agent_resource_role_arn: ::String,
97
97
  ?client_token: ::String,
98
98
  ?customer_encryption_key_arn: ::String,
99
99
  ?description: ::String,
@@ -130,6 +130,7 @@ module Aws
130
130
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_agent_action_group-instance_method
131
131
  def create_agent_action_group: (
132
132
  ?action_group_executor: {
133
+ custom_control: ("RETURN_CONTROL")?,
133
134
  lambda: ::String?
134
135
  },
135
136
  action_group_name: ::String,
@@ -145,6 +146,19 @@ module Aws
145
146
  },
146
147
  ?client_token: ::String,
147
148
  ?description: ::String,
149
+ ?function_schema: {
150
+ functions: Array[
151
+ {
152
+ description: ::String?,
153
+ name: ::String,
154
+ parameters: Hash[::String, {
155
+ description: ::String?,
156
+ required: bool?,
157
+ type: ("string" | "number" | "integer" | "boolean" | "array")
158
+ }]?
159
+ },
160
+ ]?
161
+ },
148
162
  ?parent_action_group_signature: ("AMAZON.UserInput")
149
163
  ) -> _CreateAgentActionGroupResponseSuccess
150
164
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgentActionGroupResponseSuccess
@@ -653,6 +667,7 @@ module Aws
653
667
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_agent_action_group-instance_method
654
668
  def update_agent_action_group: (
655
669
  ?action_group_executor: {
670
+ custom_control: ("RETURN_CONTROL")?,
656
671
  lambda: ::String?
657
672
  },
658
673
  action_group_id: ::String,
@@ -668,6 +683,19 @@ module Aws
668
683
  }?
669
684
  },
670
685
  ?description: ::String,
686
+ ?function_schema: {
687
+ functions: Array[
688
+ {
689
+ description: ::String?,
690
+ name: ::String,
691
+ parameters: Hash[::String, {
692
+ description: ::String?,
693
+ required: bool?,
694
+ type: ("string" | "number" | "integer" | "boolean" | "array")
695
+ }]?
696
+ },
697
+ ]?
698
+ },
671
699
  ?parent_action_group_signature: ("AMAZON.UserInput")
672
700
  ) -> _UpdateAgentActionGroupResponseSuccess
673
701
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgentActionGroupResponseSuccess
data/sig/types.rbs CHANGED
@@ -28,10 +28,13 @@ module Aws::BedrockAgent
28
28
  end
29
29
 
30
30
  class ActionGroupExecutor
31
+ attr_accessor custom_control: ("RETURN_CONTROL")
31
32
  attr_accessor lambda: ::String
32
33
  attr_accessor unknown: untyped
33
34
  SENSITIVE: []
34
35
 
36
+ class CustomControl < ActionGroupExecutor
37
+ end
35
38
  class Lambda < ActionGroupExecutor
36
39
  end
37
40
  class Unknown < ActionGroupExecutor
@@ -80,6 +83,7 @@ module Aws::BedrockAgent
80
83
  attr_accessor client_token: ::String
81
84
  attr_accessor created_at: ::Time
82
85
  attr_accessor description: ::String
86
+ attr_accessor function_schema: Types::FunctionSchema
83
87
  attr_accessor parent_action_signature: ("AMAZON.UserInput")
84
88
  attr_accessor updated_at: ::Time
85
89
  SENSITIVE: []
@@ -216,6 +220,7 @@ module Aws::BedrockAgent
216
220
  attr_accessor api_schema: Types::APISchema
217
221
  attr_accessor client_token: ::String
218
222
  attr_accessor description: ::String
223
+ attr_accessor function_schema: Types::FunctionSchema
219
224
  attr_accessor parent_action_group_signature: ("AMAZON.UserInput")
220
225
  SENSITIVE: []
221
226
  end
@@ -411,6 +416,24 @@ module Aws::BedrockAgent
411
416
  SENSITIVE: []
412
417
  end
413
418
 
419
+ class Function
420
+ attr_accessor description: ::String
421
+ attr_accessor name: ::String
422
+ attr_accessor parameters: ::Hash[::String, Types::ParameterDetail]
423
+ SENSITIVE: []
424
+ end
425
+
426
+ class FunctionSchema
427
+ attr_accessor functions: ::Array[Types::Function]
428
+ attr_accessor unknown: untyped
429
+ SENSITIVE: []
430
+
431
+ class Functions < FunctionSchema
432
+ end
433
+ class Unknown < FunctionSchema
434
+ end
435
+ end
436
+
414
437
  class GetAgentActionGroupRequest
415
438
  attr_accessor action_group_id: ::String
416
439
  attr_accessor agent_id: ::String
@@ -724,6 +747,13 @@ module Aws::BedrockAgent
724
747
  SENSITIVE: []
725
748
  end
726
749
 
750
+ class ParameterDetail
751
+ attr_accessor description: ::String
752
+ attr_accessor required: bool
753
+ attr_accessor type: ("string" | "number" | "integer" | "boolean" | "array")
754
+ SENSITIVE: []
755
+ end
756
+
727
757
  class PineconeConfiguration
728
758
  attr_accessor connection_string: ::String
729
759
  attr_accessor credentials_secret_arn: ::String
@@ -880,6 +910,7 @@ module Aws::BedrockAgent
880
910
  attr_accessor agent_version: ::String
881
911
  attr_accessor api_schema: Types::APISchema
882
912
  attr_accessor description: ::String
913
+ attr_accessor function_schema: Types::FunctionSchema
883
914
  attr_accessor parent_action_group_signature: ("AMAZON.UserInput")
884
915
  SENSITIVE: []
885
916
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-bedrockagent
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-27 00:00:00.000000000 Z
11
+ date: 2024-04-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core