aws-sdk-bedrockagentruntime 1.78.0 → 1.79.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b6eca6aaea09bb1001fceb3e78d10fc5ec188d5dc756bf79e659d2116fe52024
4
- data.tar.gz: 428157d1f5df7d5a3b404ecba7c8060c73bbc04c3ee56aec394b1a1143887611
3
+ metadata.gz: 4eb4959009f8c6687e35f5cbd2afe31cfa973fd33d82d858aad099fef3363f34
4
+ data.tar.gz: e64a01355716635a665d82034a31e1580f3827905d1dbd4e4e970695b02d541e
5
5
  SHA512:
6
- metadata.gz: 732fa016b9afccb993707ddf3699bfe1bbe3915f4c3655c7921c3704cdb9dc1ffed4546bfa6f92dc7eadb979773dfd5194714407bd86018666db4aa38be39562
7
- data.tar.gz: 6d75cc224981bc60dd881e7abdc17af98bc0f0cff980336f118c3d9ab2997389c667a17854363f934ac0af823bb80628701e0a9aa0a8998abbc32b24eb2dd218
6
+ metadata.gz: 993b27eb8ff62be0b637ebb43faba605a7912cf4b7ae7f74d8ac9a304d18cd15a52b954dc87644b0d06ca3e63bac98568f95f3b496198bba8196be5ea4ce00dc
7
+ data.tar.gz: 785e6a6416805fcbe9ba0fa389e9f7f9ec2effc286c1ed64caca5320226524d873e0b5904374331fa889229b9ee7574e11cc85766609a21a99c7151487bbadba
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.79.0 (2026-08-14)
5
+ ------------------
6
+
7
+ * Feature - Adds CheckIngestedDocumentAcl and GetIngestedDocumentAcl APIs to Amazon Bedrock Knowledge Bases. Customers can verify user access to documents based on ingested ACLs and retrieve full ACL details including allow and deny entries, enabling validation of ACL ingestion without test retrievals.
8
+
4
9
  1.78.0 (2026-07-09)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.78.0
1
+ 1.79.0
@@ -948,6 +948,55 @@ module Aws::BedrockAgentRuntime
948
948
  req.send_request(options, &block)
949
949
  end
950
950
 
951
+ # Checks whether a user has access to a specific document by verifying
952
+ # against the ingested access control list (ACL) in a knowledge base.
953
+ # Use this operation to validate that document-level access control is
954
+ # working as expected after ingestion. To use this operation, you must
955
+ # have the `bedrock:CheckIngestedDocumentAcl` permission.
956
+ #
957
+ # @option params [required, String] :data_source_id
958
+ # The unique identifier of the data source that contains the document.
959
+ #
960
+ # @option params [required, String] :document_id
961
+ # The unique identifier of the document to check access for.
962
+ #
963
+ # @option params [required, String] :knowledge_base_id
964
+ # The unique identifier of the knowledge base that contains the
965
+ # document.
966
+ #
967
+ # @option params [required, Types::UserContext] :user_context
968
+ # The context object containing identity information for access control
969
+ # filtering, including user ID and optional group memberships used to
970
+ # evaluate the document access control list (ACL).
971
+ #
972
+ # @return [Types::CheckIngestedDocumentAclResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
973
+ #
974
+ # * {Types::CheckIngestedDocumentAclResponse#has_access #has_access} => Boolean
975
+ #
976
+ # @example Request syntax with placeholder values
977
+ #
978
+ # resp = client.check_ingested_document_acl({
979
+ # data_source_id: "DataSourceId", # required
980
+ # document_id: "DocumentId", # required
981
+ # knowledge_base_id: "KnowledgeBaseIdentifier", # required
982
+ # user_context: { # required
983
+ # user_id: "String", # required
984
+ # },
985
+ # })
986
+ #
987
+ # @example Response structure
988
+ #
989
+ # resp.has_access #=> Boolean
990
+ #
991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CheckIngestedDocumentAcl AWS API Documentation
992
+ #
993
+ # @overload check_ingested_document_acl(params = {})
994
+ # @param [Hash] params ({})
995
+ def check_ingested_document_acl(params = {}, options = {})
996
+ req = build_request(:check_ingested_document_acl, params)
997
+ req.send_request(options)
998
+ end
999
+
951
1000
  # Creates a new invocation within a session. An invocation groups the
952
1001
  # related invocation steps that store the content from a conversation.
953
1002
  # For more information about sessions, see [Store and retrieve
@@ -1345,10 +1394,9 @@ module Aws::BedrockAgentRuntime
1345
1394
  # file. `EXTRACTED` returns parsed text as JSON. Defaults to `RAW`.
1346
1395
  #
1347
1396
  # @option params [Types::UserContext] :user_context
1348
- # Contains information about the user making the request. Use this to
1349
- # pass user identity information for access control filtering, so that
1350
- # retrieval results only include documents the user is authorized to
1351
- # access.
1397
+ # Contains information about the user making the request. This is used
1398
+ # for access control filtering to ensure that results only include
1399
+ # documents the user is authorized to access.
1352
1400
  #
1353
1401
  # @return [Types::GetDocumentContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1354
1402
  #
@@ -1493,6 +1541,65 @@ module Aws::BedrockAgentRuntime
1493
1541
  req.send_request(options)
1494
1542
  end
1495
1543
 
