@aws-sdk/client-bedrock-agentcore 3.1038.0 → 3.1040.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 (88) hide show
  1. package/README.md +105 -7
  2. package/dist-cjs/index.js +275 -0
  3. package/dist-cjs/schemas/schemas_0.js +851 -99
  4. package/dist-es/BedrockAgentCore.js +34 -0
  5. package/dist-es/commands/CreateABTestCommand.js +16 -0
  6. package/dist-es/commands/DeleteABTestCommand.js +16 -0
  7. package/dist-es/commands/DeleteBatchEvaluationCommand.js +16 -0
  8. package/dist-es/commands/DeleteRecommendationCommand.js +16 -0
  9. package/dist-es/commands/GetABTestCommand.js +16 -0
  10. package/dist-es/commands/GetBatchEvaluationCommand.js +16 -0
  11. package/dist-es/commands/GetRecommendationCommand.js +16 -0
  12. package/dist-es/commands/ListABTestsCommand.js +16 -0
  13. package/dist-es/commands/ListBatchEvaluationsCommand.js +16 -0
  14. package/dist-es/commands/ListRecommendationsCommand.js +16 -0
  15. package/dist-es/commands/StartBatchEvaluationCommand.js +16 -0
  16. package/dist-es/commands/StartRecommendationCommand.js +16 -0
  17. package/dist-es/commands/StopBatchEvaluationCommand.js +16 -0
  18. package/dist-es/commands/UpdateABTestCommand.js +16 -0
  19. package/dist-es/commands/index.js +14 -0
  20. package/dist-es/index.js +1 -0
  21. package/dist-es/models/enums.js +60 -0
  22. package/dist-es/models/models_1.js +1 -0
  23. package/dist-es/pagination/ListABTestsPaginator.js +4 -0
  24. package/dist-es/pagination/ListBatchEvaluationsPaginator.js +4 -0
  25. package/dist-es/pagination/ListRecommendationsPaginator.js +4 -0
  26. package/dist-es/pagination/index.js +3 -0
  27. package/dist-es/schemas/schemas_0.js +843 -93
  28. package/dist-types/BedrockAgentCore.d.ts +122 -0
  29. package/dist-types/BedrockAgentCoreClient.d.ts +16 -2
  30. package/dist-types/commands/BatchCreateMemoryRecordsCommand.d.ts +10 -0
  31. package/dist-types/commands/BatchUpdateMemoryRecordsCommand.d.ts +10 -0
  32. package/dist-types/commands/CreateABTestCommand.d.ts +134 -0
  33. package/dist-types/commands/DeleteABTestCommand.d.ts +97 -0
  34. package/dist-types/commands/DeleteBatchEvaluationCommand.d.ts +97 -0
  35. package/dist-types/commands/DeleteRecommendationCommand.d.ts +93 -0
  36. package/dist-types/commands/GetABTestCommand.d.ts +165 -0
  37. package/dist-types/commands/GetBatchEvaluationCommand.d.ts +148 -0
  38. package/dist-types/commands/GetMemoryRecordCommand.d.ts +7 -2
  39. package/dist-types/commands/GetRecommendationCommand.d.ts +220 -0
  40. package/dist-types/commands/GetResourceOauth2TokenCommand.d.ts +7 -1
  41. package/dist-types/commands/ListABTestsCommand.d.ts +103 -0
  42. package/dist-types/commands/ListBatchEvaluationsCommand.d.ts +126 -0
  43. package/dist-types/commands/ListMemoryRecordsCommand.d.ts +25 -2
  44. package/dist-types/commands/ListRecommendationsCommand.d.ts +100 -0
  45. package/dist-types/commands/RetrieveMemoryRecordsCommand.d.ts +16 -6
  46. package/dist-types/commands/SearchRegistryRecordsCommand.d.ts +2 -1
  47. package/dist-types/commands/StartBatchEvaluationCommand.d.ts +172 -0
  48. package/dist-types/commands/StartRecommendationCommand.d.ts +300 -0
  49. package/dist-types/commands/StopBatchEvaluationCommand.d.ts +98 -0
  50. package/dist-types/commands/UpdateABTestCommand.d.ts +136 -0
  51. package/dist-types/commands/index.d.ts +14 -0
  52. package/dist-types/index.d.ts +1 -0
  53. package/dist-types/models/enums.d.ts +116 -0
  54. package/dist-types/models/models_0.d.ts +2595 -386
  55. package/dist-types/models/models_1.d.ts +147 -0
  56. package/dist-types/pagination/ListABTestsPaginator.d.ts +7 -0
  57. package/dist-types/pagination/ListBatchEvaluationsPaginator.d.ts +7 -0
  58. package/dist-types/pagination/ListRecommendationsPaginator.d.ts +7 -0
  59. package/dist-types/pagination/index.d.ts +3 -0
  60. package/dist-types/schemas/schemas_0.d.ts +99 -0
  61. package/dist-types/ts3.4/BedrockAgentCore.d.ts +262 -0
  62. package/dist-types/ts3.4/BedrockAgentCoreClient.d.ts +84 -0
  63. package/dist-types/ts3.4/commands/CreateABTestCommand.d.ts +47 -0
  64. package/dist-types/ts3.4/commands/DeleteABTestCommand.d.ts +47 -0
  65. package/dist-types/ts3.4/commands/DeleteBatchEvaluationCommand.d.ts +51 -0
  66. package/dist-types/ts3.4/commands/DeleteRecommendationCommand.d.ts +51 -0
  67. package/dist-types/ts3.4/commands/GetABTestCommand.d.ts +47 -0
  68. package/dist-types/ts3.4/commands/GetBatchEvaluationCommand.d.ts +51 -0
  69. package/dist-types/ts3.4/commands/GetRecommendationCommand.d.ts +51 -0
  70. package/dist-types/ts3.4/commands/ListABTestsCommand.d.ts +47 -0
  71. package/dist-types/ts3.4/commands/ListBatchEvaluationsCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/ListRecommendationsCommand.d.ts +51 -0
  73. package/dist-types/ts3.4/commands/SearchRegistryRecordsCommand.d.ts +2 -4
  74. package/dist-types/ts3.4/commands/StartBatchEvaluationCommand.d.ts +51 -0
  75. package/dist-types/ts3.4/commands/StartRecommendationCommand.d.ts +51 -0
  76. package/dist-types/ts3.4/commands/StopBatchEvaluationCommand.d.ts +51 -0
  77. package/dist-types/ts3.4/commands/UpdateABTestCommand.d.ts +47 -0
  78. package/dist-types/ts3.4/commands/index.d.ts +14 -0
  79. package/dist-types/ts3.4/index.d.ts +1 -0
  80. package/dist-types/ts3.4/models/enums.d.ts +73 -0
  81. package/dist-types/ts3.4/models/models_0.d.ts +801 -43
  82. package/dist-types/ts3.4/models/models_1.d.ts +40 -0
  83. package/dist-types/ts3.4/pagination/ListABTestsPaginator.d.ts +11 -0
  84. package/dist-types/ts3.4/pagination/ListBatchEvaluationsPaginator.d.ts +11 -0
  85. package/dist-types/ts3.4/pagination/ListRecommendationsPaginator.d.ts +11 -0
  86. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  87. package/dist-types/ts3.4/schemas/schemas_0.d.ts +99 -0
  88. package/package.json +7 -7
