@aws-sdk/client-bedrock-agent-runtime 3.1110.0 → 3.1111.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.
Files changed (47) hide show
  1. package/README.md +15 -1
  2. package/dist-cjs/index.js +135 -21
  3. package/dist-es/BedrockAgentRuntime.js +4 -0
  4. package/dist-es/commands/CheckIngestedDocumentAclCommand.js +4 -0
  5. package/dist-es/commands/GetIngestedDocumentAclCommand.js +4 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +8 -0
  8. package/dist-es/schemas/schemas_0.js +103 -20
  9. package/dist-types/BedrockAgentRuntime.d.ts +15 -1
  10. package/dist-types/BedrockAgentRuntimeClient.d.ts +5 -3
  11. package/dist-types/commands/CheckIngestedDocumentAclCommand.d.ts +91 -0
  12. package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateSessionCommand.d.ts +2 -1
  14. package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
  15. package/dist-types/commands/EndSessionCommand.d.ts +1 -1
  16. package/dist-types/commands/GetIngestedDocumentAclCommand.d.ts +129 -0
  17. package/dist-types/commands/GetSessionCommand.d.ts +1 -1
  18. package/dist-types/commands/InvokeAgentCommand.d.ts +1 -1
  19. package/dist-types/commands/index.d.ts +2 -0
  20. package/dist-types/index.d.ts +1 -1
  21. package/dist-types/models/enums.d.ts +24 -0
  22. package/dist-types/models/models_0.d.ts +152 -162
  23. package/dist-types/models/models_1.d.ts +164 -4
  24. package/dist-types/runtimeConfig.browser.d.ts +39 -39
  25. package/dist-types/runtimeConfig.d.ts +36 -36
  26. package/dist-types/runtimeConfig.native.d.ts +38 -38
  27. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  28. package/dist-types/schemas/schemas_0.d.ts +11 -0
  29. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
  30. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
  31. package/dist-types/ts3.4/commands/CheckIngestedDocumentAclCommand.d.ts +42 -0
  32. package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
  33. package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +2 -1
  34. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/GetIngestedDocumentAclCommand.d.ts +39 -0
  37. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  39. package/dist-types/ts3.4/models/enums.d.ts +12 -0
  40. package/dist-types/ts3.4/models/models_0.d.ts +40 -41
  41. package/dist-types/ts3.4/models/models_1.d.ts +40 -0
  42. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +55 -57
  43. package/dist-types/ts3.4/runtimeConfig.d.ts +58 -58
  44. package/dist-types/ts3.4/runtimeConfig.native.d.ts +59 -61
  45. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +3 -3
  46. package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
  47. package/package.json +5 -5