1544
+ # Retrieves the ingested access control list (ACL) for a specific
1545
+ # document in a knowledge base. Use this operation to inspect the allow
1546
+ # and deny lists that were ingested for a document to troubleshoot
1547
+ # access control issues. To use this operation, you must have the
1548
+ # `bedrock:GetIngestedDocumentAcl` permission.
1549
+ #
1550
+ # @option params [required, String] :data_source_id
1551
+ # The unique identifier of the data source that contains the document.
1552
+ #
1553
+ # @option params [required, String] :document_id
1554
+ # The unique identifier of the document to retrieve the ingested access
1555
+ # control list (ACL) for.
1556
+ #
1557
+ # @option params [required, String] :knowledge_base_id
1558
+ # The unique identifier of the knowledge base that contains the
1559
+ # document.
1560
+ #
1561
+ # @return [Types::GetIngestedDocumentAclResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1562
+ #
1563
+ # * {Types::GetIngestedDocumentAclResponse#document_acl #document_acl} => Types::DocumentAcl
1564
+ #
1565
+ # @example Request syntax with placeholder values
1566
+ #
1567
+ # resp = client.get_ingested_document_acl({
1568
+ # data_source_id: "DataSourceId", # required
1569
+ # document_id: "DocumentId", # required
1570
+ # knowledge_base_id: "KnowledgeBaseIdentifier", # required
1571
+ # })
1572
+ #
1573
+ # @example Response structure
1574
+ #
1575
+ # resp.document_acl.allow_list.conditions #=> Array
1576
+ # resp.document_acl.allow_list.conditions[0].condition_operator #=> String, one of "AND", "OR"
1577
+ # resp.document_acl.allow_list.conditions[0].groups #=> Array
1578
+ # resp.document_acl.allow_list.conditions[0].groups[0].id #=> String
1579
+ # resp.document_acl.allow_list.conditions[0].groups[0].type #=> String, one of "KNOWLEDGE_BASE", "DATA_SOURCE"
1580
+ # resp.document_acl.allow_list.conditions[0].users #=> Array
1581
+ # resp.document_acl.allow_list.conditions[0].users[0].id #=> String
1582
+ # resp.document_acl.allow_list.conditions[0].users[0].type #=> String, one of "KNOWLEDGE_BASE", "DATA_SOURCE"
1583
+ # resp.document_acl.allow_list.member_relation #=> String, one of "AND", "OR"
1584
+ # resp.document_acl.deny_list.conditions #=> Array
1585
+ # resp.document_acl.deny_list.conditions[0].condition_operator #=> String, one of "AND", "OR"
1586
+ # resp.document_acl.deny_list.conditions[0].groups #=> Array
1587
+ # resp.document_acl.deny_list.conditions[0].groups[0].id #=> String
1588
+ # resp.document_acl.deny_list.conditions[0].groups[0].type #=> String, one of "KNOWLEDGE_BASE", "DATA_SOURCE"
1589
+ # resp.document_acl.deny_list.conditions[0].users #=> Array
1590
+ # resp.document_acl.deny_list.conditions[0].users[0].id #=> String
1591
+ # resp.document_acl.deny_list.conditions[0].users[0].type #=> String, one of "KNOWLEDGE_BASE", "DATA_SOURCE"
1592
+ # resp.document_acl.deny_list.member_relation #=> String, one of "AND", "OR"
1593
+ #
1594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetIngestedDocumentAcl AWS API Documentation
1595
+ #
1596
+ # @overload get_ingested_document_acl(params = {})
1597
+ # @param [Hash] params ({})
1598
+ def get_ingested_document_acl(params = {}, options = {})
1599
+ req = build_request(:get_ingested_document_acl, params)
1600
+ req.send_request(options)
1601
+ end
1602
+
1496
1603
  # Retrieves the details of a specific invocation step within an
1497
1604
  # invocation in a session. For more information about sessions, see
1498
1605
  # [Store and retrieve conversation history and context with Amazon
@@ -1595,7 +1702,16 @@ module Aws::BedrockAgentRuntime
1595
1702
  req.send_request(options)
1596
1703
  end
1597
1704
 
1598
- # <note> </note>
1705
+ # <note markdown="1"> Amazon Bedrock Agents (now Amazon Bedrock Agents
1706
+ # Classic) is no longer
1707
+ # open to new customers. For capabilities similar to Bedrock Agents
1708
+ # Classic, explore Amazon Bedrock AgentCore. Existing customers can
1709
+ # continue to use the service as normal. For more information, see
1710
+ # [Amazon Bedrock Agents Classic availability change][1].
1711
+ #
1712
+ # </note>
1713
+ #
1714
+ # <note> </note>
1599
1715
  #
1600
1716
  # Sends a prompt for the agent to process and respond to. Note the
1601
1717
  # following fields for the request:
@@ -1607,7 +1723,7 @@ module Aws::BedrockAgentRuntime
1607
1723
  # enablement helps you follow the agent's reasoning process that led
1608
1724
  # it to the information it processed, the actions it took, and the
1609
1725
  # final result it yielded. For more information, see [Trace
1610
- # enablement][1].
1726
+ # enablement][2].
1611
1727
  #
1612
1728
  # * End a conversation by setting `endSession` to `true`.
1613
1729
  #
@@ -1635,7 +1751,8 @@ module Aws::BedrockAgentRuntime
1635
1751
  #
1636
1752
  #
1637
1753
  #
1638
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events
1754
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html
1755
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events
1639
1756
  #
1640
1757
  # @option params [required, String] :agent_alias_id