@@ -1,7 +1,8 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
4
- import type { SearchRegistryRecordsRequest, SearchRegistryRecordsResponse } from "../models/models_0";
4
+ import type { SearchRegistryRecordsRequest } from "../models/models_0";
5
+ import type { SearchRegistryRecordsResponse } from "../models/models_1";
5
6
  /**
6
7
  * @public
7
8
  */
@@ -0,0 +1,172 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
4
+ import type { StartBatchEvaluationRequest, StartBatchEvaluationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartBatchEvaluationCommand}.
14
+ */
15
+ export interface StartBatchEvaluationCommandInput extends StartBatchEvaluationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartBatchEvaluationCommand}.
21
+ */
22
+ export interface StartBatchEvaluationCommandOutput extends StartBatchEvaluationResponse, __MetadataBearer {
23
+ }
24
+ declare const StartBatchEvaluationCommand_base: {
25
+ new (input: StartBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<StartBatchEvaluationCommandInput, StartBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StartBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<StartBatchEvaluationCommandInput, StartBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BedrockAgentCoreClient, StartBatchEvaluationCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
35
+ * // const { BedrockAgentCoreClient, StartBatchEvaluationCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
36
+ * // import type { BedrockAgentCoreClientConfig } from "@aws-sdk/client-bedrock-agentcore";
37
+ * const config = {}; // type is BedrockAgentCoreClientConfig
38
+ * const client = new BedrockAgentCoreClient(config);
39
+ * const input = { // StartBatchEvaluationRequest
40
+ * batchEvaluationName: "STRING_VALUE", // required
41
+ * evaluators: [ // EvaluatorList
42
+ * { // Evaluator
43
+ * evaluatorId: "STRING_VALUE", // required
44
+ * },
45
+ * ],
46
+ * dataSourceConfig: { // DataSourceConfig Union: only one key present
47
+ * cloudWatchLogs: { // CloudWatchLogsSource
48
+ * serviceNames: [ // EvaluationStringList // required
49
+ * "STRING_VALUE",
50
+ * ],
51
+ * logGroupNames: [ // required
52
+ * "STRING_VALUE",
53
+ * ],
54
+ * filterConfig: { // CloudWatchFilterConfig
55
+ * sessionIds: [
56
+ * "STRING_VALUE",
57
+ * ],
58
+ * timeRange: { // SessionFilterConfig
59
+ * startTime: new Date("TIMESTAMP"),
60
+ * endTime: new Date("TIMESTAMP"),
61
+ * },
62
+ * },
63
+ * },
64
+ * },
65
+ * clientToken: "STRING_VALUE",
66
+ * evaluationMetadata: { // EvaluationMetadata Union: only one key present
67
+ * sessionMetadata: [ // SessionMetadataList
68
+ * { // SessionMetadataShape
69
+ * sessionId: "STRING_VALUE", // required
70
+ * testScenarioId: "STRING_VALUE",
71
+ * groundTruth: { // GroundTruthSource Union: only one key present
72
+ * inline: { // InlineGroundTruth
73
+ * assertions: [ // EvaluationContentList
74
+ * { // EvaluationContent Union: only one key present
75
+ * text: "STRING_VALUE",
76
+ * },
77
+ * ],
78
+ * expectedTrajectory: { // EvaluationExpectedTrajectory
79
+ * toolNames: [ // EvaluationToolNames
80
+ * "STRING_VALUE",
81
+ * ],
82
+ * },
83
+ * turns: [ // GroundTruthTurnList
84
+ * { // GroundTruthTurn
85
+ * input: { // GroundTruthTurnInput Union: only one key present
86
+ * prompt: "STRING_VALUE",
87
+ * },
88
+ * expectedResponse: {// Union: only one key present
89
+ * text: "STRING_VALUE",
90
+ * },
91
+ * },
92
+ * ],
93
+ * },
94
+ * },
95
+ * metadata: { // StringMap
96
+ * "<keys>": "STRING_VALUE",
97
+ * },
98
+ * },
99
+ * ],
100
+ * },
101
+ * description: "STRING_VALUE",
102
+ * };
103
+ * const command = new StartBatchEvaluationCommand(input);
104
+ * const response = await client.send(command);
105
+ * // { // StartBatchEvaluationResponse
106
+ * // batchEvaluationId: "STRING_VALUE", // required
107
+ * // batchEvaluationArn: "STRING_VALUE", // required
108
+ * // batchEvaluationName: "STRING_VALUE", // required
109
+ * // evaluators: [ // EvaluatorList
110
+ * // { // Evaluator
111
+ * // evaluatorId: "STRING_VALUE", // required
112
+ * // },
113
+ * // ],
114
+ * // status: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "COMPLETED_WITH_ERRORS" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING", // required
115
+ * // createdAt: new Date("TIMESTAMP"), // required
116
+ * // outputConfig: { // OutputConfig Union: only one key present
117
+ * // cloudWatchConfig: { // CloudWatchOutputConfig
118
+ * // logGroupName: "STRING_VALUE", // required
119
+ * // logStreamName: "STRING_VALUE", // required
120
+ * // },
121
+ * // },
122
+ * // description: "STRING_VALUE",
123
+ * // };
124
+ *
125
+ * ```
126
+ *
127
+ * @param StartBatchEvaluationCommandInput - {@link StartBatchEvaluationCommandInput}
128
+ * @returns {@link StartBatchEvaluationCommandOutput}
129
+ * @see {@link StartBatchEvaluationCommandInput} for command's `input` shape.
130
+ * @see {@link StartBatchEvaluationCommandOutput} for command's `response` shape.
131
+ * @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
132
+ *
133
+ * @throws {@link AccessDeniedException} (client fault)
134
+ * <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
135
+ *
136
+ * @throws {@link ConflictException} (client fault)
137
+ * <p>The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.</p>
138
+ *
139
+ * @throws {@link InternalServerException} (server fault)
140
+ * <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
141
+ *
142
+ * @throws {@link ServiceQuotaExceededException} (client fault)
143
+ * <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
144
+ *
145
+ * @throws {@link ThrottlingException} (client fault)
146
+ * <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
147
+ *
148
+ * @throws {@link UnauthorizedException} (client fault)
149
+ * <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
150
+ *
151
+ * @throws {@link ValidationException} (client fault)
152
+ * <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
153
+ *
154
+ * @throws {@link BedrockAgentCoreServiceException}
155
+ * <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
156
+ *
157
+ *
158
+ * @public
159
+ */
160
+ export declare class StartBatchEvaluationCommand extends StartBatchEvaluationCommand_base {
161
+ /** @internal type navigation helper, not in runtime. */
162
+ protected static __types: {
163
+ api: {
164
+ input: StartBatchEvaluationRequest;
165
+ output: StartBatchEvaluationResponse;
166
+ };
167
+ sdk: {
168
+ input: StartBatchEvaluationCommandInput;
169
+ output: StartBatchEvaluationCommandOutput;
170
+ };
171
+ };
172
+ }
@@ -0,0 +1,300 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
4
+ import type { StartRecommendationRequest, StartRecommendationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartRecommendationCommand}.
14
+ */
15
+ export interface StartRecommendationCommandInput extends StartRecommendationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartRecommendationCommand}.
21
+ */
22
+ export interface StartRecommendationCommandOutput extends StartRecommendationResponse, __MetadataBearer {
23
+ }
24
+ declare const StartRecommendationCommand_base: {
25
+ new (input: StartRecommendationCommandInput): import("@smithy/smithy-client").CommandImpl<StartRecommendationCommandInput, StartRecommendationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StartRecommendationCommandInput): import("@smithy/smithy-client").CommandImpl<StartRecommendationCommandInput, StartRecommendationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BedrockAgentCoreClient, StartRecommendationCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
35
+ * // const { BedrockAgentCoreClient, StartRecommendationCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
36
+ * // import type { BedrockAgentCoreClientConfig } from "@aws-sdk/client-bedrock-agentcore";
37
+ * const config = {}; // type is BedrockAgentCoreClientConfig
38
+ * const client = new BedrockAgentCoreClient(config);
39
+ * const input = { // StartRecommendationRequest
40
+ * name: "STRING_VALUE", // required
41
+ * description: "STRING_VALUE",
42
+ * type: "SYSTEM_PROMPT_RECOMMENDATION" || "TOOL_DESCRIPTION_RECOMMENDATION", // required
43
+ * recommendationConfig: { // RecommendationConfig Union: only one key present
44
+ * systemPromptRecommendationConfig: { // SystemPromptRecommendationConfig
45
+ * systemPrompt: { // SystemPromptConfig Union: only one key present
46
+ * text: "STRING_VALUE",
47
+ * configurationBundle: { // SystemPromptConfigurationBundle
48
+ * bundleArn: "STRING_VALUE", // required
49
+ * versionId: "STRING_VALUE", // required
50
+ * systemPromptJsonPath: "STRING_VALUE", // required
51
+ * },
52
+ * },
53
+ * agentTraces: { // AgentTracesConfig Union: only one key present
54
+ * sessionSpans: [ // Spans
55
+ * "DOCUMENT_VALUE",
56
+ * ],
57
+ * cloudwatchLogs: { // CloudWatchLogsTraceConfig
58
+ * logGroupArns: [ // LogGroupArnList // required
59
+ * "STRING_VALUE",
60
+ * ],
61
+ * serviceNames: [ // ServiceNameList // required
62
+ * "STRING_VALUE",
63
+ * ],
64
+ * startTime: new Date("TIMESTAMP"), // required
65
+ * endTime: new Date("TIMESTAMP"), // required
66
+ * rule: { // CloudWatchLogsRule
67
+ * filters: [ // CloudWatchLogsFilterList
68
+ * { // CloudWatchLogsFilter
69
+ * key: "STRING_VALUE", // required
70
+ * operator: "Equals" || "NotEquals" || "GreaterThan" || "LessThan" || "GreaterThanOrEqual" || "LessThanOrEqual" || "Contains" || "NotContains", // required
71
+ * value: { // FilterValue Union: only one key present
72
+ * stringValue: "STRING_VALUE",
73
+ * doubleValue: Number("double"),
74
+ * booleanValue: true || false,
75
+ * },
76
+ * },
77
+ * ],
78
+ * },
79
+ * },
80
+ * },
81
+ * evaluationConfig: { // RecommendationEvaluationConfig
82
+ * evaluators: [ // RecommendationEvaluatorList // required
83
+ * { // RecommendationEvaluatorReference
84
+ * evaluatorArn: "STRING_VALUE", // required
85
+ * },
86
+ * ],
87
+ * },
88
+ * },
89
+ * toolDescriptionRecommendationConfig: { // ToolDescriptionRecommendationConfig
90
+ * toolDescription: { // ToolDescriptionSource Union: only one key present
91
+ * toolDescriptionText: { // ToolDescriptionTextInput
92
+ * tools: [ // ToolDescriptionList // required
93
+ * { // ToolDescriptionInput
94
+ * toolName: "STRING_VALUE", // required
95
+ * toolDescription: { // ToolDescriptionConfig Union: only one key present
96
+ * text: "STRING_VALUE",
97
+ * },
98
+ * },
99
+ * ],
100
+ * },
101
+ * configurationBundle: { // ToolDescriptionConfigurationBundle
102
+ * bundleArn: "STRING_VALUE", // required
103
+ * versionId: "STRING_VALUE", // required
104
+ * tools: [ // ConfigurationBundleToolEntryList // required
105
+ * { // ConfigurationBundleToolEntry
106
+ * toolName: "STRING_VALUE", // required
107
+ * toolDescriptionJsonPath: "STRING_VALUE", // required
108
+ * },
109
+ * ],
110
+ * },
111
+ * },
112
+ * agentTraces: {// Union: only one key present
113
+ * sessionSpans: [
114
+ * "DOCUMENT_VALUE",
115
+ * ],
116
+ * cloudwatchLogs: {
117
+ * logGroupArns: [ // required
118
+ * "STRING_VALUE",
119
+ * ],
120
+ * serviceNames: [ // required
121
+ * "STRING_VALUE",
122
+ * ],
123
+ * startTime: new Date("TIMESTAMP"), // required
124
+ * endTime: new Date("TIMESTAMP"), // required
125
+ * rule: {
126
+ * filters: [
127
+ * {
128
+ * key: "STRING_VALUE", // required
129
+ * operator: "Equals" || "NotEquals" || "GreaterThan" || "LessThan" || "GreaterThanOrEqual" || "LessThanOrEqual" || "Contains" || "NotContains", // required
130
+ * value: {// Union: only one key present
131
+ * stringValue: "STRING_VALUE",
132
+ * doubleValue: Number("double"),
133
+ * booleanValue: true || false,
134
+ * },
135
+ * },
136
+ * ],
137
+ * },
138
+ * },
139
+ * },
140
+ * },
141
+ * },
142
+ * clientToken: "STRING_VALUE",
143
+ * };
144
+ * const command = new StartRecommendationCommand(input);
145
+ * const response = await client.send(command);
146
+ * // { // StartRecommendationResponse
147
+ * // recommendationId: "STRING_VALUE", // required
148
+ * // recommendationArn: "STRING_VALUE", // required
149
+ * // name: "STRING_VALUE", // required
150
+ * // description: "STRING_VALUE",
151
+ * // type: "SYSTEM_PROMPT_RECOMMENDATION" || "TOOL_DESCRIPTION_RECOMMENDATION", // required
152
+ * // recommendationConfig: { // RecommendationConfig Union: only one key present
153
+ * // systemPromptRecommendationConfig: { // SystemPromptRecommendationConfig
154
+ * // systemPrompt: { // SystemPromptConfig Union: only one key present
155
+ * // text: "STRING_VALUE",
156
+ * // configurationBundle: { // SystemPromptConfigurationBundle
157
+ * // bundleArn: "STRING_VALUE", // required
158
+ * // versionId: "STRING_VALUE", // required
159
+ * // systemPromptJsonPath: "STRING_VALUE", // required
160
+ * // },
161
+ * // },
162
+ * // agentTraces: { // AgentTracesConfig Union: only one key present
163
+ * // sessionSpans: [ // Spans
164
+ * // "DOCUMENT_VALUE",
165
+ * // ],
166
+ * // cloudwatchLogs: { // CloudWatchLogsTraceConfig
167
+ * // logGroupArns: [ // LogGroupArnList // required
168
+ * // "STRING_VALUE",
169
+ * // ],
170
+ * // serviceNames: [ // ServiceNameList // required
171
+ * // "STRING_VALUE",
172
+ * // ],
173
+ * // startTime: new Date("TIMESTAMP"), // required
174
+ * // endTime: new Date("TIMESTAMP"), // required
175
+ * // rule: { // CloudWatchLogsRule
176
+ * // filters: [ // CloudWatchLogsFilterList
177
+ * // { // CloudWatchLogsFilter
178
+ * // key: "STRING_VALUE", // required
179
+ * // operator: "Equals" || "NotEquals" || "GreaterThan" || "LessThan" || "GreaterThanOrEqual" || "LessThanOrEqual" || "Contains" || "NotContains", // required
180
+ * // value: { // FilterValue Union: only one key present
181
+ * // stringValue: "STRING_VALUE",
182
+ * // doubleValue: Number("double"),
183
+ * // booleanValue: true || false,
184
+ * // },
185
+ * // },
186
+ * // ],
187
+ * // },
188
+ * // },
189
+ * // },
190
+ * // evaluationConfig: { // RecommendationEvaluationConfig
191
+ * // evaluators: [ // RecommendationEvaluatorList // required
192
+ * // { // RecommendationEvaluatorReference
193
+ * // evaluatorArn: "STRING_VALUE", // required
194
+ * // },
195
+ * // ],
196
+ * // },
197
+ * // },
198
+ * // toolDescriptionRecommendationConfig: { // ToolDescriptionRecommendationConfig
199
+ * // toolDescription: { // ToolDescriptionSource Union: only one key present
200
+ * // toolDescriptionText: { // ToolDescriptionTextInput
201
+ * // tools: [ // ToolDescriptionList // required
202
+ * // { // ToolDescriptionInput
203
+ * // toolName: "STRING_VALUE", // required
204
+ * // toolDescription: { // ToolDescriptionConfig Union: only one key present
205
+ * // text: "STRING_VALUE",
206
+ * // },
207
+ * // },
208
+ * // ],
209
+ * // },
210
+ * // configurationBundle: { // ToolDescriptionConfigurationBundle
211
+ * // bundleArn: "STRING_VALUE", // required
212
+ * // versionId: "STRING_VALUE", // required
213
+ * // tools: [ // ConfigurationBundleToolEntryList // required
214
+ * // { // ConfigurationBundleToolEntry
215
+ * // toolName: "STRING_VALUE", // required
216
+ * // toolDescriptionJsonPath: "STRING_VALUE", // required
217
+ * // },
218
+ * // ],
219
+ * // },
220
+ * // },
221
+ * // agentTraces: {// Union: only one key present
222
+ * // sessionSpans: [
223
+ * // "DOCUMENT_VALUE",
224
+ * // ],
225
+ * // cloudwatchLogs: {
226
+ * // logGroupArns: [ // required
227
+ * // "STRING_VALUE",
228
+ * // ],
229
+ * // serviceNames: [ // required
230
+ * // "STRING_VALUE",
231
+ * // ],
232
+ * // startTime: new Date("TIMESTAMP"), // required
233
+ * // endTime: new Date("TIMESTAMP"), // required
234
+ * // rule: {
235
+ * // filters: [
236
+ * // {
237
+ * // key: "STRING_VALUE", // required
238
+ * // operator: "Equals" || "NotEquals" || "GreaterThan" || "LessThan" || "GreaterThanOrEqual" || "LessThanOrEqual" || "Contains" || "NotContains", // required
239
+ * // value: {// Union: only one key present
240
+ * // stringValue: "STRING_VALUE",
241
+ * // doubleValue: Number("double"),
242
+ * // booleanValue: true || false,
243
+ * // },
244
+ * // },
245
+ * // ],
246
+ * // },
247
+ * // },
248
+ * // },
249
+ * // },
250
+ * // },
251
+ * // status: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "DELETING", // required
252
+ * // createdAt: new Date("TIMESTAMP"), // required
253
+ * // updatedAt: new Date("TIMESTAMP"), // required
254
+ * // };
255
+ *
256
+ * ```
257
+ *
258
+ * @param StartRecommendationCommandInput - {@link StartRecommendationCommandInput}
259
+ * @returns {@link StartRecommendationCommandOutput}
260
+ * @see {@link StartRecommendationCommandInput} for command's `input` shape.
261
+ * @see {@link StartRecommendationCommandOutput} for command's `response` shape.
262
+ * @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
263
+ *
264
+ * @throws {@link AccessDeniedException} (client fault)
265
+ * <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
266
+ *
267
+ * @throws {@link ConflictException} (client fault)
268
+ * <p>The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.</p>
269
+ *
270
+ * @throws {@link InternalServerException} (server fault)
271
+ * <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
272
+ *
273
+ * @throws {@link ServiceQuotaExceededException} (client fault)
274
+ * <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
275
+ *
276
+ * @throws {@link ThrottlingException} (client fault)
277
+ * <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
278
+ *
279
+ * @throws {@link ValidationException} (client fault)
280
+ * <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
281
+ *
282
+ * @throws {@link BedrockAgentCoreServiceException}
283
+ * <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
284
+ *
285
+ *
286
+ * @public
287
+ */
288
+ export declare class StartRecommendationCommand extends StartRecommendationCommand_base {
289
+ /** @internal type navigation helper, not in runtime. */
290
+ protected static __types: {
291
+ api: {
292
+ input: StartRecommendationRequest;
293
+ output: StartRecommendationResponse;
294
+ };
295
+ sdk: {
296
+ input: StartRecommendationCommandInput;
297
+ output: StartRecommendationCommandOutput;
298
+ };
299
+ };
300
+ }
@@ -0,0 +1,98 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
4
+ import type { StopBatchEvaluationRequest, StopBatchEvaluationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopBatchEvaluationCommand}.
14
+ */
15
+ export interface StopBatchEvaluationCommandInput extends StopBatchEvaluationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopBatchEvaluationCommand}.
21
+ */
22
+ export interface StopBatchEvaluationCommandOutput extends StopBatchEvaluationResponse, __MetadataBearer {
23
+ }
24
+ declare const StopBatchEvaluationCommand_base: {
25
+ new (input: StopBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<StopBatchEvaluationCommandInput, StopBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StopBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<StopBatchEvaluationCommandInput, StopBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Stops a running batch evaluation. Sessions that have already been evaluated retain their results.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BedrockAgentCoreClient, StopBatchEvaluationCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
35
+ * // const { BedrockAgentCoreClient, StopBatchEvaluationCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
36
+ * // import type { BedrockAgentCoreClientConfig } from "@aws-sdk/client-bedrock-agentcore";
37
+ * const config = {}; // type is BedrockAgentCoreClientConfig
38
+ * const client = new BedrockAgentCoreClient(config);
39
+ * const input = { // StopBatchEvaluationRequest
40
+ * batchEvaluationId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new StopBatchEvaluationCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // StopBatchEvaluationResponse
45
+ * // batchEvaluationId: "STRING_VALUE", // required
46
+ * // batchEvaluationArn: "STRING_VALUE", // required
47
+ * // status: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "COMPLETED_WITH_ERRORS" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING", // required
48
+ * // description: "STRING_VALUE",
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param StopBatchEvaluationCommandInput - {@link StopBatchEvaluationCommandInput}
54
+ * @returns {@link StopBatchEvaluationCommandOutput}
55
+ * @see {@link StopBatchEvaluationCommandInput} for command's `input` shape.
56
+ * @see {@link StopBatchEvaluationCommandOutput} for command's `response` shape.
57
+ * @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
61
+ *
62
+ * @throws {@link ConflictException} (client fault)
63
+ * <p>The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.</p>
64
+ *
65
+ * @throws {@link InternalServerException} (server fault)
66
+ * <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
67
+ *
68
+ * @throws {@link ResourceNotFoundException} (client fault)
69
+ * <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
70
+ *
71
+ * @throws {@link ThrottlingException} (client fault)
72
+ * <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
73
+ *
74
+ * @throws {@link UnauthorizedException} (client fault)
75
+ * <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
79
+ *
80
+ * @throws {@link BedrockAgentCoreServiceException}
81
+ * <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
82
+ *
83
+ *
84
+ * @public
85
+ */
86
+ export declare class StopBatchEvaluationCommand extends StopBatchEvaluationCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: StopBatchEvaluationRequest;
91
+ output: StopBatchEvaluationResponse;
92
+ };
93
+ sdk: {
94
+ input: StopBatchEvaluationCommandInput;
95
+ output: StopBatchEvaluationCommandOutput;
96
+ };
97
+ };
98
+ }