@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.
- package/README.md +105 -7
- package/dist-cjs/index.js +275 -0
- package/dist-cjs/schemas/schemas_0.js +851 -99
- package/dist-es/BedrockAgentCore.js +34 -0
- package/dist-es/commands/CreateABTestCommand.js +16 -0
- package/dist-es/commands/DeleteABTestCommand.js +16 -0
- package/dist-es/commands/DeleteBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/DeleteRecommendationCommand.js +16 -0
- package/dist-es/commands/GetABTestCommand.js +16 -0
- package/dist-es/commands/GetBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/GetRecommendationCommand.js +16 -0
- package/dist-es/commands/ListABTestsCommand.js +16 -0
- package/dist-es/commands/ListBatchEvaluationsCommand.js +16 -0
- package/dist-es/commands/ListRecommendationsCommand.js +16 -0
- package/dist-es/commands/StartBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/StartRecommendationCommand.js +16 -0
- package/dist-es/commands/StopBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/UpdateABTestCommand.js +16 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +60 -0
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/pagination/ListABTestsPaginator.js +4 -0
- package/dist-es/pagination/ListBatchEvaluationsPaginator.js +4 -0
- package/dist-es/pagination/ListRecommendationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +843 -93
- package/dist-types/BedrockAgentCore.d.ts +122 -0
- package/dist-types/BedrockAgentCoreClient.d.ts +16 -2
- package/dist-types/commands/BatchCreateMemoryRecordsCommand.d.ts +10 -0
- package/dist-types/commands/BatchUpdateMemoryRecordsCommand.d.ts +10 -0
- package/dist-types/commands/CreateABTestCommand.d.ts +134 -0
- package/dist-types/commands/DeleteABTestCommand.d.ts +97 -0
- package/dist-types/commands/DeleteBatchEvaluationCommand.d.ts +97 -0
- package/dist-types/commands/DeleteRecommendationCommand.d.ts +93 -0
- package/dist-types/commands/GetABTestCommand.d.ts +165 -0
- package/dist-types/commands/GetBatchEvaluationCommand.d.ts +148 -0
- package/dist-types/commands/GetMemoryRecordCommand.d.ts +7 -2
- package/dist-types/commands/GetRecommendationCommand.d.ts +220 -0
- package/dist-types/commands/GetResourceOauth2TokenCommand.d.ts +7 -1
- package/dist-types/commands/ListABTestsCommand.d.ts +103 -0
- package/dist-types/commands/ListBatchEvaluationsCommand.d.ts +126 -0
- package/dist-types/commands/ListMemoryRecordsCommand.d.ts +25 -2
- package/dist-types/commands/ListRecommendationsCommand.d.ts +100 -0
- package/dist-types/commands/RetrieveMemoryRecordsCommand.d.ts +16 -6
- package/dist-types/commands/SearchRegistryRecordsCommand.d.ts +2 -1
- package/dist-types/commands/StartBatchEvaluationCommand.d.ts +172 -0
- package/dist-types/commands/StartRecommendationCommand.d.ts +300 -0
- package/dist-types/commands/StopBatchEvaluationCommand.d.ts +98 -0
- package/dist-types/commands/UpdateABTestCommand.d.ts +136 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +116 -0
- package/dist-types/models/models_0.d.ts +2595 -386
- package/dist-types/models/models_1.d.ts +147 -0
- package/dist-types/pagination/ListABTestsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBatchEvaluationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRecommendationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +99 -0
- package/dist-types/ts3.4/BedrockAgentCore.d.ts +262 -0
- package/dist-types/ts3.4/BedrockAgentCoreClient.d.ts +84 -0
- package/dist-types/ts3.4/commands/CreateABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommendationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommendationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListABTestsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListBatchEvaluationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommendationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchRegistryRecordsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartRecommendationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +73 -0
- package/dist-types/ts3.4/models/models_0.d.ts +801 -43
- package/dist-types/ts3.4/models/models_1.d.ts +40 -0
- package/dist-types/ts3.4/pagination/ListABTestsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBatchEvaluationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecommendationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +99 -0
- package/package.json +7 -7
|
@@ -0,0 +1,97 @@
|
|
|
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 { DeleteBatchEvaluationRequest, DeleteBatchEvaluationResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteBatchEvaluationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteBatchEvaluationCommandInput extends DeleteBatchEvaluationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteBatchEvaluationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteBatchEvaluationCommandOutput extends DeleteBatchEvaluationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteBatchEvaluationCommand_base: {
|
|
25
|
+
new (input: DeleteBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBatchEvaluationCommandInput, DeleteBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBatchEvaluationCommandInput, DeleteBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a batch evaluation and its associated 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, DeleteBatchEvaluationCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, DeleteBatchEvaluationCommand } = 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 = { // DeleteBatchEvaluationRequest
|
|
40
|
+
* batchEvaluationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteBatchEvaluationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DeleteBatchEvaluationResponse
|
|
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
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param DeleteBatchEvaluationCommandInput - {@link DeleteBatchEvaluationCommandInput}
|
|
53
|
+
* @returns {@link DeleteBatchEvaluationCommandOutput}
|
|
54
|
+
* @see {@link DeleteBatchEvaluationCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link DeleteBatchEvaluationCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <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>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ConflictException} (client fault)
|
|
62
|
+
* <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>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalServerException} (server fault)
|
|
65
|
+
* <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>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
+
* <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>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
+
* <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>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
74
|
+
* <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export declare class DeleteBatchEvaluationCommand extends DeleteBatchEvaluationCommand_base {
|
|
86
|
+
/** @internal type navigation helper, not in runtime. */
|
|
87
|
+
protected static __types: {
|
|
88
|
+
api: {
|
|
89
|
+
input: DeleteBatchEvaluationRequest;
|
|
90
|
+
output: DeleteBatchEvaluationResponse;
|
|
91
|
+
};
|
|
92
|
+
sdk: {
|
|
93
|
+
input: DeleteBatchEvaluationCommandInput;
|
|
94
|
+
output: DeleteBatchEvaluationCommandOutput;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
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 { DeleteRecommendationRequest, DeleteRecommendationResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteRecommendationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteRecommendationCommandInput extends DeleteRecommendationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteRecommendationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteRecommendationCommandOutput extends DeleteRecommendationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteRecommendationCommand_base: {
|
|
25
|
+
new (input: DeleteRecommendationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRecommendationCommandInput, DeleteRecommendationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteRecommendationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRecommendationCommandInput, DeleteRecommendationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a recommendation and its associated 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, DeleteRecommendationCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, DeleteRecommendationCommand } = 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 = { // DeleteRecommendationRequest
|
|
40
|
+
* recommendationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteRecommendationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DeleteRecommendationResponse
|
|
45
|
+
* // recommendationId: "STRING_VALUE", // required
|
|
46
|
+
* // status: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "DELETING", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param DeleteRecommendationCommandInput - {@link DeleteRecommendationCommandInput}
|
|
52
|
+
* @returns {@link DeleteRecommendationCommandOutput}
|
|
53
|
+
* @see {@link DeleteRecommendationCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link DeleteRecommendationCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <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>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ConflictException} (client fault)
|
|
61
|
+
* <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>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerException} (server fault)
|
|
64
|
+
* <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>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <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>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class DeleteRecommendationCommand extends DeleteRecommendationCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: DeleteRecommendationRequest;
|
|
86
|
+
output: DeleteRecommendationResponse;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: DeleteRecommendationCommandInput;
|
|
90
|
+
output: DeleteRecommendationCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -0,0 +1,165 @@
|
|
|
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 { GetABTestRequest, GetABTestResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetABTestCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetABTestCommandInput extends GetABTestRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetABTestCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetABTestCommandOutput extends GetABTestResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetABTestCommand_base: {
|
|
25
|
+
new (input: GetABTestCommandInput): import("@smithy/smithy-client").CommandImpl<GetABTestCommandInput, GetABTestCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetABTestCommandInput): import("@smithy/smithy-client").CommandImpl<GetABTestCommandInput, GetABTestCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves detailed information about an A/B test, including its configuration, status, and statistical 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, GetABTestCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, GetABTestCommand } = 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 = { // GetABTestRequest
|
|
40
|
+
* abTestId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetABTestCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetABTestResponse
|
|
45
|
+
* // abTestId: "STRING_VALUE", // required
|
|
46
|
+
* // abTestArn: "STRING_VALUE", // required
|
|
47
|
+
* // name: "STRING_VALUE", // required
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // status: "CREATING" || "ACTIVE" || "CREATE_FAILED" || "UPDATING" || "UPDATE_FAILED" || "DELETING" || "DELETE_FAILED" || "FAILED", // required
|
|
50
|
+
* // executionStatus: "PAUSED" || "RUNNING" || "STOPPED" || "NOT_STARTED", // required
|
|
51
|
+
* // gatewayArn: "STRING_VALUE", // required
|
|
52
|
+
* // variants: [ // VariantList // required
|
|
53
|
+
* // { // Variant
|
|
54
|
+
* // name: "STRING_VALUE", // required
|
|
55
|
+
* // weight: Number("int"), // required
|
|
56
|
+
* // variantConfiguration: { // VariantConfiguration
|
|
57
|
+
* // configurationBundle: { // ConfigurationBundleRef
|
|
58
|
+
* // bundleArn: "STRING_VALUE", // required
|
|
59
|
+
* // bundleVersion: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // target: { // TargetRef
|
|
62
|
+
* // name: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // gatewayFilter: { // GatewayFilter
|
|
68
|
+
* // targetPaths: [ // TargetPathList
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // },
|
|
72
|
+
* // evaluationConfig: { // ABTestEvaluationConfig Union: only one key present
|
|
73
|
+
* // onlineEvaluationConfigArn: "STRING_VALUE",
|
|
74
|
+
* // perVariantOnlineEvaluationConfig: [ // PerVariantOnlineEvaluationConfigList
|
|
75
|
+
* // { // PerVariantOnlineEvaluationConfig
|
|
76
|
+
* // name: "STRING_VALUE", // required
|
|
77
|
+
* // onlineEvaluationConfigArn: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // },
|
|
81
|
+
* // roleArn: "STRING_VALUE",
|
|
82
|
+
* // currentRunId: "STRING_VALUE",
|
|
83
|
+
* // errorDetails: [ // ErrorDetailsList
|
|
84
|
+
* // "STRING_VALUE",
|
|
85
|
+
* // ],
|
|
86
|
+
* // startedAt: new Date("TIMESTAMP"),
|
|
87
|
+
* // stoppedAt: new Date("TIMESTAMP"),
|
|
88
|
+
* // maxDurationExpiresAt: new Date("TIMESTAMP"),
|
|
89
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
90
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
91
|
+
* // results: { // ABTestResults
|
|
92
|
+
* // analysisTimestamp: new Date("TIMESTAMP"),
|
|
93
|
+
* // evaluatorMetrics: [ // EvaluatorMetricList // required
|
|
94
|
+
* // { // EvaluatorMetric
|
|
95
|
+
* // evaluatorArn: "STRING_VALUE", // required
|
|
96
|
+
* // controlStats: { // ControlStats
|
|
97
|
+
* // variantName: "STRING_VALUE", // required
|
|
98
|
+
* // sampleSize: Number("int"), // required
|
|
99
|
+
* // mean: Number("double"), // required
|
|
100
|
+
* // },
|
|
101
|
+
* // variantResults: [ // VariantResultList // required
|
|
102
|
+
* // { // VariantResult
|
|
103
|
+
* // variantName: "STRING_VALUE", // required
|
|
104
|
+
* // sampleSize: Number("int"), // required
|
|
105
|
+
* // mean: Number("double"), // required
|
|
106
|
+
* // absoluteChange: Number("double"),
|
|
107
|
+
* // percentChange: Number("double"),
|
|
108
|
+
* // pValue: Number("double"),
|
|
109
|
+
* // confidenceInterval: { // ConfidenceInterval
|
|
110
|
+
* // lower: Number("double"),
|
|
111
|
+
* // upper: Number("double"),
|
|
112
|
+
* // },
|
|
113
|
+
* // isSignificant: true || false, // required
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // },
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param GetABTestCommandInput - {@link GetABTestCommandInput}
|
|
124
|
+
* @returns {@link GetABTestCommandOutput}
|
|
125
|
+
* @see {@link GetABTestCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link GetABTestCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
130
|
+
* <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>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link InternalServerException} (server fault)
|
|
133
|
+
* <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>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
136
|
+
* <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>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
139
|
+
* <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>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
142
|
+
* <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ValidationException} (client fault)
|
|
145
|
+
* <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>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
148
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
149
|
+
*
|
|
150
|
+
*
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export declare class GetABTestCommand extends GetABTestCommand_base {
|
|
154
|
+
/** @internal type navigation helper, not in runtime. */
|
|
155
|
+
protected static __types: {
|
|
156
|
+
api: {
|
|
157
|
+
input: GetABTestRequest;
|
|
158
|
+
output: GetABTestResponse;
|
|
159
|
+
};
|
|
160
|
+
sdk: {
|
|
161
|
+
input: GetABTestCommandInput;
|
|
162
|
+
output: GetABTestCommandOutput;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
}
|
|
@@ -0,0 +1,148 @@
|
|
|
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 { GetBatchEvaluationRequest, GetBatchEvaluationResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetBatchEvaluationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetBatchEvaluationCommandInput extends GetBatchEvaluationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetBatchEvaluationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetBatchEvaluationCommandOutput extends GetBatchEvaluationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetBatchEvaluationCommand_base: {
|
|
25
|
+
new (input: GetBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBatchEvaluationCommandInput, GetBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetBatchEvaluationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBatchEvaluationCommandInput, GetBatchEvaluationCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, GetBatchEvaluationCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, GetBatchEvaluationCommand } = 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 = { // GetBatchEvaluationRequest
|
|
40
|
+
* batchEvaluationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetBatchEvaluationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetBatchEvaluationResponse
|
|
45
|
+
* // batchEvaluationId: "STRING_VALUE", // required
|
|
46
|
+
* // batchEvaluationArn: "STRING_VALUE", // required
|
|
47
|
+
* // batchEvaluationName: "STRING_VALUE", // required
|
|
48
|
+
* // status: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "COMPLETED_WITH_ERRORS" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING", // required
|
|
49
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // evaluators: [ // EvaluatorList
|
|
51
|
+
* // { // Evaluator
|
|
52
|
+
* // evaluatorId: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // dataSourceConfig: { // DataSourceConfig Union: only one key present
|
|
56
|
+
* // cloudWatchLogs: { // CloudWatchLogsSource
|
|
57
|
+
* // serviceNames: [ // EvaluationStringList // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // logGroupNames: [ // required
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // filterConfig: { // CloudWatchFilterConfig
|
|
64
|
+
* // sessionIds: [
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // timeRange: { // SessionFilterConfig
|
|
68
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
69
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
70
|
+
* // },
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // outputConfig: { // OutputConfig Union: only one key present
|
|
75
|
+
* // cloudWatchConfig: { // CloudWatchOutputConfig
|
|
76
|
+
* // logGroupName: "STRING_VALUE", // required
|
|
77
|
+
* // logStreamName: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // evaluationResults: { // EvaluationJobResults
|
|
81
|
+
* // numberOfSessionsCompleted: Number("int"),
|
|
82
|
+
* // numberOfSessionsInProgress: Number("int"),
|
|
83
|
+
* // numberOfSessionsFailed: Number("int"),
|
|
84
|
+
* // totalNumberOfSessions: Number("int"),
|
|
85
|
+
* // numberOfSessionsIgnored: Number("int"),
|
|
86
|
+
* // evaluatorSummaries: [ // EvaluatorSummaryList
|
|
87
|
+
* // { // EvaluatorSummary
|
|
88
|
+
* // evaluatorId: "STRING_VALUE",
|
|
89
|
+
* // statistics: { // EvaluatorStatistics
|
|
90
|
+
* // averageScore: Number("double"),
|
|
91
|
+
* // },
|
|
92
|
+
* // totalEvaluated: Number("int"),
|
|
93
|
+
* // totalFailed: Number("int"),
|
|
94
|
+
* // },
|
|
95
|
+
* // ],
|
|
96
|
+
* // },
|
|
97
|
+
* // errorDetails: [ // ErrorDetailsList
|
|
98
|
+
* // "STRING_VALUE",
|
|
99
|
+
* // ],
|
|
100
|
+
* // description: "STRING_VALUE",
|
|
101
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
102
|
+
* // };
|
|
103
|
+
*
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @param GetBatchEvaluationCommandInput - {@link GetBatchEvaluationCommandInput}
|
|
107
|
+
* @returns {@link GetBatchEvaluationCommandOutput}
|
|
108
|
+
* @see {@link GetBatchEvaluationCommandInput} for command's `input` shape.
|
|
109
|
+
* @see {@link GetBatchEvaluationCommandOutput} for command's `response` shape.
|
|
110
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
113
|
+
* <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>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link InternalServerException} (server fault)
|
|
116
|
+
* <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>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
119
|
+
* <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>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
122
|
+
* <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>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
125
|
+
* <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ValidationException} (client fault)
|
|
128
|
+
* <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>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
131
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
132
|
+
*
|
|
133
|
+
*
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
export declare class GetBatchEvaluationCommand extends GetBatchEvaluationCommand_base {
|
|
137
|
+
/** @internal type navigation helper, not in runtime. */
|
|
138
|
+
protected static __types: {
|
|
139
|
+
api: {
|
|
140
|
+
input: GetBatchEvaluationRequest;
|
|
141
|
+
output: GetBatchEvaluationResponse;
|
|
142
|
+
};
|
|
143
|
+
sdk: {
|
|
144
|
+
input: GetBatchEvaluationCommandInput;
|
|
145
|
+
output: GetBatchEvaluationCommandOutput;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
}
|
|
@@ -53,9 +53,14 @@ declare const GetMemoryRecordCommand_base: {
|
|
|
53
53
|
* // "STRING_VALUE",
|
|
54
54
|
* // ],
|
|
55
55
|
* // createdAt: new Date("TIMESTAMP"), // required
|
|
56
|
-
* // metadata: { //
|
|
57
|
-
* // "<keys>": { //
|
|
56
|
+
* // metadata: { // MemoryRecordMetadataMap
|
|
57
|
+
* // "<keys>": { // MemoryRecordMetadataValue Union: only one key present
|
|
58
58
|
* // stringValue: "STRING_VALUE",
|
|
59
|
+
* // stringListValue: [ // StringValueList
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // numberValue: Number("double"),
|
|
63
|
+
* // dateTimeValue: new Date("TIMESTAMP"),
|
|
59
64
|
* // },
|
|
60
65
|
* // },
|
|
61
66
|
* // },
|