1641
1758
  # The alias of the agent to use.
@@ -6684,10 +6801,9 @@ module Aws::BedrockAgentRuntime
6684
6801
  # Contains the query to send the knowledge base.
6685
6802
  #
6686
6803
  # @option params [Types::UserContext] :user_context
6687
- # Contains information about the user making the request. Use this to
6688
- # pass user identity information for access control filtering, so that
6689
- # retrieval results only include documents the user is authorized to
6690
- # access.
6804
+ # Contains information about the user making the request. This is used
6805
+ # for access control filtering to ensure that retrieval results only
6806
+ # include documents the user is authorized to access.
6691
6807
  #
6692
6808
  # @return [Types::RetrieveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6693
6809
  #
@@ -7009,10 +7125,9 @@ module Aws::BedrockAgentRuntime
7009
7125
  # explicitly set the `sessionId` yourself.
7010
7126
  #
7011
7127
  # @option params [Types::UserContext] :user_context
7012
- # Contains information about the user making the request. Use this to
7013
- # pass user identity information for access control filtering, so that
7014
- # retrieval results only include documents the user is authorized to
7015
- # access.
7128
+ # Contains information about the user making the request. This is used
7129
+ # for access control filtering to ensure that retrieval results only
7130
+ # include documents the user is authorized to access.
7016
7131
  #
7017
7132
  # @return [Types::RetrieveAndGenerateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7018
7133
  #
@@ -7428,10 +7543,9 @@ module Aws::BedrockAgentRuntime
7428
7543
  # explicitly set the `sessionId` yourself.
7429
7544
  #
7430
7545
  # @option params [Types::UserContext] :user_context
7431
- # Contains information about the user making the request. Use this to
7432
- # pass user identity information for access control filtering, so that
7433
- # retrieval results only include documents the user is authorized to
7434
- # access.
7546
+ # Contains information about the user making the request. This is used
7547
+ # for access control filtering to ensure that retrieval results only
7548
+ # include documents the user is authorized to access.
7435
7549
  #
7436
7550
  # @return [Types::RetrieveAndGenerateStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7437
7551
  #
@@ -8313,7 +8427,7 @@ module Aws::BedrockAgentRuntime
8313
8427
  tracer: tracer
8314
8428
  )
8315
8429
  context[:gem_name] = 'aws-sdk-bedrockagentruntime'
8316
- context[:gem_version] = '1.78.0'
8430
+ context[:gem_version] = '1.79.0'
8317
8431
  Seahorse::Client::Request.new(handlers, context)
8318
8432
  end
8319
8433
 
@@ -125,6 +125,8 @@ module Aws::BedrockAgentRuntime
125
125
  ByteContentFile = Shapes::StructureShape.new(name: 'ByteContentFile')
126
126
  Caller = Shapes::UnionShape.new(name: 'Caller')
127
127
  CallerChain = Shapes::ListShape.new(name: 'CallerChain')
128
+ CheckIngestedDocumentAclRequest = Shapes::StructureShape.new(name: 'CheckIngestedDocumentAclRequest')
129
+ CheckIngestedDocumentAclResponse = Shapes::StructureShape.new(name: 'CheckIngestedDocumentAclResponse')
128
130
  Citation = Shapes::StructureShape.new(name: 'Citation')
129
131
  CitationEvent = Shapes::StructureShape.new(name: 'CitationEvent')
130
132
  Citations = Shapes::ListShape.new(name: 'Citations')
@@ -162,6 +164,18 @@ module Aws::BedrockAgentRuntime
162
164
  DeleteSessionResponse = Shapes::StructureShape.new(name: 'DeleteSessionResponse')
163
165
  DependencyFailedException = Shapes::StructureShape.new(name: 'DependencyFailedException')
164
166
  Document = Shapes::DocumentShape.new(name: 'Document', document: true)
167
+ DocumentAcl = Shapes::StructureShape.new(name: 'DocumentAcl')
168
+ DocumentAclCondition = Shapes::StructureShape.new(name: 'DocumentAclCondition')
169
+ DocumentAclConditionGroupsList = Shapes::ListShape.new(name: 'DocumentAclConditionGroupsList')
170
+ DocumentAclConditionUsersList = Shapes::ListShape.new(name: 'DocumentAclConditionUsersList')
171
+ DocumentAclGroup = Shapes::StructureShape.new(name: 'DocumentAclGroup')
172
+ DocumentAclGroupIdString = Shapes::StringShape.new(name: 'DocumentAclGroupIdString')
173
+ DocumentAclMemberRelation = Shapes::StringShape.new(name: 'DocumentAclMemberRelation')
174
+ DocumentAclMembership = Shapes::StructureShape.new(name: 'DocumentAclMembership')
175
+ DocumentAclMembershipConditionsList = Shapes::ListShape.new(name: 'DocumentAclMembershipConditionsList')
176
+ DocumentAclMembershipType = Shapes::StringShape.new(name: 'DocumentAclMembershipType')
177
+ DocumentAclUser = Shapes::StructureShape.new(name: 'DocumentAclUser')
178
+ DocumentAclUserIdString = Shapes::StringShape.new(name: 'DocumentAclUserIdString')
165
179
  DocumentId = Shapes::StringShape.new(name: 'DocumentId')
166
180
  DocumentOutputFormat = Shapes::StringShape.new(name: 'DocumentOutputFormat')