@@ -0,0 +1,129 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetIngestedDocumentAclRequest, GetIngestedDocumentAclResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetIngestedDocumentAclCommand}.
11
+ */
12
+ export interface GetIngestedDocumentAclCommandInput extends GetIngestedDocumentAclRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetIngestedDocumentAclCommand}.
18
+ */
19
+ export interface GetIngestedDocumentAclCommandOutput extends GetIngestedDocumentAclResponse, __MetadataBearer {
20
+ }
21
+ declare const GetIngestedDocumentAclCommand_base: {
22
+ new (input: GetIngestedDocumentAclCommandInput): import("@smithy/core/client").CommandImpl<GetIngestedDocumentAclCommandInput, GetIngestedDocumentAclCommandOutput, import("..").BedrockAgentRuntimeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetIngestedDocumentAclCommandInput): import("@smithy/core/client").CommandImpl<GetIngestedDocumentAclCommandInput, GetIngestedDocumentAclCommandOutput, import("..").BedrockAgentRuntimeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves the ingested access control list (ACL) for a specific document in a knowledge base. Use this operation to inspect the allow and deny lists that were ingested for a document to troubleshoot access control issues. To use this operation, you must have the <code>bedrock:GetIngestedDocumentAcl</code> permission.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { BedrockAgentRuntimeClient, GetIngestedDocumentAclCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
32
+ * // const { BedrockAgentRuntimeClient, GetIngestedDocumentAclCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
33
+ * // import type { BedrockAgentRuntimeClientConfig } from "@aws-sdk/client-bedrock-agent-runtime";
34
+ * const config = {}; // type is BedrockAgentRuntimeClientConfig
35
+ * const client = new BedrockAgentRuntimeClient(config);
36
+ * const input = { // GetIngestedDocumentAclRequest
37
+ * knowledgeBaseId: "STRING_VALUE", // required
38
+ * dataSourceId: "STRING_VALUE", // required
39
+ * documentId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetIngestedDocumentAclCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetIngestedDocumentAclResponse
44
+ * // documentAcl: { // DocumentAcl
45
+ * // allowList: { // DocumentAclMembership
46
+ * // memberRelation: "AND" || "OR",
47
+ * // conditions: [ // DocumentAclConditionList
48
+ * // { // DocumentAclCondition
49
+ * // conditionOperator: "AND" || "OR",
50
+ * // users: [ // DocumentAclUserList
51
+ * // { // DocumentAclUser
52
+ * // id: "STRING_VALUE", // required
53
+ * // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
54
+ * // },
55
+ * // ],
56
+ * // groups: [ // DocumentAclGroupList
57
+ * // { // DocumentAclGroup
58
+ * // id: "STRING_VALUE", // required
59
+ * // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
60
+ * // },
61
+ * // ],
62
+ * // },
63
+ * // ],
64
+ * // },
65
+ * // denyList: {
66
+ * // memberRelation: "AND" || "OR",
67
+ * // conditions: [
68
+ * // {
69
+ * // conditionOperator: "AND" || "OR",
70
+ * // users: [
71
+ * // {
72
+ * // id: "STRING_VALUE", // required
73
+ * // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
74
+ * // },
75
+ * // ],
76
+ * // groups: [
77
+ * // {
78
+ * // id: "STRING_VALUE", // required
79
+ * // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
80
+ * // },
81
+ * // ],
82
+ * // },
83
+ * // ],
84
+ * // },
85
+ * // },
86
+ * // };
87
+ *
88
+ * ```
89
+ *
90
+ * @param GetIngestedDocumentAclCommandInput - {@link GetIngestedDocumentAclCommandInput}
91
+ * @returns {@link GetIngestedDocumentAclCommandOutput}
92
+ * @see {@link GetIngestedDocumentAclCommandInput} for command's `input` shape.
93
+ * @see {@link GetIngestedDocumentAclCommandOutput} for command's `response` shape.
94
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
95
+ *
96
+ * @throws {@link AccessDeniedException} (client fault)
97
+ * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
98
+ *
99
+ * @throws {@link InternalServerException} (server fault)
100
+ * <p>An internal server error occurred. Retry your request.</p>
101
+ *
102
+ * @throws {@link ResourceNotFoundException} (client fault)
103
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
104
+ *
105
+ * @throws {@link ThrottlingException} (client fault)
106
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
107
+ *
108
+ * @throws {@link ValidationException} (client fault)
109
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
110
+ *
111
+ * @throws {@link BedrockAgentRuntimeServiceException}
112
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
113
+ *
114
+ *
115
+ * @public
116
+ */
117
+ export declare class GetIngestedDocumentAclCommand extends GetIngestedDocumentAclCommand_base {
118
+ /** @internal type navigation helper, not in runtime. */
119
+ protected static __types: {
120
+ api: {
121
+ input: GetIngestedDocumentAclRequest;
122
+ output: GetIngestedDocumentAclResponse;
123
+ };
124
+ sdk: {
125
+ input: GetIngestedDocumentAclCommandInput;
126
+ output: GetIngestedDocumentAclCommandOutput;
127
+ };
128
+ };
129
+ }
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { GetSessionRequest, GetSessionResponse } from "../models/models_0";
2
+ import type { GetSessionRequest, GetSessionResponse } from "../models/models_1";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -25,7 +25,7 @@ declare const InvokeAgentCommand_base: {
25
25
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
26
26
  };
27
27
  /**
28
- * <note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>
28
+ * <note> <p>Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html">Amazon Bedrock Agents Classic availability change</a>.</p> </note> <note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -1,4 +1,5 @@
1
1
  export * from "./AgenticRetrieveStreamCommand";
2
+ export * from "./CheckIngestedDocumentAclCommand";
2
3
  export * from "./CreateInvocationCommand";
3
4
  export * from "./CreateSessionCommand";
4
5
  export * from "./DeleteAgentMemoryCommand";
@@ -9,6 +10,7 @@ export * from "./GetAgentMemoryCommand";
9
10
  export * from "./GetDocumentContentCommand";
10
11
  export * from "./GetExecutionFlowSnapshotCommand";
11
12
  export * from "./GetFlowExecutionCommand";
13
+ export * from "./GetIngestedDocumentAclCommand";
12
14
  export * from "./GetInvocationStepCommand";
13
15
  export * from "./GetSessionCommand";
14
16
  export * from "./InvokeAgentCommand";
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
2
+ * <note> <p>Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html">Amazon Bedrock Agents Classic availability change</a>.</p> </note> <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
3
3
  *
4
4
  * @packageDocumentation
5
5
  */
@@ -734,6 +734,30 @@ export declare const DocumentOutputFormat: {
734
734
  * @public
735
735
  */
736
736
  export type DocumentOutputFormat = (typeof DocumentOutputFormat)[keyof typeof DocumentOutputFormat];
737
+ /**
738
+ * @public
739
+ * @enum
740
+ */
741
+ export declare const DocumentAclMemberRelation: {
742
+ readonly AND: "AND";
743
+ readonly OR: "OR";
744
+ };
745
+ /**
746
+ * @public
747
+ */
748
+ export type DocumentAclMemberRelation = (typeof DocumentAclMemberRelation)[keyof typeof DocumentAclMemberRelation];
749
+ /**
750
+ * @public
751
+ * @enum
752
+ */
753
+ export declare const DocumentAclMembershipType: {
754
+ readonly DATA_SOURCE: "DATA_SOURCE";
755
+ readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
756
+ };
757
+ /**
758
+ * @public
759
+ */
760
+ export type DocumentAclMembershipType = (typeof DocumentAclMembershipType)[keyof typeof DocumentAclMembershipType];
737
761
  /**
738
762
  * @public
739
763
  * @enum
@@ -1,5 +1,5 @@
1
1
  import type { DocumentType as __DocumentType } from "@smithy/types";
2
- import type { ActionGroupSignature, ActionInvocationType, AgenticRetrieveRerankingConfigurationType, AgenticRetrieveRerankingModelType, AgenticRetrieveStatus, AgenticRetrieveStep, AgenticRetrieveType, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, DocumentOutputFormat, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, FoundationModelConfigurationType, FoundationModelType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageInputFormat, InputImageFormat, InputQueryType, InvocationType, KnowledgeBaseQueryType, ManagedSearchRerankingConfigurationType, MemoryType, NodeErrorCode, NodeType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, SessionStatus, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
2
+ import type { ActionGroupSignature, ActionInvocationType, AgenticRetrieveRerankingConfigurationType, AgenticRetrieveRerankingModelType, AgenticRetrieveStatus, AgenticRetrieveStep, AgenticRetrieveType, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, DocumentAclMemberRelation, DocumentAclMembershipType, DocumentOutputFormat, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, FoundationModelConfigurationType, FoundationModelType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageInputFormat, InputImageFormat, InputQueryType, InvocationType, KnowledgeBaseQueryType, ManagedSearchRerankingConfigurationType, MemoryType, NodeErrorCode, NodeType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
3
3
  import type { AccessDeniedException, BadGatewayException, ConflictException, DependencyFailedException, InternalServerException, ModelNotReadyException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException } from "./errors";
4
4
  /**
5
5
  * <p> Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. </p>
@@ -3267,6 +3267,41 @@ export interface TracePart {
3267
3267
  */
3268
3268
  agentVersion?: string | undefined;
3269
3269
  }
3270
+ /**
3271
+ * @public
3272
+ */
3273
+ export interface CheckIngestedDocumentAclRequest {
3274
+ /**
3275
+ * <p>The unique identifier of the knowledge base that contains the document.</p>
3276
+ * @public
3277
+ */
3278
+ knowledgeBaseId: string | undefined;
3279
+ /**
3280
+ * <p>The unique identifier of the data source that contains the document.</p>
3281
+ * @public
3282
+ */
3283
+ dataSourceId: string | undefined;
3284
+ /**
3285
+ * <p>The unique identifier of the document to check access for.</p>
3286
+ * @public
3287
+ */
3288
+ documentId: string | undefined;
3289
+ /**
3290
+ * <p>The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).</p>
3291
+ * @public
3292
+ */
3293
+ userContext: UserContext | undefined;
3294
+ }
3295
+ /**
3296
+ * @public
3297
+ */
3298
+ export interface CheckIngestedDocumentAclResponse {
3299
+ /**
3300
+ * <p>Specifies whether the user has access to the document based on the ingested access control list (ACL). Returns <code>true</code> if the user is allowed access, and <code>false</code> otherwise.</p>
3301
+ * @public
3302
+ */
3303
+ hasAccess: boolean | undefined;
3304
+ }
3270
3305
  /**
3271
3306
  * @public
3272
3307
  */
@@ -5418,7 +5453,7 @@ export interface GetDocumentContentRequest {
5418
5453
  */
5419
5454
  outputFormat?: DocumentOutputFormat | undefined;
5420
5455
  /**
5421
- * <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
5456
+ * <p>Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.</p>
5422
5457
  * @public
5423
5458
  */
5424
5459
  userContext?: UserContext | undefined;
@@ -5443,6 +5478,121 @@ export interface GetDocumentContentResponse {
5443
5478
  */
5444
5479
  documentContentLength?: number | undefined;
5445
5480
  }
5481
+ /**
5482
+ * @public
5483
+ */
5484
+ export interface GetIngestedDocumentAclRequest {
5485
+ /**
5486
+ * <p>The unique identifier of the knowledge base that contains the document.</p>
5487
+ * @public
5488
+ */
5489
+ knowledgeBaseId: string | undefined;
5490
+ /**
5491
+ * <p>The unique identifier of the data source that contains the document.</p>
5492
+ * @public
5493
+ */
5494
+ dataSourceId: string | undefined;
5495
+ /**
5496
+ * <p>The unique identifier of the document to retrieve the ingested access control list (ACL) for.</p>
5497
+ * @public
5498
+ */
5499
+ documentId: string | undefined;
5500
+ }
5501
+ /**
5502
+ * <p>A group entry within a document access control list (ACL) condition.</p>
5503
+ * @public
5504
+ */
5505
+ export interface DocumentAclGroup {
5506
+ /**
5507
+ * <p>The identifier of the group.</p>
5508
+ * @public
5509
+ */
5510
+ id: string | undefined;
5511
+ /**
5512
+ * <p>The membership type indicating the scope of the group entry.</p>
5513
+ * @public
5514
+ */
5515
+ type: DocumentAclMembershipType | undefined;
5516
+ }
5517
+ /**
5518
+ * <p>A user entry within a document access control list (ACL) condition.</p>
5519
+ * @public
5520
+ */
5521
+ export interface DocumentAclUser {
5522
+ /**
5523
+ * <p>The identifier of the user.</p>
5524
+ * @public
5525
+ */
5526
+ id: string | undefined;
5527
+ /**
5528
+ * <p>The membership type indicating the scope of the user entry.</p>
5529
+ * @public
5530
+ */
5531
+ type: DocumentAclMembershipType | undefined;
5532
+ }
5533
+ /**
5534
+ * <p>A condition within a document access control list (ACL) membership, specifying users and groups that are evaluated together.</p>
5535
+ * @public
5536
+ */
5537
+ export interface DocumentAclCondition {
5538
+ /**
5539
+ * <p>The logical operator for combining users and groups within this condition. Valid values: <code>AND</code> – Both a user match and a group match are required. <code>OR</code> – Either a user match or a group match is sufficient.</p>
5540
+ * @public
5541
+ */
5542
+ conditionOperator?: DocumentAclMemberRelation | undefined;
5543
+ /**
5544
+ * <p>The list of user entries in this condition.</p>
5545
+ * @public
5546
+ */
5547
+ users?: DocumentAclUser[] | undefined;
5548
+ /**
5549
+ * <p>The list of group entries in this condition.</p>
5550
+ * @public
5551
+ */
5552
+ groups?: DocumentAclGroup[] | undefined;
5553
+ }
5554
+ /**
5555
+ * <p>The membership entry for a document access control list (ACL), containing conditions and their logical relation.</p>
5556
+ * @public
5557
+ */
5558
+ export interface DocumentAclMembership {
5559
+ /**
5560
+ * <p>The logical relation between conditions. Valid values: <code>AND</code> – All conditions must match. <code>OR</code> – At least one condition must match.</p>
5561
+ * @public
5562
+ */
5563
+ memberRelation?: DocumentAclMemberRelation | undefined;
5564
+ /**
5565
+ * <p>The list of conditions that determine membership.</p>
5566
+ * @public
5567
+ */
5568
+ conditions?: DocumentAclCondition[] | undefined;
5569
+ }
5570
+ /**
5571
+ * <p>The access control list for a document, containing allow and deny membership lists. Each list specifies conditions that determine which users and groups are granted or denied access.</p>
5572
+ * @public
5573
+ */
5574
+ export interface DocumentAcl {
5575
+ /**
5576
+ * <p>The list of principals allowed access to the document.</p>
5577
+ * @public
5578
+ */
5579
+ allowList?: DocumentAclMembership | undefined;
5580
+ /**
5581
+ * <p>The list of principals denied access to the document.</p>
5582
+ * @public
5583
+ */
5584
+ denyList?: DocumentAclMembership | undefined;
5585
+ }
5586
+ /**
5587
+ * @public
5588
+ */
5589
+ export interface GetIngestedDocumentAclResponse {
5590
+ /**
5591
+ * <p>The ingested document access control list (ACL) containing allow and deny membership information.</p>
5592
+ * @public
5593
+ */
5594
+ documentAcl: DocumentAcl | undefined;
5595
+ }
5446
5596
  /**
5447
5597
  * <p>Settings for a model called with <a>InvokeAgent</a>.</p>
5448
5598
  * @public
@@ -8259,163 +8409,3 @@ export interface CreateSessionRequest {
8259
8409
  */
8260
8410
  tags?: Record<string, string> | undefined;
8261
8411
  }
8262
- /**
8263
- * @public
8264
- */
8265
- export interface CreateSessionResponse {
8266
- /**
8267
- * <p>The unique identifier for the session.</p>
8268
- * @public
8269
- */
8270
- sessionId: string | undefined;
8271
- /**
8272
- * <p>The Amazon Resource Name (ARN) of the created session.</p>
8273
- * @public
8274
- */
8275
- sessionArn: string | undefined;
8276
- /**
8277
- * <p>The current status of the session.</p>
8278
- * @public
8279
- */
8280
- sessionStatus: SessionStatus | undefined;
8281
- /**
8282
- * <p>The timestamp for when the session was created.</p>
8283
- * @public
8284
- */
8285
- createdAt: Date | undefined;
8286
- }
8287
- /**
8288
- * @public
8289
- */
8290
- export interface DeleteSessionRequest {
8291
- /**
8292
- * <p>The unique identifier for the session to be deleted. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
8293
- * @public
8294
- */
8295
- sessionIdentifier: string | undefined;
8296
- }
8297
- /**
8298
- * @public
8299
- */
8300
- export interface DeleteSessionResponse {
8301
- }
8302
- /**
8303
- * @public
8304
- */
8305
- export interface EndSessionRequest {
8306
- /**
8307
- * <p>The unique identifier for the session to end. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
8308
- * @public
8309
- */
8310
- sessionIdentifier: string | undefined;
8311
- }
8312
- /**
8313
- * @public
8314
- */
8315
- export interface EndSessionResponse {
8316
- /**
8317
- * <p>The unique identifier of the session you ended.</p>
8318
- * @public
8319
- */
8320
- sessionId: string | undefined;
8321
- /**
8322
- * <p>The Amazon Resource Name (ARN) of the session you ended.</p>
8323
- * @public
8324
- */
8325
- sessionArn: string | undefined;
8326
- /**
8327
- * <p>The current status of the session you ended.</p>
8328
- * @public
8329
- */
8330
- sessionStatus: SessionStatus | undefined;
8331
- }
8332
- /**
8333
- * @public
8334
- */
8335
- export interface GetSessionRequest {
8336
- /**
8337
- * <p>A unique identifier for the session to retrieve. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
8338
- * @public
8339
- */
8340
- sessionIdentifier: string | undefined;
8341
- }
8342
- /**
8343
- * @public
8344
- */
8345
- export interface GetSessionResponse {
8346
- /**
8347
- * <p>The unique identifier for the session in UUID format.</p>
8348
- * @public
8349
- */
8350
- sessionId: string | undefined;
8351
- /**
8352
- * <p>The Amazon Resource Name (ARN) of the session.</p>
8353
- * @public
8354
- */
8355
- sessionArn: string | undefined;
8356
- /**
8357
- * <p>The current status of the session.</p>
8358
- * @public
8359
- */
8360
- sessionStatus: SessionStatus | undefined;
8361
- /**
8362
- * <p>The timestamp for when the session was created.</p>
8363
- * @public
8364
- */
8365
- createdAt: Date | undefined;
8366
- /**
8367
- * <p>The timestamp for when the session was last modified.</p>
8368
- * @public
8369
- */
8370
- lastUpdatedAt: Date | undefined;
8371
- /**
8372
- * <p>A map of key-value pairs containing attributes persisted across the session.</p>
8373
- * @public
8374
- */
8375
- sessionMetadata?: Record<string, string> | undefined;
8376
- /**
8377
- * <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
8378
- * @public
8379
- */
8380
- encryptionKeyArn?: string | undefined;
8381
- }
8382
- /**
8383
- * @public
8384
- */
8385
- export interface CreateInvocationRequest {
8386
- /**
8387
- * <p>A unique identifier for the invocation in UUID format.</p>
8388
- * @public
8389
- */
8390
- invocationId?: string | undefined;
8391
- /**
8392
- * <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
8393
- * @public
8394
- */
8395
- description?: string | undefined;
8396
- /**
8397
- * <p>The unique identifier for the associated session for the invocation. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN). </p>
8398
- * @public
8399
- */
8400
- sessionIdentifier: string | undefined;
8401
- }
8402
- /**
8403
- * @public
8404
- */
8405
- export interface CreateInvocationResponse {
8406
- /**
8407
- * <p>The unique identifier for the session associated with the invocation.</p>
8408
- * @public
8409
- */
8410
- sessionId: string | undefined;
8411
- /**
8412
- * <p>The unique identifier for the invocation.</p>
8413
- * @public
8414
- */
8415
- invocationId: string | undefined;
8416
- /**
8417
- * <p>The timestamp for when the invocation was created.</p>
8418
- * @public
8419
- */
8420
- createdAt: Date | undefined;
8421
- }