@aws-sdk/client-bedrock-agent 3.658.1 → 3.664.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 +8 -0
- package/dist-cjs/index.js +45 -1
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/BedrockAgent.js +2 -0
- package/dist-es/commands/StopIngestionJobCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +25 -0
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/BedrockAgent.d.ts +7 -0
- package/dist-types/BedrockAgentClient.d.ts +3 -2
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetIngestionJobCommand.d.ts +2 -2
- package/dist-types/commands/ListIngestionJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/StartIngestionJobCommand.d.ts +2 -2
- package/dist-types/commands/StopIngestionJobCommand.d.ts +111 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +83 -49
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -1
- package/dist-types/runtimeConfig.d.ts +2 -1
- package/dist-types/runtimeConfig.native.d.ts +2 -1
- package/dist-types/ts3.4/BedrockAgent.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/StopIngestionJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +10 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +7 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +6 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +7 -3
- package/package.json +35 -35
package/README.md
CHANGED
|
@@ -602,6 +602,14 @@ StartIngestionJob
|
|
|
602
602
|
|
|
603
603
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/StartIngestionJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/StartIngestionJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/StartIngestionJobCommandOutput/)
|
|
604
604
|
|
|
605
|
+
</details>
|
|
606
|
+
<details>
|
|
607
|
+
<summary>
|
|
608
|
+
StopIngestionJob
|
|
609
|
+
</summary>
|
|
610
|
+
|
|
611
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/StopIngestionJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/StopIngestionJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/StopIngestionJobCommandOutput/)
|
|
612
|
+
|
|
605
613
|
</details>
|
|
606
614
|
<details>
|
|
607
615
|
<summary>
|
package/dist-cjs/index.js
CHANGED
|
@@ -174,6 +174,7 @@ __export(src_exports, {
|
|
|
174
174
|
SortOrder: () => SortOrder,
|
|
175
175
|
StartIngestionJobCommand: () => StartIngestionJobCommand,
|
|
176
176
|
StepType: () => StepType,
|
|
177
|
+
StopIngestionJobCommand: () => StopIngestionJobCommand,
|
|
177
178
|
StorageFlowNodeServiceConfiguration: () => StorageFlowNodeServiceConfiguration,
|
|
178
179
|
TagResourceCommand: () => TagResourceCommand,
|
|
179
180
|
TextPromptTemplateConfigurationFilterSensitiveLog: () => TextPromptTemplateConfigurationFilterSensitiveLog,
|
|
@@ -769,7 +770,9 @@ var IngestionJobStatus = {
|
|
|
769
770
|
COMPLETE: "COMPLETE",
|
|
770
771
|
FAILED: "FAILED",
|
|
771
772
|
IN_PROGRESS: "IN_PROGRESS",
|
|
772
|
-
STARTING: "STARTING"
|
|
773
|
+
STARTING: "STARTING",
|
|
774
|
+
STOPPED: "STOPPED",
|
|
775
|
+
STOPPING: "STOPPING"
|
|
773
776
|
};
|
|
774
777
|
var IngestionJobFilterAttribute = {
|
|
775
778
|
STATUS: "STATUS"
|
|
@@ -1859,6 +1862,17 @@ var se_StartIngestionJobCommand = /* @__PURE__ */ __name(async (input, context)
|
|
|
1859
1862
|
b.m("PUT").h(headers).b(body);
|
|
1860
1863
|
return b.build();
|
|
1861
1864
|
}, "se_StartIngestionJobCommand");
|
|
1865
|
+
var se_StopIngestionJobCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
1866
|
+
const b = (0, import_core.requestBuilder)(input, context);
|
|
1867
|
+
const headers = {};
|
|
1868
|
+
b.bp("/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}/stop");
|
|
1869
|
+
b.p("knowledgeBaseId", () => input.knowledgeBaseId, "{knowledgeBaseId}", false);
|
|
1870
|
+
b.p("dataSourceId", () => input.dataSourceId, "{dataSourceId}", false);
|
|
1871
|
+
b.p("ingestionJobId", () => input.ingestionJobId, "{ingestionJobId}", false);
|
|
1872
|
+
let body;
|
|
1873
|
+
b.m("POST").h(headers).b(body);
|
|
1874
|
+
return b.build();
|
|
1875
|
+
}, "se_StopIngestionJobCommand");
|
|
1862
1876
|
var se_TagResourceCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
1863
1877
|
const b = (0, import_core.requestBuilder)(input, context);
|
|
1864
1878
|
const headers = {
|
|
@@ -2874,6 +2888,20 @@ var de_StartIngestionJobCommand = /* @__PURE__ */ __name(async (output, context)
|
|
|
2874
2888
|
Object.assign(contents, doc);
|
|
2875
2889
|
return contents;
|
|
2876
2890
|
}, "de_StartIngestionJobCommand");
|
|
2891
|
+
var de_StopIngestionJobCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
2892
|
+
if (output.statusCode !== 202 && output.statusCode >= 300) {
|
|
2893
|
+
return de_CommandError(output, context);
|
|
2894
|
+
}
|
|
2895
|
+
const contents = (0, import_smithy_client.map)({
|
|
2896
|
+
$metadata: deserializeMetadata(output)
|
|
2897
|
+
});
|
|
2898
|
+
const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
|
|
2899
|
+
const doc = (0, import_smithy_client.take)(data, {
|
|
2900
|
+
ingestionJob: (_) => de_IngestionJob(_, context)
|
|
2901
|
+
});
|
|
2902
|
+
Object.assign(contents, doc);
|
|
2903
|
+
return contents;
|
|
2904
|
+
}, "de_StopIngestionJobCommand");
|
|
2877
2905
|
var de_TagResourceCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
2878
2906
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2879
2907
|
return de_CommandError(output, context);
|
|
@@ -4521,6 +4549,20 @@ var _StartIngestionJobCommand = class _StartIngestionJobCommand extends import_s
|
|
|
4521
4549
|
__name(_StartIngestionJobCommand, "StartIngestionJobCommand");
|
|
4522
4550
|
var StartIngestionJobCommand = _StartIngestionJobCommand;
|
|
4523
4551
|
|
|
4552
|
+
// src/commands/StopIngestionJobCommand.ts
|
|
4553
|
+
|
|
4554
|
+
|
|
4555
|
+
|
|
4556
|
+
var _StopIngestionJobCommand = class _StopIngestionJobCommand extends import_smithy_client.Command.classBuilder().ep(commonParams).m(function(Command, cs, config, o) {
|
|
4557
|
+
return [
|
|
4558
|
+
(0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
|
|
4559
|
+
(0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
|
|
4560
|
+
];
|
|
4561
|
+
}).s("AmazonBedrockAgentBuildTimeLambda", "StopIngestionJob", {}).n("BedrockAgentClient", "StopIngestionJobCommand").f(void 0, void 0).ser(se_StopIngestionJobCommand).de(de_StopIngestionJobCommand).build() {
|
|
4562
|
+
};
|
|
4563
|
+
__name(_StopIngestionJobCommand, "StopIngestionJobCommand");
|
|
4564
|
+
var StopIngestionJobCommand = _StopIngestionJobCommand;
|
|
4565
|
+
|
|
4524
4566
|
// src/commands/TagResourceCommand.ts
|
|
4525
4567
|
|
|
4526
4568
|
|
|
@@ -4727,6 +4769,7 @@ var commands = {
|
|
|
4727
4769
|
PrepareAgentCommand,
|
|
4728
4770
|
PrepareFlowCommand,
|
|
4729
4771
|
StartIngestionJobCommand,
|
|
4772
|
+
StopIngestionJobCommand,
|
|
4730
4773
|
TagResourceCommand,
|
|
4731
4774
|
UntagResourceCommand,
|
|
4732
4775
|
UpdateAgentCommand,
|
|
@@ -4850,6 +4893,7 @@ var paginateListPrompts = (0, import_core.createPaginator)(BedrockAgentClient, L
|
|
|
4850
4893
|
PrepareAgentCommand,
|
|
4851
4894
|
PrepareFlowCommand,
|
|
4852
4895
|
StartIngestionJobCommand,
|
|
4896
|
+
StopIngestionJobCommand,
|
|
4853
4897
|
TagResourceCommand,
|
|
4854
4898
|
UntagResourceCommand,
|
|
4855
4899
|
UpdateAgentActionGroupCommand,
|
|
@@ -44,6 +44,7 @@ const getRuntimeConfig = (config) => {
|
|
|
44
44
|
streamCollector: config?.streamCollector ?? node_http_handler_1.streamCollector,
|
|
45
45
|
useDualstackEndpoint: config?.useDualstackEndpoint ?? (0, node_config_provider_1.loadConfig)(config_resolver_1.NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
|
|
46
46
|
useFipsEndpoint: config?.useFipsEndpoint ?? (0, node_config_provider_1.loadConfig)(config_resolver_1.NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
|
|
47
|
+
userAgentAppId: config?.userAgentAppId ?? (0, node_config_provider_1.loadConfig)(util_user_agent_node_1.NODE_APP_ID_CONFIG_OPTIONS),
|
|
47
48
|
};
|
|
48
49
|
};
|
|
49
50
|
exports.getRuntimeConfig = getRuntimeConfig;
|
package/dist-es/BedrockAgent.js
CHANGED
|
@@ -50,6 +50,7 @@ import { ListTagsForResourceCommand, } from "./commands/ListTagsForResourceComma
|
|
|
50
50
|
import { PrepareAgentCommand, } from "./commands/PrepareAgentCommand";
|
|
51
51
|
import { PrepareFlowCommand } from "./commands/PrepareFlowCommand";
|
|
52
52
|
import { StartIngestionJobCommand, } from "./commands/StartIngestionJobCommand";
|
|
53
|
+
import { StopIngestionJobCommand, } from "./commands/StopIngestionJobCommand";
|
|
53
54
|
import { TagResourceCommand } from "./commands/TagResourceCommand";
|
|
54
55
|
import { UntagResourceCommand, } from "./commands/UntagResourceCommand";
|
|
55
56
|
import { UpdateAgentActionGroupCommand, } from "./commands/UpdateAgentActionGroupCommand";
|
|
@@ -112,6 +113,7 @@ const commands = {
|
|
|
112
113
|
PrepareAgentCommand,
|
|
113
114
|
PrepareFlowCommand,
|
|
114
115
|
StartIngestionJobCommand,
|
|
116
|
+
StopIngestionJobCommand,
|
|
115
117
|
TagResourceCommand,
|
|
116
118
|
UntagResourceCommand,
|
|
117
119
|
UpdateAgentCommand,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { commonParams } from "../endpoint/EndpointParameters";
|
|
5
|
+
import { de_StopIngestionJobCommand, se_StopIngestionJobCommand } from "../protocols/Aws_restJson1";
|
|
6
|
+
export { $Command };
|
|
7
|
+
export class StopIngestionJobCommand extends $Command
|
|
8
|
+
.classBuilder()
|
|
9
|
+
.ep(commonParams)
|
|
10
|
+
.m(function (Command, cs, config, o) {
|
|
11
|
+
return [
|
|
12
|
+
getSerdePlugin(config, this.serialize, this.deserialize),
|
|
13
|
+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
14
|
+
];
|
|
15
|
+
})
|
|
16
|
+
.s("AmazonBedrockAgentBuildTimeLambda", "StopIngestionJob", {})
|
|
17
|
+
.n("BedrockAgentClient", "StopIngestionJobCommand")
|
|
18
|
+
.f(void 0, void 0)
|
|
19
|
+
.ser(se_StopIngestionJobCommand)
|
|
20
|
+
.de(de_StopIngestionJobCommand)
|
|
21
|
+
.build() {
|
|
22
|
+
}
|
|
@@ -48,6 +48,7 @@ export * from "./ListTagsForResourceCommand";
|
|
|
48
48
|
export * from "./PrepareAgentCommand";
|
|
49
49
|
export * from "./PrepareFlowCommand";
|
|
50
50
|
export * from "./StartIngestionJobCommand";
|
|
51
|
+
export * from "./StopIngestionJobCommand";
|
|
51
52
|
export * from "./TagResourceCommand";
|
|
52
53
|
export * from "./UntagResourceCommand";
|
|
53
54
|
export * from "./UpdateAgentActionGroupCommand";
|
|
@@ -676,6 +676,17 @@ export const se_StartIngestionJobCommand = async (input, context) => {
|
|
|
676
676
|
b.m("PUT").h(headers).b(body);
|
|
677
677
|
return b.build();
|
|
678
678
|
};
|
|
679
|
+
export const se_StopIngestionJobCommand = async (input, context) => {
|
|
680
|
+
const b = rb(input, context);
|
|
681
|
+
const headers = {};
|
|
682
|
+
b.bp("/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}/stop");
|
|
683
|
+
b.p("knowledgeBaseId", () => input.knowledgeBaseId, "{knowledgeBaseId}", false);
|
|
684
|
+
b.p("dataSourceId", () => input.dataSourceId, "{dataSourceId}", false);
|
|
685
|
+
b.p("ingestionJobId", () => input.ingestionJobId, "{ingestionJobId}", false);
|
|
686
|
+
let body;
|
|
687
|
+
b.m("POST").h(headers).b(body);
|
|
688
|
+
return b.build();
|
|
689
|
+
};
|
|
679
690
|
export const se_TagResourceCommand = async (input, context) => {
|
|
680
691
|
const b = rb(input, context);
|
|
681
692
|
const headers = {
|
|
@@ -1671,6 +1682,20 @@ export const de_StartIngestionJobCommand = async (output, context) => {
|
|
|
1671
1682
|
Object.assign(contents, doc);
|
|
1672
1683
|
return contents;
|
|
1673
1684
|
};
|
|
1685
|
+
export const de_StopIngestionJobCommand = async (output, context) => {
|
|
1686
|
+
if (output.statusCode !== 202 && output.statusCode >= 300) {
|
|
1687
|
+
return de_CommandError(output, context);
|
|
1688
|
+
}
|
|
1689
|
+
const contents = map({
|
|
1690
|
+
$metadata: deserializeMetadata(output),
|
|
1691
|
+
});
|
|
1692
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
1693
|
+
const doc = take(data, {
|
|
1694
|
+
ingestionJob: (_) => de_IngestionJob(_, context),
|
|
1695
|
+
});
|
|
1696
|
+
Object.assign(contents, doc);
|
|
1697
|
+
return contents;
|
|
1698
|
+
};
|
|
1674
1699
|
export const de_TagResourceCommand = async (output, context) => {
|
|
1675
1700
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1676
1701
|
return de_CommandError(output, context);
|
package/dist-es/runtimeConfig.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import packageInfo from "../package.json";
|
|
2
2
|
import { emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
|
|
3
3
|
import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
|
|
4
|
-
import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
|
|
4
|
+
import { NODE_APP_ID_CONFIG_OPTIONS, defaultUserAgent } from "@aws-sdk/util-user-agent-node";
|
|
5
5
|
import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@smithy/config-resolver";
|
|
6
6
|
import { Hash } from "@smithy/hash-node";
|
|
7
7
|
import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@smithy/middleware-retry";
|
|
@@ -40,5 +40,6 @@ export const getRuntimeConfig = (config) => {
|
|
|
40
40
|
streamCollector: config?.streamCollector ?? streamCollector,
|
|
41
41
|
useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
|
|
42
42
|
useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
|
|
43
|
+
userAgentAppId: config?.userAgentAppId ?? loadNodeConfig(NODE_APP_ID_CONFIG_OPTIONS),
|
|
43
44
|
};
|
|
44
45
|
};
|
|
@@ -50,6 +50,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
|
|
|
50
50
|
import { PrepareAgentCommandInput, PrepareAgentCommandOutput } from "./commands/PrepareAgentCommand";
|
|
51
51
|
import { PrepareFlowCommandInput, PrepareFlowCommandOutput } from "./commands/PrepareFlowCommand";
|
|
52
52
|
import { StartIngestionJobCommandInput, StartIngestionJobCommandOutput } from "./commands/StartIngestionJobCommand";
|
|
53
|
+
import { StopIngestionJobCommandInput, StopIngestionJobCommandOutput } from "./commands/StopIngestionJobCommand";
|
|
53
54
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
54
55
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
55
56
|
import { UpdateAgentActionGroupCommandInput, UpdateAgentActionGroupCommandOutput } from "./commands/UpdateAgentActionGroupCommand";
|
|
@@ -366,6 +367,12 @@ export interface BedrockAgent {
|
|
|
366
367
|
startIngestionJob(args: StartIngestionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartIngestionJobCommandOutput>;
|
|
367
368
|
startIngestionJob(args: StartIngestionJobCommandInput, cb: (err: any, data?: StartIngestionJobCommandOutput) => void): void;
|
|
368
369
|
startIngestionJob(args: StartIngestionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartIngestionJobCommandOutput) => void): void;
|
|
370
|
+
/**
|
|
371
|
+
* @see {@link StopIngestionJobCommand}
|
|
372
|
+
*/
|
|
373
|
+
stopIngestionJob(args: StopIngestionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopIngestionJobCommandOutput>;
|
|
374
|
+
stopIngestionJob(args: StopIngestionJobCommandInput, cb: (err: any, data?: StopIngestionJobCommandOutput) => void): void;
|
|
375
|
+
stopIngestionJob(args: StopIngestionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopIngestionJobCommandOutput) => void): void;
|
|
369
376
|
/**
|
|
370
377
|
* @see {@link TagResourceCommand}
|
|
371
378
|
*/
|
|
@@ -57,6 +57,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
|
|
|
57
57
|
import { PrepareAgentCommandInput, PrepareAgentCommandOutput } from "./commands/PrepareAgentCommand";
|
|
58
58
|
import { PrepareFlowCommandInput, PrepareFlowCommandOutput } from "./commands/PrepareFlowCommand";
|
|
59
59
|
import { StartIngestionJobCommandInput, StartIngestionJobCommandOutput } from "./commands/StartIngestionJobCommand";
|
|
60
|
+
import { StopIngestionJobCommandInput, StopIngestionJobCommandOutput } from "./commands/StopIngestionJobCommand";
|
|
60
61
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
61
62
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
62
63
|
import { UpdateAgentActionGroupCommandInput, UpdateAgentActionGroupCommandOutput } from "./commands/UpdateAgentActionGroupCommand";
|
|
@@ -74,11 +75,11 @@ export { __Client };
|
|
|
74
75
|
/**
|
|
75
76
|
* @public
|
|
76
77
|
*/
|
|
77
|
-
export type ServiceInputTypes = AssociateAgentKnowledgeBaseCommandInput | CreateAgentActionGroupCommandInput | CreateAgentAliasCommandInput | CreateAgentCommandInput | CreateDataSourceCommandInput | CreateFlowAliasCommandInput | CreateFlowCommandInput | CreateFlowVersionCommandInput | CreateKnowledgeBaseCommandInput | CreatePromptCommandInput | CreatePromptVersionCommandInput | DeleteAgentActionGroupCommandInput | DeleteAgentAliasCommandInput | DeleteAgentCommandInput | DeleteAgentVersionCommandInput | DeleteDataSourceCommandInput | DeleteFlowAliasCommandInput | DeleteFlowCommandInput | DeleteFlowVersionCommandInput | DeleteKnowledgeBaseCommandInput | DeletePromptCommandInput | DisassociateAgentKnowledgeBaseCommandInput | GetAgentActionGroupCommandInput | GetAgentAliasCommandInput | GetAgentCommandInput | GetAgentKnowledgeBaseCommandInput | GetAgentVersionCommandInput | GetDataSourceCommandInput | GetFlowAliasCommandInput | GetFlowCommandInput | GetFlowVersionCommandInput | GetIngestionJobCommandInput | GetKnowledgeBaseCommandInput | GetPromptCommandInput | ListAgentActionGroupsCommandInput | ListAgentAliasesCommandInput | ListAgentKnowledgeBasesCommandInput | ListAgentVersionsCommandInput | ListAgentsCommandInput | ListDataSourcesCommandInput | ListFlowAliasesCommandInput | ListFlowVersionsCommandInput | ListFlowsCommandInput | ListIngestionJobsCommandInput | ListKnowledgeBasesCommandInput | ListPromptsCommandInput | ListTagsForResourceCommandInput | PrepareAgentCommandInput | PrepareFlowCommandInput | StartIngestionJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentActionGroupCommandInput | UpdateAgentAliasCommandInput | UpdateAgentCommandInput | UpdateAgentKnowledgeBaseCommandInput | UpdateDataSourceCommandInput | UpdateFlowAliasCommandInput | UpdateFlowCommandInput | UpdateKnowledgeBaseCommandInput | UpdatePromptCommandInput;
|
|
78
|
+
export type ServiceInputTypes = AssociateAgentKnowledgeBaseCommandInput | CreateAgentActionGroupCommandInput | CreateAgentAliasCommandInput | CreateAgentCommandInput | CreateDataSourceCommandInput | CreateFlowAliasCommandInput | CreateFlowCommandInput | CreateFlowVersionCommandInput | CreateKnowledgeBaseCommandInput | CreatePromptCommandInput | CreatePromptVersionCommandInput | DeleteAgentActionGroupCommandInput | DeleteAgentAliasCommandInput | DeleteAgentCommandInput | DeleteAgentVersionCommandInput | DeleteDataSourceCommandInput | DeleteFlowAliasCommandInput | DeleteFlowCommandInput | DeleteFlowVersionCommandInput | DeleteKnowledgeBaseCommandInput | DeletePromptCommandInput | DisassociateAgentKnowledgeBaseCommandInput | GetAgentActionGroupCommandInput | GetAgentAliasCommandInput | GetAgentCommandInput | GetAgentKnowledgeBaseCommandInput | GetAgentVersionCommandInput | GetDataSourceCommandInput | GetFlowAliasCommandInput | GetFlowCommandInput | GetFlowVersionCommandInput | GetIngestionJobCommandInput | GetKnowledgeBaseCommandInput | GetPromptCommandInput | ListAgentActionGroupsCommandInput | ListAgentAliasesCommandInput | ListAgentKnowledgeBasesCommandInput | ListAgentVersionsCommandInput | ListAgentsCommandInput | ListDataSourcesCommandInput | ListFlowAliasesCommandInput | ListFlowVersionsCommandInput | ListFlowsCommandInput | ListIngestionJobsCommandInput | ListKnowledgeBasesCommandInput | ListPromptsCommandInput | ListTagsForResourceCommandInput | PrepareAgentCommandInput | PrepareFlowCommandInput | StartIngestionJobCommandInput | StopIngestionJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentActionGroupCommandInput | UpdateAgentAliasCommandInput | UpdateAgentCommandInput | UpdateAgentKnowledgeBaseCommandInput | UpdateDataSourceCommandInput | UpdateFlowAliasCommandInput | UpdateFlowCommandInput | UpdateKnowledgeBaseCommandInput | UpdatePromptCommandInput;
|
|
78
79
|
/**
|
|
79
80
|
* @public
|
|
80
81
|
*/
|
|
81
|
-
export type ServiceOutputTypes = AssociateAgentKnowledgeBaseCommandOutput | CreateAgentActionGroupCommandOutput | CreateAgentAliasCommandOutput | CreateAgentCommandOutput | CreateDataSourceCommandOutput | CreateFlowAliasCommandOutput | CreateFlowCommandOutput | CreateFlowVersionCommandOutput | CreateKnowledgeBaseCommandOutput | CreatePromptCommandOutput | CreatePromptVersionCommandOutput | DeleteAgentActionGroupCommandOutput | DeleteAgentAliasCommandOutput | DeleteAgentCommandOutput | DeleteAgentVersionCommandOutput | DeleteDataSourceCommandOutput | DeleteFlowAliasCommandOutput | DeleteFlowCommandOutput | DeleteFlowVersionCommandOutput | DeleteKnowledgeBaseCommandOutput | DeletePromptCommandOutput | DisassociateAgentKnowledgeBaseCommandOutput | GetAgentActionGroupCommandOutput | GetAgentAliasCommandOutput | GetAgentCommandOutput | GetAgentKnowledgeBaseCommandOutput | GetAgentVersionCommandOutput | GetDataSourceCommandOutput | GetFlowAliasCommandOutput | GetFlowCommandOutput | GetFlowVersionCommandOutput | GetIngestionJobCommandOutput | GetKnowledgeBaseCommandOutput | GetPromptCommandOutput | ListAgentActionGroupsCommandOutput | ListAgentAliasesCommandOutput | ListAgentKnowledgeBasesCommandOutput | ListAgentVersionsCommandOutput | ListAgentsCommandOutput | ListDataSourcesCommandOutput | ListFlowAliasesCommandOutput | ListFlowVersionsCommandOutput | ListFlowsCommandOutput | ListIngestionJobsCommandOutput | ListKnowledgeBasesCommandOutput | ListPromptsCommandOutput | ListTagsForResourceCommandOutput | PrepareAgentCommandOutput | PrepareFlowCommandOutput | StartIngestionJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentActionGroupCommandOutput | UpdateAgentAliasCommandOutput | UpdateAgentCommandOutput | UpdateAgentKnowledgeBaseCommandOutput | UpdateDataSourceCommandOutput | UpdateFlowAliasCommandOutput | UpdateFlowCommandOutput | UpdateKnowledgeBaseCommandOutput | UpdatePromptCommandOutput;
|
|
82
|
+
export type ServiceOutputTypes = AssociateAgentKnowledgeBaseCommandOutput | CreateAgentActionGroupCommandOutput | CreateAgentAliasCommandOutput | CreateAgentCommandOutput | CreateDataSourceCommandOutput | CreateFlowAliasCommandOutput | CreateFlowCommandOutput | CreateFlowVersionCommandOutput | CreateKnowledgeBaseCommandOutput | CreatePromptCommandOutput | CreatePromptVersionCommandOutput | DeleteAgentActionGroupCommandOutput | DeleteAgentAliasCommandOutput | DeleteAgentCommandOutput | DeleteAgentVersionCommandOutput | DeleteDataSourceCommandOutput | DeleteFlowAliasCommandOutput | DeleteFlowCommandOutput | DeleteFlowVersionCommandOutput | DeleteKnowledgeBaseCommandOutput | DeletePromptCommandOutput | DisassociateAgentKnowledgeBaseCommandOutput | GetAgentActionGroupCommandOutput | GetAgentAliasCommandOutput | GetAgentCommandOutput | GetAgentKnowledgeBaseCommandOutput | GetAgentVersionCommandOutput | GetDataSourceCommandOutput | GetFlowAliasCommandOutput | GetFlowCommandOutput | GetFlowVersionCommandOutput | GetIngestionJobCommandOutput | GetKnowledgeBaseCommandOutput | GetPromptCommandOutput | ListAgentActionGroupsCommandOutput | ListAgentAliasesCommandOutput | ListAgentKnowledgeBasesCommandOutput | ListAgentVersionsCommandOutput | ListAgentsCommandOutput | ListDataSourcesCommandOutput | ListFlowAliasesCommandOutput | ListFlowVersionsCommandOutput | ListFlowsCommandOutput | ListIngestionJobsCommandOutput | ListKnowledgeBasesCommandOutput | ListPromptsCommandOutput | ListTagsForResourceCommandOutput | PrepareAgentCommandOutput | PrepareFlowCommandOutput | StartIngestionJobCommandOutput | StopIngestionJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentActionGroupCommandOutput | UpdateAgentAliasCommandOutput | UpdateAgentCommandOutput | UpdateAgentKnowledgeBaseCommandOutput | UpdateDataSourceCommandOutput | UpdateFlowAliasCommandOutput | UpdateFlowCommandOutput | UpdateKnowledgeBaseCommandOutput | UpdatePromptCommandOutput;
|
|
82
83
|
/**
|
|
83
84
|
* @public
|
|
84
85
|
*/
|
|
@@ -27,7 +27,7 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a knowledge base
|
|
30
|
+
* <p>Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html">Set up a knowledge base</a>.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create">Create a knowledge base</a>.</p>
|
|
33
33
|
* </note>
|
|
@@ -27,7 +27,7 @@ declare const GetIngestionJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets information about a ingestion job
|
|
30
|
+
* <p>Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Lanaguage Models (LLMs) can use your data.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -47,7 +47,7 @@ declare const GetIngestionJobCommand_base: {
|
|
|
47
47
|
* // dataSourceId: "STRING_VALUE", // required
|
|
48
48
|
* // ingestionJobId: "STRING_VALUE", // required
|
|
49
49
|
* // description: "STRING_VALUE",
|
|
50
|
-
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED", // required
|
|
50
|
+
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED", // required
|
|
51
51
|
* // statistics: { // IngestionJobStatistics
|
|
52
52
|
* // numberOfDocumentsScanned: Number("long"),
|
|
53
53
|
* // numberOfMetadataDocumentsScanned: Number("long"),
|
|
@@ -27,7 +27,7 @@ declare const ListIngestionJobsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the ingestion jobs for a data source
|
|
30
|
+
* <p>Lists the data ingestion jobs for a data source. The list also includes information about each job.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -62,7 +62,7 @@ declare const ListIngestionJobsCommand_base: {
|
|
|
62
62
|
* // dataSourceId: "STRING_VALUE", // required
|
|
63
63
|
* // ingestionJobId: "STRING_VALUE", // required
|
|
64
64
|
* // description: "STRING_VALUE",
|
|
65
|
-
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED", // required
|
|
65
|
+
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED", // required
|
|
66
66
|
* // startedAt: new Date("TIMESTAMP"), // required
|
|
67
67
|
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
68
68
|
* // statistics: { // IngestionJobStatistics
|
|
@@ -27,7 +27,7 @@ declare const ListKnowledgeBasesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the knowledge bases in an account
|
|
30
|
+
* <p>Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const StartIngestionJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Begins
|
|
30
|
+
* <p>Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -48,7 +48,7 @@ declare const StartIngestionJobCommand_base: {
|
|
|
48
48
|
* // dataSourceId: "STRING_VALUE", // required
|
|
49
49
|
* // ingestionJobId: "STRING_VALUE", // required
|
|
50
50
|
* // description: "STRING_VALUE",
|
|
51
|
-
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED", // required
|
|
51
|
+
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED", // required
|
|
52
52
|
* // statistics: { // IngestionJobStatistics
|
|
53
53
|
* // numberOfDocumentsScanned: Number("long"),
|
|
54
54
|
* // numberOfMetadataDocumentsScanned: Number("long"),
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
+
import { StopIngestionJobRequest, StopIngestionJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StopIngestionJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StopIngestionJobCommandInput extends StopIngestionJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StopIngestionJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StopIngestionJobCommandOutput extends StopIngestionJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StopIngestionJobCommand_base: {
|
|
25
|
+
new (input: StopIngestionJobCommandInput): import("@smithy/smithy-client").CommandImpl<StopIngestionJobCommandInput, StopIngestionJobCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: StopIngestionJobCommandInput): import("@smithy/smithy-client").CommandImpl<StopIngestionJobCommandInput, StopIngestionJobCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Stops a currently running data ingestion job. You can send a <code>StartIngestionJob</code> request again to ingest the rest of your data when you are ready.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentClient, StopIngestionJobCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentClient, StopIngestionJobCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentClient(config);
|
|
37
|
+
* const input = { // StopIngestionJobRequest
|
|
38
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
39
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
40
|
+
* ingestionJobId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new StopIngestionJobCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // StopIngestionJobResponse
|
|
45
|
+
* // ingestionJob: { // IngestionJob
|
|
46
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
47
|
+
* // dataSourceId: "STRING_VALUE", // required
|
|
48
|
+
* // ingestionJobId: "STRING_VALUE", // required
|
|
49
|
+
* // description: "STRING_VALUE",
|
|
50
|
+
* // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "STOPPING" || "STOPPED", // required
|
|
51
|
+
* // statistics: { // IngestionJobStatistics
|
|
52
|
+
* // numberOfDocumentsScanned: Number("long"),
|
|
53
|
+
* // numberOfMetadataDocumentsScanned: Number("long"),
|
|
54
|
+
* // numberOfNewDocumentsIndexed: Number("long"),
|
|
55
|
+
* // numberOfModifiedDocumentsIndexed: Number("long"),
|
|
56
|
+
* // numberOfMetadataDocumentsModified: Number("long"),
|
|
57
|
+
* // numberOfDocumentsDeleted: Number("long"),
|
|
58
|
+
* // numberOfDocumentsFailed: Number("long"),
|
|
59
|
+
* // },
|
|
60
|
+
* // failureReasons: [ // FailureReasons
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // startedAt: new Date("TIMESTAMP"), // required
|
|
64
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
65
|
+
* // },
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param StopIngestionJobCommandInput - {@link StopIngestionJobCommandInput}
|
|
71
|
+
* @returns {@link StopIngestionJobCommandOutput}
|
|
72
|
+
* @see {@link StopIngestionJobCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link StopIngestionJobCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ConflictException} (client fault)
|
|
80
|
+
* <p>There was a conflict performing an operation.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InternalServerException} (server fault)
|
|
83
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
89
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link BedrockAgentServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class StopIngestionJobCommand extends StopIngestionJobCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: StopIngestionJobRequest;
|
|
104
|
+
output: StopIngestionJobResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: StopIngestionJobCommandInput;
|
|
108
|
+
output: StopIngestionJobCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -48,6 +48,7 @@ export * from "./ListTagsForResourceCommand";
|
|
|
48
48
|
export * from "./PrepareAgentCommand";
|
|
49
49
|
export * from "./PrepareFlowCommand";
|
|
50
50
|
export * from "./StartIngestionJobCommand";
|
|
51
|
+
export * from "./StopIngestionJobCommand";
|
|
51
52
|
export * from "./TagResourceCommand";
|
|
52
53
|
export * from "./UntagResourceCommand";
|
|
53
54
|
export * from "./UpdateAgentActionGroupCommand";
|