167
181
  Double = Shapes::FloatShape.new(name: 'Double')
@@ -277,6 +291,8 @@ module Aws::BedrockAgentRuntime
277
291
  GetExecutionFlowSnapshotResponse = Shapes::StructureShape.new(name: 'GetExecutionFlowSnapshotResponse')
278
292
  GetFlowExecutionRequest = Shapes::StructureShape.new(name: 'GetFlowExecutionRequest')
279
293
  GetFlowExecutionResponse = Shapes::StructureShape.new(name: 'GetFlowExecutionResponse')
294
+ GetIngestedDocumentAclRequest = Shapes::StructureShape.new(name: 'GetIngestedDocumentAclRequest')
295
+ GetIngestedDocumentAclResponse = Shapes::StructureShape.new(name: 'GetIngestedDocumentAclResponse')
280
296
  GetInvocationStepRequest = Shapes::StructureShape.new(name: 'GetInvocationStepRequest')
281
297
  GetInvocationStepResponse = Shapes::StructureShape.new(name: 'GetInvocationStepResponse')
282
298
  GetSessionRequest = Shapes::StructureShape.new(name: 'GetSessionRequest')
@@ -1011,6 +1027,15 @@ module Aws::BedrockAgentRuntime
1011
1027
 
1012
1028
  CallerChain.member = Shapes::ShapeRef.new(shape: Caller)
1013
1029
 
1030
+ CheckIngestedDocumentAclRequest.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location: "uri", location_name: "dataSourceId"))
1031
+ CheckIngestedDocumentAclRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location_name: "documentId"))
1032
+ CheckIngestedDocumentAclRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: KnowledgeBaseIdentifier, required: true, location: "uri", location_name: "knowledgeBaseId"))
1033
+ CheckIngestedDocumentAclRequest.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, required: true, location_name: "userContext"))
1034
+ CheckIngestedDocumentAclRequest.struct_class = Types::CheckIngestedDocumentAclRequest
1035
+
1036
+ CheckIngestedDocumentAclResponse.add_member(:has_access, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "hasAccess"))
1037
+ CheckIngestedDocumentAclResponse.struct_class = Types::CheckIngestedDocumentAclResponse
1038
+
1014
1039
  Citation.add_member(:generated_response_part, Shapes::ShapeRef.new(shape: GeneratedResponsePart, location_name: "generatedResponsePart"))
1015
1040
  Citation.add_member(:retrieved_references, Shapes::ShapeRef.new(shape: RetrievedReferences, location_name: "retrievedReferences"))
1016
1041
  Citation.struct_class = Types::Citation
@@ -1130,6 +1155,33 @@ module Aws::BedrockAgentRuntime
1130
1155
  DependencyFailedException.add_member(:resource_name, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "resourceName"))
1131
1156
  DependencyFailedException.struct_class = Types::DependencyFailedException
1132
1157
 
1158
+ DocumentAcl.add_member(:allow_list, Shapes::ShapeRef.new(shape: DocumentAclMembership, location_name: "allowList"))
1159
+ DocumentAcl.add_member(:deny_list, Shapes::ShapeRef.new(shape: DocumentAclMembership, location_name: "denyList"))
1160
+ DocumentAcl.struct_class = Types::DocumentAcl
1161
+
1162
+ DocumentAclCondition.add_member(:condition_operator, Shapes::ShapeRef.new(shape: DocumentAclMemberRelation, location_name: "conditionOperator"))
1163
+ DocumentAclCondition.add_member(:groups, Shapes::ShapeRef.new(shape: DocumentAclConditionGroupsList, location_name: "groups"))
1164
+ DocumentAclCondition.add_member(:users, Shapes::ShapeRef.new(shape: DocumentAclConditionUsersList, location_name: "users"))
1165
+ DocumentAclCondition.struct_class = Types::DocumentAclCondition
1166
+
1167
+ DocumentAclConditionGroupsList.member = Shapes::ShapeRef.new(shape: DocumentAclGroup)
1168
+
1169
+ DocumentAclConditionUsersList.member = Shapes::ShapeRef.new(shape: DocumentAclUser)
1170
+
1171
+ DocumentAclGroup.add_member(:id, Shapes::ShapeRef.new(shape: DocumentAclGroupIdString, required: true, location_name: "id"))
1172
+ DocumentAclGroup.add_member(:type, Shapes::ShapeRef.new(shape: DocumentAclMembershipType, required: true, location_name: "type"))
1173
+ DocumentAclGroup.struct_class = Types::DocumentAclGroup
1174
+
1175
+ DocumentAclMembership.add_member(:conditions, Shapes::ShapeRef.new(shape: DocumentAclMembershipConditionsList, location_name: "conditions"))
1176
+ DocumentAclMembership.add_member(:member_relation, Shapes::ShapeRef.new(shape: DocumentAclMemberRelation, location_name: "memberRelation"))
1177
+ DocumentAclMembership.struct_class = Types::DocumentAclMembership
1178
+
1179
+ DocumentAclMembershipConditionsList.member = Shapes::ShapeRef.new(shape: DocumentAclCondition)
1180
+
1181
+ DocumentAclUser.add_member(:id, Shapes::ShapeRef.new(shape: DocumentAclUserIdString, required: true, location_name: "id"))
1182
+ DocumentAclUser.add_member(:type, Shapes::ShapeRef.new(shape: DocumentAclMembershipType, required: true, location_name: "type"))
1183
+ DocumentAclUser.struct_class = Types::DocumentAclUser
1184
+
1133
1185
  EndSessionRequest.add_member(:session_identifier, Shapes::ShapeRef.new(shape: SessionIdentifier, required: true, location: "uri", location_name: "sessionIdentifier"))
