@aws-sdk/client-bedrock-agentcore 3.1043.0 → 3.1045.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 +77 -0
- package/dist-cjs/index.js +217 -0
- package/dist-cjs/schemas/schemas_0.js +458 -33
- package/dist-es/BedrockAgentCore.js +26 -0
- package/dist-es/commands/CreatePaymentInstrumentCommand.js +16 -0
- package/dist-es/commands/CreatePaymentSessionCommand.js +16 -0
- package/dist-es/commands/DeletePaymentInstrumentCommand.js +16 -0
- package/dist-es/commands/DeletePaymentSessionCommand.js +16 -0
- package/dist-es/commands/GetPaymentInstrumentBalanceCommand.js +16 -0
- package/dist-es/commands/GetPaymentInstrumentCommand.js +16 -0
- package/dist-es/commands/GetPaymentSessionCommand.js +16 -0
- package/dist-es/commands/GetResourcePaymentTokenCommand.js +16 -0
- package/dist-es/commands/ListPaymentInstrumentsCommand.js +16 -0
- package/dist-es/commands/ListPaymentSessionsCommand.js +16 -0
- package/dist-es/commands/ProcessPaymentCommand.js +16 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/enums.js +45 -0
- package/dist-es/pagination/ListPaymentInstrumentsPaginator.js +4 -0
- package/dist-es/pagination/ListPaymentSessionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +449 -25
- package/dist-types/BedrockAgentCore.d.ts +91 -0
- package/dist-types/BedrockAgentCoreClient.d.ts +13 -2
- package/dist-types/commands/CreatePaymentInstrumentCommand.d.ts +212 -0
- package/dist-types/commands/CreatePaymentSessionCommand.d.ts +122 -0
- package/dist-types/commands/DeletePaymentInstrumentCommand.d.ts +110 -0
- package/dist-types/commands/DeletePaymentSessionCommand.d.ts +105 -0
- package/dist-types/commands/GetPaymentInstrumentBalanceCommand.d.ts +102 -0
- package/dist-types/commands/GetPaymentInstrumentCommand.d.ts +155 -0
- package/dist-types/commands/GetPaymentSessionCommand.d.ts +112 -0
- package/dist-types/commands/GetResourcePaymentTokenCommand.d.ts +119 -0
- package/dist-types/commands/InvokeHarnessCommand.d.ts +1 -1
- package/dist-types/commands/ListPaymentInstrumentsCommand.d.ts +103 -0
- package/dist-types/commands/ListPaymentSessionsCommand.d.ts +100 -0
- package/dist-types/commands/ProcessPaymentCommand.d.ts +117 -0
- package/dist-types/commands/RetrieveMemoryRecordsCommand.d.ts +1 -1
- package/dist-types/commands/SearchRegistryRecordsCommand.d.ts +1 -2
- package/dist-types/commands/StartMemoryExtractionJobCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/enums.d.ts +140 -0
- package/dist-types/models/models_0.d.ts +222 -154
- package/dist-types/models/models_1.d.ts +1321 -2
- package/dist-types/pagination/ListPaymentInstrumentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPaymentSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +59 -0
- package/dist-types/ts3.4/BedrockAgentCore.d.ts +201 -0
- package/dist-types/ts3.4/BedrockAgentCoreClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreatePaymentInstrumentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreatePaymentSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePaymentInstrumentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePaymentSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPaymentInstrumentBalanceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPaymentInstrumentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPaymentSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetResourcePaymentTokenCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPaymentInstrumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPaymentSessionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ProcessPaymentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/RetrieveMemoryRecordsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchRegistryRecordsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/StartMemoryExtractionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/enums.d.ts +62 -0
- package/dist-types/ts3.4/models/models_0.d.ts +84 -38
- package/dist-types/ts3.4/models/models_1.d.ts +423 -2
- package/dist-types/ts3.4/pagination/ListPaymentInstrumentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPaymentSessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +59 -0
- package/package.json +1 -1
|
@@ -0,0 +1,110 @@
|
|
|
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 { DeletePaymentInstrumentRequest, DeletePaymentInstrumentResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeletePaymentInstrumentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeletePaymentInstrumentCommandInput extends DeletePaymentInstrumentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeletePaymentInstrumentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeletePaymentInstrumentCommandOutput extends DeletePaymentInstrumentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeletePaymentInstrumentCommand_base: {
|
|
25
|
+
new (input: DeletePaymentInstrumentCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePaymentInstrumentCommandInput, DeletePaymentInstrumentCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeletePaymentInstrumentCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePaymentInstrumentCommandInput, DeletePaymentInstrumentCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Delete a payment instrument
|
|
31
|
+
*
|
|
32
|
+
* Marks a payment instrument as deleted by updating its status to DELETED. This is a soft delete
|
|
33
|
+
* operation that preserves the record in the database for audit and compliance purposes. The record
|
|
34
|
+
* remains queryable for audit purposes but is excluded from normal list and get operations.
|
|
35
|
+
*
|
|
36
|
+
* Deleting an already-deleted or non-existent instrument returns ResourceNotFoundException (404).
|
|
37
|
+
*
|
|
38
|
+
* Authorization: The caller must own the instrument (accountId, userId, and paymentManagerId must match).
|
|
39
|
+
* If authorization fails, a 403 Forbidden error is returned.
|
|
40
|
+
*
|
|
41
|
+
* Timestamp Management: The updatedAt timestamp is set to the current time, while createdAt is preserved.
|
|
42
|
+
* The version field is incremented for optimistic locking.
|
|
43
|
+
*
|
|
44
|
+
* Errors:
|
|
45
|
+
* - ResourceNotFoundException: The instrument does not exist or is already deleted
|
|
46
|
+
* - AccessDeniedException: The caller is not authorized to delete this instrument
|
|
47
|
+
* - ValidationException: Required fields are missing or invalid
|
|
48
|
+
* - InternalServerException: An unexpected server error occurred
|
|
49
|
+
* @example
|
|
50
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
51
|
+
* ```javascript
|
|
52
|
+
* import { BedrockAgentCoreClient, DeletePaymentInstrumentCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
53
|
+
* // const { BedrockAgentCoreClient, DeletePaymentInstrumentCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
54
|
+
* // import type { BedrockAgentCoreClientConfig } from "@aws-sdk/client-bedrock-agentcore";
|
|
55
|
+
* const config = {}; // type is BedrockAgentCoreClientConfig
|
|
56
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
57
|
+
* const input = { // DeletePaymentInstrumentRequest
|
|
58
|
+
* userId: "STRING_VALUE",
|
|
59
|
+
* paymentManagerArn: "STRING_VALUE", // required
|
|
60
|
+
* paymentConnectorId: "STRING_VALUE", // required
|
|
61
|
+
* paymentInstrumentId: "STRING_VALUE", // required
|
|
62
|
+
* };
|
|
63
|
+
* const command = new DeletePaymentInstrumentCommand(input);
|
|
64
|
+
* const response = await client.send(command);
|
|
65
|
+
* // { // DeletePaymentInstrumentResponse
|
|
66
|
+
* // status: "INITIATED" || "ACTIVE" || "FAILED" || "DELETED", // required
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param DeletePaymentInstrumentCommandInput - {@link DeletePaymentInstrumentCommandInput}
|
|
72
|
+
* @returns {@link DeletePaymentInstrumentCommandOutput}
|
|
73
|
+
* @see {@link DeletePaymentInstrumentCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link DeletePaymentInstrumentCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <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>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <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>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <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>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <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>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class DeletePaymentInstrumentCommand extends DeletePaymentInstrumentCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: DeletePaymentInstrumentRequest;
|
|
103
|
+
output: DeletePaymentInstrumentResponse;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: DeletePaymentInstrumentCommandInput;
|
|
107
|
+
output: DeletePaymentInstrumentCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
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 { DeletePaymentSessionRequest, DeletePaymentSessionResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeletePaymentSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeletePaymentSessionCommandInput extends DeletePaymentSessionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeletePaymentSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeletePaymentSessionCommandOutput extends DeletePaymentSessionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeletePaymentSessionCommand_base: {
|
|
25
|
+
new (input: DeletePaymentSessionCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePaymentSessionCommandInput, DeletePaymentSessionCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeletePaymentSessionCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePaymentSessionCommandInput, DeletePaymentSessionCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Delete a payment manager session
|
|
31
|
+
*
|
|
32
|
+
* Permanently removes a payment session record from the database. This is a hard delete operation
|
|
33
|
+
* that removes the session completely.
|
|
34
|
+
*
|
|
35
|
+
* Deleting a non-existent or already-deleted session returns ResourceNotFoundException (404).
|
|
36
|
+
*
|
|
37
|
+
* Authorization: The caller must own the session (accountId, userId, and paymentManagerId must match).
|
|
38
|
+
* If authorization fails, a 403 Forbidden error is returned.
|
|
39
|
+
*
|
|
40
|
+
* Errors:
|
|
41
|
+
* - ResourceNotFoundException: The session does not exist or has already been deleted
|
|
42
|
+
* - AccessDeniedException: The caller is not authorized to delete this session
|
|
43
|
+
* - ValidationException: Required fields are missing or invalid
|
|
44
|
+
* - InternalServerException: An unexpected server error occurred
|
|
45
|
+
* @example
|
|
46
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
47
|
+
* ```javascript
|
|
48
|
+
* import { BedrockAgentCoreClient, DeletePaymentSessionCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
49
|
+
* // const { BedrockAgentCoreClient, DeletePaymentSessionCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
50
|
+
* // import type { BedrockAgentCoreClientConfig } from "@aws-sdk/client-bedrock-agentcore";
|
|
51
|
+
* const config = {}; // type is BedrockAgentCoreClientConfig
|
|
52
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
53
|
+
* const input = { // DeletePaymentSessionRequest
|
|
54
|
+
* userId: "STRING_VALUE",
|
|
55
|
+
* paymentManagerArn: "STRING_VALUE", // required
|
|
56
|
+
* paymentSessionId: "STRING_VALUE", // required
|
|
57
|
+
* };
|
|
58
|
+
* const command = new DeletePaymentSessionCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* // { // DeletePaymentSessionResponse
|
|
61
|
+
* // status: "ACTIVE" || "EXPIRED" || "DELETED", // required
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param DeletePaymentSessionCommandInput - {@link DeletePaymentSessionCommandInput}
|
|
67
|
+
* @returns {@link DeletePaymentSessionCommandOutput}
|
|
68
|
+
* @see {@link DeletePaymentSessionCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link DeletePaymentSessionCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServerException} (server fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class DeletePaymentSessionCommand extends DeletePaymentSessionCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: DeletePaymentSessionRequest;
|
|
98
|
+
output: DeletePaymentSessionResponse;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: DeletePaymentSessionCommandInput;
|
|
102
|
+
output: DeletePaymentSessionCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
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 { GetPaymentInstrumentBalanceRequest, GetPaymentInstrumentBalanceResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPaymentInstrumentBalanceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPaymentInstrumentBalanceCommandInput extends GetPaymentInstrumentBalanceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPaymentInstrumentBalanceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPaymentInstrumentBalanceCommandOutput extends GetPaymentInstrumentBalanceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPaymentInstrumentBalanceCommand_base: {
|
|
25
|
+
new (input: GetPaymentInstrumentBalanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPaymentInstrumentBalanceCommandInput, GetPaymentInstrumentBalanceCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPaymentInstrumentBalanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPaymentInstrumentBalanceCommandInput, GetPaymentInstrumentBalanceCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get the balance of a payment instrument
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, GetPaymentInstrumentBalanceCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, GetPaymentInstrumentBalanceCommand } = 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 = { // GetPaymentInstrumentBalanceRequest
|
|
40
|
+
* userId: "STRING_VALUE",
|
|
41
|
+
* agentName: "STRING_VALUE",
|
|
42
|
+
* paymentManagerArn: "STRING_VALUE", // required
|
|
43
|
+
* paymentConnectorId: "STRING_VALUE", // required
|
|
44
|
+
* paymentInstrumentId: "STRING_VALUE", // required
|
|
45
|
+
* chain: "BASE" || "BASE_SEPOLIA" || "ETHEREUM" || "SOLANA" || "SOLANA_DEVNET", // required
|
|
46
|
+
* token: "USDC", // required
|
|
47
|
+
* };
|
|
48
|
+
* const command = new GetPaymentInstrumentBalanceCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // GetPaymentInstrumentBalanceResponse
|
|
51
|
+
* // paymentInstrumentId: "STRING_VALUE", // required
|
|
52
|
+
* // tokenBalance: { // TokenBalance
|
|
53
|
+
* // amount: "STRING_VALUE", // required
|
|
54
|
+
* // decimals: Number("int"), // required
|
|
55
|
+
* // token: "USDC", // required
|
|
56
|
+
* // network: "ETHEREUM" || "SOLANA", // required
|
|
57
|
+
* // chain: "BASE" || "BASE_SEPOLIA" || "ETHEREUM" || "SOLANA" || "SOLANA_DEVNET", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param GetPaymentInstrumentBalanceCommandInput - {@link GetPaymentInstrumentBalanceCommandInput}
|
|
64
|
+
* @returns {@link GetPaymentInstrumentBalanceCommandOutput}
|
|
65
|
+
* @see {@link GetPaymentInstrumentBalanceCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link GetPaymentInstrumentBalanceCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class GetPaymentInstrumentBalanceCommand extends GetPaymentInstrumentBalanceCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: GetPaymentInstrumentBalanceRequest;
|
|
95
|
+
output: GetPaymentInstrumentBalanceResponse;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: GetPaymentInstrumentBalanceCommandInput;
|
|
99
|
+
output: GetPaymentInstrumentBalanceCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,155 @@
|
|
|
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 { GetPaymentInstrumentRequest, GetPaymentInstrumentResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPaymentInstrumentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPaymentInstrumentCommandInput extends GetPaymentInstrumentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPaymentInstrumentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPaymentInstrumentCommandOutput extends GetPaymentInstrumentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPaymentInstrumentCommand_base: {
|
|
25
|
+
new (input: GetPaymentInstrumentCommandInput): import("@smithy/smithy-client").CommandImpl<GetPaymentInstrumentCommandInput, GetPaymentInstrumentCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPaymentInstrumentCommandInput): import("@smithy/smithy-client").CommandImpl<GetPaymentInstrumentCommandInput, GetPaymentInstrumentCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get a payment instrument by ID
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, GetPaymentInstrumentCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, GetPaymentInstrumentCommand } = 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 = { // GetPaymentInstrumentRequest
|
|
40
|
+
* userId: "STRING_VALUE",
|
|
41
|
+
* agentName: "STRING_VALUE",
|
|
42
|
+
* paymentManagerArn: "STRING_VALUE", // required
|
|
43
|
+
* paymentConnectorId: "STRING_VALUE",
|
|
44
|
+
* paymentInstrumentId: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new GetPaymentInstrumentCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // GetPaymentInstrumentResponse
|
|
49
|
+
* // paymentInstrument: { // PaymentInstrument
|
|
50
|
+
* // paymentInstrumentId: "STRING_VALUE", // required
|
|
51
|
+
* // paymentManagerArn: "STRING_VALUE", // required
|
|
52
|
+
* // paymentConnectorId: "STRING_VALUE", // required
|
|
53
|
+
* // userId: "STRING_VALUE", // required
|
|
54
|
+
* // paymentInstrumentType: "EMBEDDED_CRYPTO_WALLET", // required
|
|
55
|
+
* // paymentInstrumentDetails: { // PaymentInstrumentDetails Union: only one key present
|
|
56
|
+
* // embeddedCryptoWallet: { // EmbeddedCryptoWallet
|
|
57
|
+
* // network: "ETHEREUM" || "SOLANA", // required
|
|
58
|
+
* // linkedAccounts: [ // LinkedAccountList // required
|
|
59
|
+
* // { // LinkedAccount Union: only one key present
|
|
60
|
+
* // email: { // LinkedAccountEmail
|
|
61
|
+
* // emailAddress: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // sms: { // LinkedAccountSms
|
|
64
|
+
* // phoneNumber: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // developerJwt: { // LinkedAccountDeveloperJwt
|
|
67
|
+
* // kid: "STRING_VALUE", // required
|
|
68
|
+
* // sub: "STRING_VALUE", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // oAuth2: { // LinkedAccountOAuth2 Union: only one key present
|
|
71
|
+
* // google: { // OAuth2Authentication
|
|
72
|
+
* // sub: "STRING_VALUE", // required
|
|
73
|
+
* // emailAddress: "STRING_VALUE",
|
|
74
|
+
* // name: "STRING_VALUE",
|
|
75
|
+
* // username: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // apple: {
|
|
78
|
+
* // sub: "STRING_VALUE", // required
|
|
79
|
+
* // emailAddress: "STRING_VALUE",
|
|
80
|
+
* // name: "STRING_VALUE",
|
|
81
|
+
* // username: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // x: {
|
|
84
|
+
* // sub: "STRING_VALUE", // required
|
|
85
|
+
* // emailAddress: "STRING_VALUE",
|
|
86
|
+
* // name: "STRING_VALUE",
|
|
87
|
+
* // username: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // telegram: {
|
|
90
|
+
* // sub: "STRING_VALUE", // required
|
|
91
|
+
* // emailAddress: "STRING_VALUE",
|
|
92
|
+
* // name: "STRING_VALUE",
|
|
93
|
+
* // username: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // github: {
|
|
96
|
+
* // sub: "STRING_VALUE", // required
|
|
97
|
+
* // emailAddress: "STRING_VALUE",
|
|
98
|
+
* // name: "STRING_VALUE",
|
|
99
|
+
* // username: "STRING_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // },
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // walletAddress: "STRING_VALUE",
|
|
105
|
+
* // redirectUrl: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
109
|
+
* // status: "INITIATED" || "ACTIVE" || "FAILED" || "DELETED", // required
|
|
110
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
111
|
+
* // },
|
|
112
|
+
* // };
|
|
113
|
+
*
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
116
|
+
* @param GetPaymentInstrumentCommandInput - {@link GetPaymentInstrumentCommandInput}
|
|
117
|
+
* @returns {@link GetPaymentInstrumentCommandOutput}
|
|
118
|
+
* @see {@link GetPaymentInstrumentCommandInput} for command's `input` shape.
|
|
119
|
+
* @see {@link GetPaymentInstrumentCommandOutput} for command's `response` shape.
|
|
120
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
123
|
+
* <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>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link InternalServerException} (server fault)
|
|
126
|
+
* <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>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
129
|
+
* <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>
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
132
|
+
* <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>
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link ValidationException} (client fault)
|
|
135
|
+
* <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>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
138
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
139
|
+
*
|
|
140
|
+
*
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
export declare class GetPaymentInstrumentCommand extends GetPaymentInstrumentCommand_base {
|
|
144
|
+
/** @internal type navigation helper, not in runtime. */
|
|
145
|
+
protected static __types: {
|
|
146
|
+
api: {
|
|
147
|
+
input: GetPaymentInstrumentRequest;
|
|
148
|
+
output: GetPaymentInstrumentResponse;
|
|
149
|
+
};
|
|
150
|
+
sdk: {
|
|
151
|
+
input: GetPaymentInstrumentCommandInput;
|
|
152
|
+
output: GetPaymentInstrumentCommandOutput;
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
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 { GetPaymentSessionRequest, GetPaymentSessionResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPaymentSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPaymentSessionCommandInput extends GetPaymentSessionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPaymentSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPaymentSessionCommandOutput extends GetPaymentSessionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPaymentSessionCommand_base: {
|
|
25
|
+
new (input: GetPaymentSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetPaymentSessionCommandInput, GetPaymentSessionCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPaymentSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetPaymentSessionCommandInput, GetPaymentSessionCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get a payment session
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, GetPaymentSessionCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, GetPaymentSessionCommand } = 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 = { // GetPaymentSessionRequest
|
|
40
|
+
* userId: "STRING_VALUE",
|
|
41
|
+
* agentName: "STRING_VALUE",
|
|
42
|
+
* paymentManagerArn: "STRING_VALUE", // required
|
|
43
|
+
* paymentSessionId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new GetPaymentSessionCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // GetPaymentSessionResponse
|
|
48
|
+
* // paymentSession: { // PaymentSession
|
|
49
|
+
* // paymentSessionId: "STRING_VALUE", // required
|
|
50
|
+
* // paymentManagerArn: "STRING_VALUE", // required
|
|
51
|
+
* // limits: { // SessionLimits
|
|
52
|
+
* // maxSpendAmount: { // Amount
|
|
53
|
+
* // value: "STRING_VALUE", // required
|
|
54
|
+
* // currency: "USD", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // userId: "STRING_VALUE", // required
|
|
58
|
+
* // expiryTimeInMinutes: Number("int"), // required
|
|
59
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
60
|
+
* // availableLimits: { // AvailableLimits
|
|
61
|
+
* // availableSpendAmount: {
|
|
62
|
+
* // value: "STRING_VALUE", // required
|
|
63
|
+
* // currency: "USD", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
66
|
+
* // },
|
|
67
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
68
|
+
* // },
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param GetPaymentSessionCommandInput - {@link GetPaymentSessionCommandInput}
|
|
74
|
+
* @returns {@link GetPaymentSessionCommandOutput}
|
|
75
|
+
* @see {@link GetPaymentSessionCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link GetPaymentSessionCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
+
* <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>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InternalServerException} (server fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
|
+
* <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>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
89
|
+
* <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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* <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>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
96
|
+
*
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class GetPaymentSessionCommand extends GetPaymentSessionCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: GetPaymentSessionRequest;
|
|
105
|
+
output: GetPaymentSessionResponse;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: GetPaymentSessionCommandInput;
|
|
109
|
+
output: GetPaymentSessionCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|