1134
1186
  EndSessionRequest.struct_class = Types::EndSessionRequest
1135
1187
 
@@ -1530,6 +1582,14 @@ module Aws::BedrockAgentRuntime
1530
1582
  GetFlowExecutionResponse.add_member(:status, Shapes::ShapeRef.new(shape: FlowExecutionStatus, required: true, location_name: "status"))
1531
1583
  GetFlowExecutionResponse.struct_class = Types::GetFlowExecutionResponse
1532
1584
 
1585
+ GetIngestedDocumentAclRequest.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location: "uri", location_name: "dataSourceId"))
1586
+ GetIngestedDocumentAclRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location_name: "documentId"))
1587
+ GetIngestedDocumentAclRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: KnowledgeBaseIdentifier, required: true, location: "uri", location_name: "knowledgeBaseId"))
1588
+ GetIngestedDocumentAclRequest.struct_class = Types::GetIngestedDocumentAclRequest
1589
+
1590
+ GetIngestedDocumentAclResponse.add_member(:document_acl, Shapes::ShapeRef.new(shape: DocumentAcl, required: true, location_name: "documentAcl"))
1591
+ GetIngestedDocumentAclResponse.struct_class = Types::GetIngestedDocumentAclResponse
1592
+
1533
1593
  GetInvocationStepRequest.add_member(:invocation_identifier, Shapes::ShapeRef.new(shape: InvocationIdentifier, required: true, location_name: "invocationIdentifier"))
1534
1594
  GetInvocationStepRequest.add_member(:invocation_step_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location: "uri", location_name: "invocationStepId"))
1535
1595
  GetInvocationStepRequest.add_member(:session_identifier, Shapes::ShapeRef.new(shape: SessionIdentifier, required: true, location: "uri", location_name: "sessionIdentifier"))
@@ -2844,6 +2904,19 @@ module Aws::BedrockAgentRuntime
2844
2904
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
2845
2905
  end)
2846
2906
 
2907
+ api.add_operation(:check_ingested_document_acl, Seahorse::Model::Operation.new.tap do |o|
2908
+ o.name = "CheckIngestedDocumentAcl"
2909
+ o.http_method = "POST"
2910
+ o.http_request_uri = "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/check-ingested-document-acl"
2911
+ o.input = Shapes::ShapeRef.new(shape: CheckIngestedDocumentAclRequest)
2912
+ o.output = Shapes::ShapeRef.new(shape: CheckIngestedDocumentAclResponse)
2913
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
2914
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
2915
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2916
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
2917
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
2918
+ end)
2919
+
2847
2920
  api.add_operation(:create_invocation, Seahorse::Model::Operation.new.tap do |o|
2848
2921
  o.name = "CreateInvocation"
2849
2922
  o.http_method = "PUT"
@@ -2997,6 +3070,19 @@ module Aws::BedrockAgentRuntime
2997
3070
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
2998
3071
  end)
2999
3072
 
3073
+ api.add_operation(:get_ingested_document_acl, Seahorse::Model::Operation.new.tap do |o|
3074
+ o.name = "GetIngestedDocumentAcl"
3075
+ o.http_method = "POST"
3076
+ o.http_request_uri = "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/get-ingested-document-acl"
3077
+ o.input = Shapes::ShapeRef.new(shape: GetIngestedDocumentAclRequest)
3078
+ o.output = Shapes::ShapeRef.new(shape: GetIngestedDocumentAclResponse)
3079
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
3080
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
3081
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
3082
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
3083
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
3084
+ end)
3085
+
3000
3086
  api.add_operation(:get_invocation_step, Seahorse::Model::Operation.new.tap do |o|
3001
3087
  o.name = "GetInvocationStep"
3002
3088
  o.http_method = "POST"
@@ -1469,6 +1469,50 @@ module Aws::BedrockAgentRuntime
1469
1469
  class Unknown < Caller; end
1470
1470
  end
1471
1471
 
1472
+ # @!attribute [rw] data_source_id
1473
+ # The unique identifier of the data source that contains the document.
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] document_id
1477
+ # The unique identifier of the document to check access for.
1478
+ # @return [String]
1479
+ #
1480
+ # @!attribute [rw] knowledge_base_id
1481
+ # The unique identifier of the knowledge base that contains the
1482
+ # document.
1483
+ # @return [String]
1484
+ #
1485
+ # @!attribute [rw] user_context
1486
+ # The context object containing identity information for access
1487
+ # control filtering, including user ID and optional group memberships
1488
+ # used to evaluate the document access control list (ACL).
1489
+ # @return [Types::UserContext]
1490
+ #
1491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CheckIngestedDocumentAclRequest AWS API Documentation
1492
+ #
1493
+ class CheckIngestedDocumentAclRequest < Struct.new(
1494
+ :data_source_id,
1495
+ :document_id,
1496
+ :knowledge_base_id,
1497
+ :user_context)
1498
+ SENSITIVE = [:user_context]
1499
+ include Aws::Structure
1500
+ end
1501
+
1502
+ # @!attribute [rw] has_access
1503
+ # Specifies whether the user has access to the document based on the
1504
+ # ingested access control list (ACL). Returns `true` if the user is
1505
+ # allowed access, and `false` otherwise.
1506
+ # @return [Boolean]
1507
+ #
1508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CheckIngestedDocumentAclResponse AWS API Documentation
1509
+ #
1510
+ class CheckIngestedDocumentAclResponse < Struct.new(
1511
+ :has_access)
1512
+ SENSITIVE = []
1513
+ include Aws::Structure
1514
+ end
1515
+
1472
1516
  # An object containing a segment of the generated response that is based
1473
1517
  # on a source in the knowledge base, alongside information about the
1474
1518
  # source.
@@ -2037,6 +2081,114 @@ module Aws::BedrockAgentRuntime
2037
2081
  include Aws::Structure
2038
2082
  end
2039
2083
 
2084
+ # The access control list for a document, containing allow and deny
2085
+ # membership lists. Each list specifies conditions that determine which
2086
+ # users and groups are granted or denied access.
2087
+ #
2088
+ # @!attribute [rw] allow_list
2089
+ # The list of principals allowed access to the document.
2090
+ # @return [Types::DocumentAclMembership]
2091
+ #
2092
+ # @!attribute [rw] deny_list
2093
+ # The list of principals denied access to the document.
2094
+ # @return [Types::DocumentAclMembership]
2095
+ #
2096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAcl AWS API Documentation
2097
+ #
2098
+ class DocumentAcl < Struct.new(
2099
+ :allow_list,
2100
+ :deny_list)
2101
+ SENSITIVE = []
2102
+ include Aws::Structure
2103
+ end
2104
+
2105
+ # A condition within a document access control list (ACL) membership,
2106
+ # specifying users and groups that are evaluated together.
2107
+ #
2108
+ # @!attribute [rw] condition_operator
2109
+ # The logical operator for combining users and groups within this
2110
+ # condition. Valid values: `AND` – Both a user match and a group match
2111
+ # are required. `OR` – Either a user match or a group match is
2112
+ # sufficient.
2113
+ # @return [String]
2114
+ #
2115
+ # @!attribute [rw] groups
2116
+ # The list of group entries in this condition.
2117
+ # @return [Array<Types::DocumentAclGroup>]
2118
+ #
2119
+ # @!attribute [rw] users
2120
+ # The list of user entries in this condition.
2121
+ # @return [Array<Types::DocumentAclUser>]
2122
+ #
2123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclCondition AWS API Documentation
2124
+ #
2125
+ class DocumentAclCondition < Struct.new(
2126
+ :condition_operator,
2127
+ :groups,
2128
+ :users)
2129
+ SENSITIVE = []
2130
+ include Aws::Structure
2131
+ end
2132
+
2133
+ # A group entry within a document access control list (ACL) condition.
2134
+ #
2135
+ # @!attribute [rw] id
2136
+ # The identifier of the group.
2137
+ # @return [String]
2138
+ #
2139
+ # @!attribute [rw] type
2140
+ # The membership type indicating the scope of the group entry.
2141
+ # @return [String]
2142
+ #
2143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclGroup AWS API Documentation
2144
+ #
2145
+ class DocumentAclGroup < Struct.new(
2146
+ :id,
2147
+ :type)
2148
+ SENSITIVE = []
2149
+ include Aws::Structure
2150
+ end
2151
+
2152
+ # The membership entry for a document access control list (ACL),
2153
+ # containing conditions and their logical relation.
2154
+ #
2155
+ # @!attribute [rw] conditions
2156
+ # The list of conditions that determine membership.
2157
+ # @return [Array<Types::DocumentAclCondition>]
2158
+ #
2159
+ # @!attribute [rw] member_relation
2160
+ # The logical relation between conditions. Valid values: `AND` – All
2161
+ # conditions must match. `OR` – At least one condition must match.
2162
+ # @return [String]
2163
+ #
2164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclMembership AWS API Documentation
2165
+ #
2166
+ class DocumentAclMembership < Struct.new(
2167
+ :conditions,
2168
+ :member_relation)
2169
+ SENSITIVE = []
2170
+ include Aws::Structure
2171
+ end
2172
+
2173
+ # A user entry within a document access control list (ACL) condition.
2174
+ #
2175
+ # @!attribute [rw] id
2176
+ # The identifier of the user.
2177
+ # @return [String]
2178
+ #
2179
+ # @!attribute [rw] type
2180
+ # The membership type indicating the scope of the user entry.
2181
+ # @return [String]
2182
+ #
2183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclUser AWS API Documentation
2184
+ #
2185
+ class DocumentAclUser < Struct.new(
2186
+ :id,
2187
+ :type)
2188
+ SENSITIVE = []
2189
+ include Aws::Structure
2190
+ end
2191
+
2040
2192
  # @!attribute [rw] session_identifier
2041
2193
  # The unique identifier for the session to end. You can specify either
2042
2194
  # the session's `sessionId` or its Amazon Resource Name (ARN).
@@ -3710,10 +3862,9 @@ module Aws::BedrockAgentRuntime
3710
3862
  # @return [String]
3711
3863
  #
3712
3864
  # @!attribute [rw] user_context
3713
- # Contains information about the user making the request. Use this to
3714
- # pass user identity information for access control filtering, so that
3715
- # retrieval results only include documents the user is authorized to
3716
- # access.
3865
+ # Contains information about the user making the request. This is used
3866
+ # for access control filtering to ensure that results only include
3867
+ # documents the user is authorized to access.
3717
3868
  # @return [Types::UserContext]
3718
3869
  #
3719
3870
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetDocumentContentRequest AWS API Documentation
@@ -3900,6 +4051,43 @@ module Aws::BedrockAgentRuntime
3900
4051
  include Aws::Structure
3901
4052
  end
3902
4053
 
4054
+ # @!attribute [rw] data_source_id
4055
+ # The unique identifier of the data source that contains the document.
4056
+ # @return [String]
4057
+ #
4058
+ # @!attribute [rw] document_id
4059
+ # The unique identifier of the document to retrieve the ingested
4060
+ # access control list (ACL) for.
4061
+ # @return [String]
4062
+ #
4063
+ # @!attribute [rw] knowledge_base_id
4064
+ # The unique identifier of the knowledge base that contains the
4065
+ # document.
4066
+ # @return [String]
4067
+ #
4068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetIngestedDocumentAclRequest AWS API Documentation
4069
+ #
4070
+ class GetIngestedDocumentAclRequest < Struct.new(
4071
+ :data_source_id,
4072
+ :document_id,
4073
+ :knowledge_base_id)
4074
+ SENSITIVE = []
4075
+ include Aws::Structure
4076
+ end
4077
+
4078
+ # @!attribute [rw] document_acl
4079
+ # The ingested document access control list (ACL) containing allow and
4080
+ # deny membership information.
4081
+ # @return [Types::DocumentAcl]
4082
+ #
4083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetIngestedDocumentAclResponse AWS API Documentation
4084
+ #
4085
+ class GetIngestedDocumentAclResponse < Struct.new(
4086
+ :document_acl)
4087
+ SENSITIVE = [:document_acl]
4088
+ include Aws::Structure
4089
+ end
4090
+
3903
4091
  # @!attribute [rw] invocation_identifier
3904
4092
  # The unique identifier for the invocation in UUID format.
3905
4093
  # @return [String]
@@ -6183,22 +6371,8 @@ module Aws::BedrockAgentRuntime
6183
6371
  # store configuration.
6184
6372
  #
6185
6373
  # @!attribute [rw] filter
6186
- # Specifies the filters to use on the metadata attributes in the
6187
- # knowledge base data sources before returning results. For more
6188
- # information, see [Query configurations][1]. See the examples below
6189
- # to see how to use these filters.
6190
- #
6191
- # This data type is used in the following API operations:
6192
- #
6193
- # * [Retrieve request][2] – in the `filter` field
6194
- #
6195
- # * [RetrieveAndGenerate request][3] – in the `filter` field
6196
- #
6197
- #
6198
- #
6199
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
6200
- # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
6201
- # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
6374
+ # Filters the metadata of the retrieved results so that Amazon Bedrock
6375
+ # returns only results that match the filter.
6202
6376
  # @return [Types::RetrievalFilter]
6203
6377
  #
6204
6378
  # @!attribute [rw] number_of_results
@@ -8846,10 +9020,9 @@ module Aws::BedrockAgentRuntime
8846
9020
  # @return [String]
8847
9021
  #
8848
9022
  # @!attribute [rw] user_context
8849
- # Contains information about the user making the request. Use this to
8850
- # pass user identity information for access control filtering, so that
8851
- # retrieval results only include documents the user is authorized to
8852
- # access.
9023
+ # Contains information about the user making the request. This is used
9024
+ # for access control filtering to ensure that retrieval results only
9025
+ # include documents the user is authorized to access.
8853
9026
  # @return [Types::UserContext]
8854
9027
  #
8855
9028
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateRequest AWS API Documentation
@@ -8950,10 +9123,9 @@ module Aws::BedrockAgentRuntime
8950
9123
  # @return [String]
8951
9124
  #
8952
9125
  # @!attribute [rw] user_context
8953
- # Contains information about the user making the request. Use this to
8954
- # pass user identity information for access control filtering, so that
8955
- # retrieval results only include documents the user is authorized to
8956
- # access.
9126
+ # Contains information about the user making the request. This is used
9127
+ # for access control filtering to ensure that retrieval results only
9128
+ # include documents the user is authorized to access.
8957
9129
  # @return [Types::UserContext]
8958
9130
  #
8959
9131
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamRequest AWS API Documentation
@@ -9013,10 +9185,9 @@ module Aws::BedrockAgentRuntime
9013
9185
  # @return [Types::KnowledgeBaseQuery]
9014
9186
  #
9015
9187
  # @!attribute [rw] user_context
9016
- # Contains information about the user making the request. Use this to
9017
- # pass user identity information for access control filtering, so that
9018
- # retrieval results only include documents the user is authorized to
9019
- # access.
9188
+ # Contains information about the user making the request. This is used
9189
+ # for access control filtering to ensure that retrieval results only
9190
+ # include documents the user is authorized to access.
9020
9191
  # @return [Types::UserContext]
9021
9192
  #
9022
9193
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveRequest AWS API Documentation
@@ -56,7 +56,7 @@ module Aws::BedrockAgentRuntime
56
56
  autoload :Endpoints, 'aws-sdk-bedrockagentruntime/endpoints'
57
57
  autoload :EventStreams, 'aws-sdk-bedrockagentruntime/event_streams'
58
58
 
59
- GEM_VERSION = '1.78.0'
59
+ GEM_VERSION = '1.79.0'
60
60
 
61
61
  end
62
62
 
data/sig/client.rbs CHANGED
@@ -144,6 +144,21 @@ module Aws
144
144
  ) ?{ (*untyped) -> void } -> _AgenticRetrieveStreamResponseSuccess
145
145
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _AgenticRetrieveStreamResponseSuccess
146
146
 
147
+ interface _CheckIngestedDocumentAclResponseSuccess
148
+ include ::Seahorse::Client::_ResponseSuccess[Types::CheckIngestedDocumentAclResponse]
149
+ def has_access: () -> bool
150
+ end
151
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgentRuntime/Client.html#check_ingested_document_acl-instance_method
152
+ def check_ingested_document_acl: (
153
+ data_source_id: ::String,
154
+ document_id: ::String,
155
+ knowledge_base_id: ::String,
156
+ user_context: {
157
+ user_id: ::String
158
+ }
159
+ ) -> _CheckIngestedDocumentAclResponseSuccess
160
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CheckIngestedDocumentAclResponseSuccess
161
+
147
162
  interface _CreateInvocationResponseSuccess
148
163
  include ::Seahorse::Client::_ResponseSuccess[Types::CreateInvocationResponse]
149
164
  def created_at: () -> ::Time
@@ -298,6 +313,18 @@ module Aws
298
313
  ) -> _GetFlowExecutionResponseSuccess
299
314
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFlowExecutionResponseSuccess
300
315
 
316
+ interface _GetIngestedDocumentAclResponseSuccess
317
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetIngestedDocumentAclResponse]
318
+ def document_acl: () -> Types::DocumentAcl
319
+ end
320
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgentRuntime/Client.html#get_ingested_document_acl-instance_method
321
+ def get_ingested_document_acl: (
322
+ data_source_id: ::String,
323
+ document_id: ::String,
324
+ knowledge_base_id: ::String
325
+ ) -> _GetIngestedDocumentAclResponseSuccess
326
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetIngestedDocumentAclResponseSuccess
327
+
301
328
  interface _GetInvocationStepResponseSuccess
302
329
  include ::Seahorse::Client::_ResponseSuccess[Types::GetInvocationStepResponse]
303
330
  def invocation_step: () -> Types::InvocationStep
data/sig/types.rbs CHANGED
@@ -421,6 +421,19 @@ module Aws::BedrockAgentRuntime
421
421
  end
422
422
  end
423
423
 
424
+ class CheckIngestedDocumentAclRequest
425
+ attr_accessor data_source_id: ::String
426
+ attr_accessor document_id: ::String
427
+ attr_accessor knowledge_base_id: ::String
428
+ attr_accessor user_context: Types::UserContext
429
+ SENSITIVE: [:user_context]
430
+ end
431
+
432
+ class CheckIngestedDocumentAclResponse
433
+ attr_accessor has_access: bool
434
+ SENSITIVE: []
435
+ end
436
+
424
437
  class Citation
425
438
  attr_accessor generated_response_part: Types::GeneratedResponsePart
426
439
  attr_accessor retrieved_references: ::Array[Types::RetrievedReference]
@@ -579,6 +592,37 @@ module Aws::BedrockAgentRuntime
579
592
  SENSITIVE: []
580
593
  end
581
594
 
595
+ class DocumentAcl
596
+ attr_accessor allow_list: Types::DocumentAclMembership
597
+ attr_accessor deny_list: Types::DocumentAclMembership
598
+ SENSITIVE: []
599
+ end
600
+
601
+ class DocumentAclCondition
602
+ attr_accessor condition_operator: ("AND" | "OR")
603
+ attr_accessor groups: ::Array[Types::DocumentAclGroup]
604
+ attr_accessor users: ::Array[Types::DocumentAclUser]
605
+ SENSITIVE: []
606
+ end
607
+
608
+ class DocumentAclGroup
609
+ attr_accessor id: ::String
610
+ attr_accessor type: ("KNOWLEDGE_BASE" | "DATA_SOURCE")
611
+ SENSITIVE: []
612
+ end
613
+
614
+ class DocumentAclMembership
615
+ attr_accessor conditions: ::Array[Types::DocumentAclCondition]
616
+ attr_accessor member_relation: ("AND" | "OR")
617
+ SENSITIVE: []
618
+ end
619
+
620
+ class DocumentAclUser
621
+ attr_accessor id: ::String
622
+ attr_accessor type: ("KNOWLEDGE_BASE" | "DATA_SOURCE")
623
+ SENSITIVE: []
624
+ end
625
+
582
626
  class EndSessionRequest
583
627
  attr_accessor session_identifier: ::String
584
628
  SENSITIVE: []
@@ -1096,6 +1140,18 @@ module Aws::BedrockAgentRuntime
1096
1140
  SENSITIVE: []
1097
1141
  end
1098
1142
 
1143
+ class GetIngestedDocumentAclRequest
1144
+ attr_accessor data_source_id: ::String
1145
+ attr_accessor document_id: ::String
1146
+ attr_accessor knowledge_base_id: ::String
1147
+ SENSITIVE: []
1148
+ end
1149
+
1150
+ class GetIngestedDocumentAclResponse
1151
+ attr_accessor document_acl: Types::DocumentAcl
1152
+ SENSITIVE: [:document_acl]
1153
+ end
1154
+
1099
1155
  class GetInvocationStepRequest
1100
1156
  attr_accessor invocation_identifier: ::String
1101
1157
  attr_accessor invocation_step_id: ::String
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-bedrockagentruntime
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.78.0
4
+ version: 1.79.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services