@aws-sdk/client-billing 3.1156.0 → 3.1157.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 +63 -0
- package/dist-cjs/index.js +531 -43
- package/dist-es/Billing.js +26 -0
- package/dist-es/commands/AssociateContractCommand.js +4 -0
- package/dist-es/commands/CancelContractualInvestmentAttestationCommand.js +4 -0
- package/dist-es/commands/CreateContractualInvestmentAttestationCommand.js +4 -0
- package/dist-es/commands/DisassociateContractCommand.js +4 -0
- package/dist-es/commands/GetContractInformationCommand.js +4 -0
- package/dist-es/commands/ListContractsCommand.js +4 -0
- package/dist-es/commands/ListContractualInvestmentAttestationsCommand.js +4 -0
- package/dist-es/commands/ListContractualInvestmentSummariesCommand.js +4 -0
- package/dist-es/commands/ListContractualInvestmentsCommand.js +4 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/enums.js +28 -0
- package/dist-es/models/errors.js +34 -34
- package/dist-es/pagination/ListContractsPaginator.js +4 -0
- package/dist-es/pagination/ListContractualInvestmentAttestationsPaginator.js +4 -0
- package/dist-es/pagination/ListContractualInvestmentSummariesPaginator.js +4 -0
- package/dist-es/pagination/ListContractualInvestmentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/schemas/schemas_0.js +359 -8
- package/dist-types/Billing.d.ts +92 -0
- package/dist-types/BillingClient.d.ts +11 -2
- package/dist-types/commands/AssociateContractCommand.d.ts +102 -0
- package/dist-types/commands/CancelContractualInvestmentAttestationCommand.d.ts +104 -0
- package/dist-types/commands/CreateContractualInvestmentAttestationCommand.d.ts +262 -0
- package/dist-types/commands/DisassociateContractCommand.d.ts +97 -0
- package/dist-types/commands/GetContractInformationCommand.d.ts +143 -0
- package/dist-types/commands/ListContractsCommand.d.ts +121 -0
- package/dist-types/commands/ListContractualInvestmentAttestationsCommand.d.ts +164 -0
- package/dist-types/commands/ListContractualInvestmentSummariesCommand.d.ts +125 -0
- package/dist-types/commands/ListContractualInvestmentsCommand.d.ts +168 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/models/enums.d.ts +76 -0
- package/dist-types/models/errors.d.ts +41 -41
- package/dist-types/models/models_0.d.ts +775 -7
- package/dist-types/pagination/ListContractsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListContractualInvestmentAttestationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListContractualInvestmentSummariesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListContractualInvestmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/schemas/schemas_0.d.ts +46 -1
- package/dist-types/ts3.4/Billing.d.ts +182 -0
- package/dist-types/ts3.4/BillingClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/AssociateContractCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CancelContractualInvestmentAttestationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateContractualInvestmentAttestationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DisassociateContractCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetContractInformationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListContractsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListContractualInvestmentAttestationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListContractualInvestmentSummariesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListContractualInvestmentsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +35 -0
- package/dist-types/ts3.4/models/errors.d.ts +16 -16
- package/dist-types/ts3.4/models/models_0.d.ts +234 -3
- package/dist-types/ts3.4/pagination/ListContractsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListContractualInvestmentAttestationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListContractualInvestmentSummariesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListContractualInvestmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +51 -1
- package/package.json +5 -5
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListContractualInvestmentAttestationsRequest, ListContractualInvestmentAttestationsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListContractualInvestmentAttestationsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListContractualInvestmentAttestationsCommandInput extends ListContractualInvestmentAttestationsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListContractualInvestmentAttestationsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListContractualInvestmentAttestationsCommandOutput extends ListContractualInvestmentAttestationsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListContractualInvestmentAttestationsCommand_base: {
|
|
22
|
+
new (input: ListContractualInvestmentAttestationsCommandInput): import("@smithy/core/client").CommandImpl<ListContractualInvestmentAttestationsCommandInput, ListContractualInvestmentAttestationsCommandOutput, import("..").BillingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListContractualInvestmentAttestationsCommandInput): import("@smithy/core/client").CommandImpl<ListContractualInvestmentAttestationsCommandInput, ListContractualInvestmentAttestationsCommandOutput, import("..").BillingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Lists the investment attestations submitted under a specific private pricing contract. Use this operation to track attestation status, including the terminal statuses <code>DISBURSED</code>, <code>REJECTED</code>, and <code>CANCELLED</code>. This operation is read-only and paginated.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { BillingClient, ListContractualInvestmentAttestationsCommand } from "@aws-sdk/client-billing"; // ES Modules import
|
|
32
|
+
* // const { BillingClient, ListContractualInvestmentAttestationsCommand } = require("@aws-sdk/client-billing"); // CommonJS import
|
|
33
|
+
* // import type { BillingClientConfig } from "@aws-sdk/client-billing";
|
|
34
|
+
* const config = {}; // type is BillingClientConfig
|
|
35
|
+
* const client = new BillingClient(config);
|
|
36
|
+
* const input = { // ListContractualInvestmentAttestationsRequest
|
|
37
|
+
* contractArn: "STRING_VALUE", // required
|
|
38
|
+
* investmentSummaryId: "STRING_VALUE",
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListContractualInvestmentAttestationsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListContractualInvestmentAttestationsResponse
|
|
45
|
+
* // items: [ // InvestmentAttestations // required
|
|
46
|
+
* // { // InvestmentAttestation
|
|
47
|
+
* // attestationId: "STRING_VALUE", // required
|
|
48
|
+
* // investmentName: "STRING_VALUE", // required
|
|
49
|
+
* // outcomeDescription: "STRING_VALUE", // required
|
|
50
|
+
* // investmentSummaryId: "STRING_VALUE", // required
|
|
51
|
+
* // investmentId: "STRING_VALUE", // required
|
|
52
|
+
* // attestedAt: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
54
|
+
* // attestationStatus: "PENDING_REVIEW" || "PENDING_C_LEVEL_APPROVAL" || "PENDING_CANCELLATION" || "REJECTED" || "CANCELLED" || "DISBURSED", // required
|
|
55
|
+
* // investmentDisbursedAt: new Date("TIMESTAMP"),
|
|
56
|
+
* // attestedValue: { // Amount
|
|
57
|
+
* // currencyCode: "STRING_VALUE", // required
|
|
58
|
+
* // currencyAmount: "STRING_VALUE", // required
|
|
59
|
+
* // },
|
|
60
|
+
* // investmentDistributions: [ // InvestmentDistributions
|
|
61
|
+
* // { // InvestmentDistribution
|
|
62
|
+
* // accountId: "STRING_VALUE", // required
|
|
63
|
+
* // investmentAmount: {
|
|
64
|
+
* // currencyCode: "STRING_VALUE", // required
|
|
65
|
+
* // currencyAmount: "STRING_VALUE", // required
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // rejectionReasons: [ // RejectionReasons
|
|
70
|
+
* // "STRING_VALUE",
|
|
71
|
+
* // ],
|
|
72
|
+
* // isCancellable: true || false,
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // nextToken: "STRING_VALUE",
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
80
|
+
* @param ListContractualInvestmentAttestationsCommandInput - {@link ListContractualInvestmentAttestationsCommandInput}
|
|
81
|
+
* @returns {@link ListContractualInvestmentAttestationsCommandOutput}
|
|
82
|
+
* @see {@link ListContractualInvestmentAttestationsCommandInput} for command's `input` shape.
|
|
83
|
+
* @see {@link ListContractualInvestmentAttestationsCommandOutput} for command's `response` shape.
|
|
84
|
+
* @see {@link BillingClientResolvedConfig | config} for BillingClient's `config` shape.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
87
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link InternalServerException} (server fault)
|
|
90
|
+
* <p>The request processing failed because of an unknown error, exception, or failure. </p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p> The specified ARN in the request doesn't exist. </p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
96
|
+
* <p>The request was denied due to request throttling. </p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ValidationException} (client fault)
|
|
99
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service. </p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link BillingServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from Billing service.</p>
|
|
103
|
+
*
|
|
104
|
+
*
|
|
105
|
+
* @example Invoke ListContractualInvestmentAttestations
|
|
106
|
+
* ```javascript
|
|
107
|
+
* //
|
|
108
|
+
* const input = {
|
|
109
|
+
* contractArn: "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
110
|
+
* maxResults: 25
|
|
111
|
+
* };
|
|
112
|
+
* const command = new ListContractualInvestmentAttestationsCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* {
|
|
116
|
+
* items: [
|
|
117
|
+
* {
|
|
118
|
+
* attestationId: "a1b2c3d4-5678-90ab-cdef-111122223333",
|
|
119
|
+
* attestationStatus: "PENDING_CANCELLATION",
|
|
120
|
+
* attestedAt: 1333333333,
|
|
121
|
+
* attestedValue: {
|
|
122
|
+
* currencyAmount: "1.00",
|
|
123
|
+
* currencyCode: "USD"
|
|
124
|
+
* },
|
|
125
|
+
* investmentId: "Investment-Id",
|
|
126
|
+
* investmentName: "Example Investment Name",
|
|
127
|
+
* investmentSummaryId: "Example-Investment-Summary-Id",
|
|
128
|
+
* outcomeDescription: "Example outcome description",
|
|
129
|
+
* updatedAt: 1444444444
|
|
130
|
+
* },
|
|
131
|
+
* {
|
|
132
|
+
* attestationId: "b2c3d4e5-6789-01bc-def0-222233334444",
|
|
133
|
+
* attestationStatus: "CANCELLED",
|
|
134
|
+
* attestedAt: 1555555555,
|
|
135
|
+
* attestedValue: {
|
|
136
|
+
* currencyAmount: "1.00",
|
|
137
|
+
* currencyCode: "USD"
|
|
138
|
+
* },
|
|
139
|
+
* investmentId: "Investment-Id",
|
|
140
|
+
* investmentName: "Example Investment Name",
|
|
141
|
+
* investmentSummaryId: "Example-Investment-Summary-Id",
|
|
142
|
+
* outcomeDescription: "Example outcome description",
|
|
143
|
+
* updatedAt: 1666666666
|
|
144
|
+
* }
|
|
145
|
+
* ]
|
|
146
|
+
* }
|
|
147
|
+
* *\/
|
|
148
|
+
* ```
|
|
149
|
+
*
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export declare class ListContractualInvestmentAttestationsCommand extends ListContractualInvestmentAttestationsCommand_base {
|
|
153
|
+
/** @internal type navigation helper, not in runtime. */
|
|
154
|
+
protected static __types: {
|
|
155
|
+
api: {
|
|
156
|
+
input: ListContractualInvestmentAttestationsRequest;
|
|
157
|
+
output: ListContractualInvestmentAttestationsResponse;
|
|
158
|
+
};
|
|
159
|
+
sdk: {
|
|
160
|
+
input: ListContractualInvestmentAttestationsCommandInput;
|
|
161
|
+
output: ListContractualInvestmentAttestationsCommandOutput;
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListContractualInvestmentSummariesRequest, ListContractualInvestmentSummariesResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListContractualInvestmentSummariesCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListContractualInvestmentSummariesCommandInput extends ListContractualInvestmentSummariesRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListContractualInvestmentSummariesCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListContractualInvestmentSummariesCommandOutput extends ListContractualInvestmentSummariesResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListContractualInvestmentSummariesCommand_base: {
|
|
22
|
+
new (input: ListContractualInvestmentSummariesCommandInput): import("@smithy/core/client").CommandImpl<ListContractualInvestmentSummariesCommandInput, ListContractualInvestmentSummariesCommandOutput, import("..").BillingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListContractualInvestmentSummariesCommandInput): import("@smithy/core/client").CommandImpl<ListContractualInvestmentSummariesCommandInput, ListContractualInvestmentSummariesCommandOutput, import("..").BillingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Lists the investment summaries within a specific private pricing contract. This operation is read-only and paginated.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { BillingClient, ListContractualInvestmentSummariesCommand } from "@aws-sdk/client-billing"; // ES Modules import
|
|
32
|
+
* // const { BillingClient, ListContractualInvestmentSummariesCommand } = require("@aws-sdk/client-billing"); // CommonJS import
|
|
33
|
+
* // import type { BillingClientConfig } from "@aws-sdk/client-billing";
|
|
34
|
+
* const config = {}; // type is BillingClientConfig
|
|
35
|
+
* const client = new BillingClient(config);
|
|
36
|
+
* const input = { // ListContractualInvestmentSummariesRequest
|
|
37
|
+
* contractArn: "STRING_VALUE", // required
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListContractualInvestmentSummariesCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListContractualInvestmentSummariesResponse
|
|
44
|
+
* // items: [ // InvestmentSummaries // required
|
|
45
|
+
* // { // InvestmentSummary
|
|
46
|
+
* // investmentSummaryId: "STRING_VALUE", // required
|
|
47
|
+
* // investmentName: "STRING_VALUE", // required
|
|
48
|
+
* // investmentType: "MILESTONE_BASED" || "OUTCOME_BASED", // required
|
|
49
|
+
* // maxAllowedInvestmentDisbursementValue: { // Amount
|
|
50
|
+
* // currencyCode: "STRING_VALUE", // required
|
|
51
|
+
* // currencyAmount: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // nextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListContractualInvestmentSummariesCommandInput - {@link ListContractualInvestmentSummariesCommandInput}
|
|
61
|
+
* @returns {@link ListContractualInvestmentSummariesCommandOutput}
|
|
62
|
+
* @see {@link ListContractualInvestmentSummariesCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListContractualInvestmentSummariesCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link BillingClientResolvedConfig | config} for BillingClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>The request processing failed because of an unknown error, exception, or failure. </p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p> The specified ARN in the request doesn't exist. </p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
+
* <p>The request was denied due to request throttling. </p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ValidationException} (client fault)
|
|
79
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service. </p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link BillingServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from Billing service.</p>
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @example Invoke ListContractualInvestmentSummaries
|
|
86
|
+
* ```javascript
|
|
87
|
+
* //
|
|
88
|
+
* const input = {
|
|
89
|
+
* contractArn: "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
90
|
+
* maxResults: 100
|
|
91
|
+
* };
|
|
92
|
+
* const command = new ListContractualInvestmentSummariesCommand(input);
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response is
|
|
95
|
+
* {
|
|
96
|
+
* items: [
|
|
97
|
+
* {
|
|
98
|
+
* investmentName: "Example Investment Name",
|
|
99
|
+
* investmentSummaryId: "Example-Investment-Summary-Id",
|
|
100
|
+
* investmentType: "OUTCOME_BASED",
|
|
101
|
+
* maxAllowedInvestmentDisbursementValue: {
|
|
102
|
+
* currencyAmount: "100000000.00",
|
|
103
|
+
* currencyCode: "USD"
|
|
104
|
+
* }
|
|
105
|
+
* }
|
|
106
|
+
* ]
|
|
107
|
+
* }
|
|
108
|
+
* *\/
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export declare class ListContractualInvestmentSummariesCommand extends ListContractualInvestmentSummariesCommand_base {
|
|
114
|
+
/** @internal type navigation helper, not in runtime. */
|
|
115
|
+
protected static __types: {
|
|
116
|
+
api: {
|
|
117
|
+
input: ListContractualInvestmentSummariesRequest;
|
|
118
|
+
output: ListContractualInvestmentSummariesResponse;
|
|
119
|
+
};
|
|
120
|
+
sdk: {
|
|
121
|
+
input: ListContractualInvestmentSummariesCommandInput;
|
|
122
|
+
output: ListContractualInvestmentSummariesCommandOutput;
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
}
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListContractualInvestmentsRequest, ListContractualInvestmentsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListContractualInvestmentsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListContractualInvestmentsCommandInput extends ListContractualInvestmentsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListContractualInvestmentsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListContractualInvestmentsCommandOutput extends ListContractualInvestmentsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListContractualInvestmentsCommand_base: {
|
|
22
|
+
new (input: ListContractualInvestmentsCommandInput): import("@smithy/core/client").CommandImpl<ListContractualInvestmentsCommandInput, ListContractualInvestmentsCommandOutput, import("..").BillingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListContractualInvestmentsCommandInput): import("@smithy/core/client").CommandImpl<ListContractualInvestmentsCommandInput, ListContractualInvestmentsCommandOutput, import("..").BillingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Lists the investments within a specific investment summary. This operation is read-only and paginated.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { BillingClient, ListContractualInvestmentsCommand } from "@aws-sdk/client-billing"; // ES Modules import
|
|
32
|
+
* // const { BillingClient, ListContractualInvestmentsCommand } = require("@aws-sdk/client-billing"); // CommonJS import
|
|
33
|
+
* // import type { BillingClientConfig } from "@aws-sdk/client-billing";
|
|
34
|
+
* const config = {}; // type is BillingClientConfig
|
|
35
|
+
* const client = new BillingClient(config);
|
|
36
|
+
* const input = { // ListContractualInvestmentsRequest
|
|
37
|
+
* contractArn: "STRING_VALUE", // required
|
|
38
|
+
* investmentSummaryId: "STRING_VALUE", // required
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListContractualInvestmentsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListContractualInvestmentsResponse
|
|
45
|
+
* // items: [ // Investments // required
|
|
46
|
+
* // { // Investment Union: only one key present
|
|
47
|
+
* // milestoneBasedInvestment: { // MilestoneBasedInvestment
|
|
48
|
+
* // investmentId: "STRING_VALUE", // required
|
|
49
|
+
* // investmentValue: { // Amount
|
|
50
|
+
* // currencyCode: "STRING_VALUE", // required
|
|
51
|
+
* // currencyAmount: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // investmentDisbursedAt: new Date("TIMESTAMP"), // required
|
|
54
|
+
* // },
|
|
55
|
+
* // outcomeBasedInvestment: { // OutcomeBasedInvestment
|
|
56
|
+
* // investmentId: "STRING_VALUE", // required
|
|
57
|
+
* // outcomeDescription: "STRING_VALUE", // required
|
|
58
|
+
* // attestationWindow: { // Interval
|
|
59
|
+
* // startDateInclusive: new Date("TIMESTAMP"), // required
|
|
60
|
+
* // endDateInclusive: new Date("TIMESTAMP"), // required
|
|
61
|
+
* // },
|
|
62
|
+
* // investmentRestrictions: [ // InvestmentRestrictions
|
|
63
|
+
* // { // InvestmentRestriction
|
|
64
|
+
* // amount: {
|
|
65
|
+
* // currencyCode: "STRING_VALUE", // required
|
|
66
|
+
* // currencyAmount: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // investmentMultipliers: [ // InvestmentMultipliers
|
|
71
|
+
* // { // InvestmentMultiplier
|
|
72
|
+
* // value: "STRING_VALUE", // required
|
|
73
|
+
* // investmentAttestationInputUnit: "STRING_VALUE", // required
|
|
74
|
+
* // multiplierType: "PERCENTAGE" || "CURRENCY_AMOUNT", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // disbursedValue: {
|
|
78
|
+
* // currencyCode: "STRING_VALUE", // required
|
|
79
|
+
* // currencyAmount: "STRING_VALUE", // required
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // nextToken: "STRING_VALUE",
|
|
85
|
+
* // };
|
|
86
|
+
*
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
* @param ListContractualInvestmentsCommandInput - {@link ListContractualInvestmentsCommandInput}
|
|
90
|
+
* @returns {@link ListContractualInvestmentsCommandOutput}
|
|
91
|
+
* @see {@link ListContractualInvestmentsCommandInput} for command's `input` shape.
|
|
92
|
+
* @see {@link ListContractualInvestmentsCommandOutput} for command's `response` shape.
|
|
93
|
+
* @see {@link BillingClientResolvedConfig | config} for BillingClient's `config` shape.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
96
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InternalServerException} (server fault)
|
|
99
|
+
* <p>The request processing failed because of an unknown error, exception, or failure. </p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
102
|
+
* <p> The specified ARN in the request doesn't exist. </p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
105
|
+
* <p>The request was denied due to request throttling. </p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ValidationException} (client fault)
|
|
108
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service. </p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link BillingServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from Billing service.</p>
|
|
112
|
+
*
|
|
113
|
+
*
|
|
114
|
+
* @example Invoke ListContractualInvestments
|
|
115
|
+
* ```javascript
|
|
116
|
+
* //
|
|
117
|
+
* const input = {
|
|
118
|
+
* contractArn: "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333",
|
|
119
|
+
* investmentSummaryId: "Example-Investment-Summary-Id",
|
|
120
|
+
* maxResults: 100
|
|
121
|
+
* };
|
|
122
|
+
* const command = new ListContractualInvestmentsCommand(input);
|
|
123
|
+
* const response = await client.send(command);
|
|
124
|
+
* /* response is
|
|
125
|
+
* {
|
|
126
|
+
* items: [
|
|
127
|
+
* {
|
|
128
|
+
* outcomeBasedInvestment: {
|
|
129
|
+
* attestationWindow: {
|
|
130
|
+
* endDateInclusive: 1222222222,
|
|
131
|
+
* startDateInclusive: 1111111111
|
|
132
|
+
* },
|
|
133
|
+
* disbursedValue: {
|
|
134
|
+
* currencyAmount: "0.00",
|
|
135
|
+
* currencyCode: "USD"
|
|
136
|
+
* },
|
|
137
|
+
* investmentId: "Investment-Id",
|
|
138
|
+
* investmentRestrictions: [
|
|
139
|
+
* {
|
|
140
|
+
* amount: {
|
|
141
|
+
* currencyAmount: "50000.00",
|
|
142
|
+
* currencyCode: "USD"
|
|
143
|
+
* }
|
|
144
|
+
* }
|
|
145
|
+
* ],
|
|
146
|
+
* outcomeDescription: "Example outcome description"
|
|
147
|
+
* }
|
|
148
|
+
* }
|
|
149
|
+
* ]
|
|
150
|
+
* }
|
|
151
|
+
* *\/
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
export declare class ListContractualInvestmentsCommand extends ListContractualInvestmentsCommand_base {
|
|
157
|
+
/** @internal type navigation helper, not in runtime. */
|
|
158
|
+
protected static __types: {
|
|
159
|
+
api: {
|
|
160
|
+
input: ListContractualInvestmentsRequest;
|
|
161
|
+
output: ListContractualInvestmentsResponse;
|
|
162
|
+
};
|
|
163
|
+
sdk: {
|
|
164
|
+
input: ListContractualInvestmentsCommandInput;
|
|
165
|
+
output: ListContractualInvestmentsCommandOutput;
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
}
|
|
@@ -1,9 +1,14 @@
|
|
|
1
|
+
export * from "./AssociateContractCommand";
|
|
1
2
|
export * from "./AssociateSourceViewsCommand";
|
|
3
|
+
export * from "./CancelContractualInvestmentAttestationCommand";
|
|
2
4
|
export * from "./CreateBillingViewCommand";
|
|
5
|
+
export * from "./CreateContractualInvestmentAttestationCommand";
|
|
3
6
|
export * from "./DeleteBillingViewCommand";
|
|
7
|
+
export * from "./DisassociateContractCommand";
|
|
4
8
|
export * from "./DisassociateSourceViewsCommand";
|
|
5
9
|
export * from "./GetBillingPreferencesCommand";
|
|
6
10
|
export * from "./GetBillingViewCommand";
|
|
11
|
+
export * from "./GetContractInformationCommand";
|
|
7
12
|
export * from "./GetCreditAllocationHistoryCommand";
|
|
8
13
|
export * from "./GetCreditsCommand";
|
|
9
14
|
export * from "./GetEnterpriseSupportChargeSummaryCommand";
|
|
@@ -13,6 +18,10 @@ export * from "./ListBillingViewSegmentsCommand";
|
|
|
13
18
|
export * from "./ListBillingViewsCommand";
|
|
14
19
|
export * from "./ListBusinessSupportAccountChargesCommand";
|
|
15
20
|
export * from "./ListBusinessSupportSubscriptionHistoryCommand";
|
|
21
|
+
export * from "./ListContractsCommand";
|
|
22
|
+
export * from "./ListContractualInvestmentAttestationsCommand";
|
|
23
|
+
export * from "./ListContractualInvestmentSummariesCommand";
|
|
24
|
+
export * from "./ListContractualInvestmentsCommand";
|
|
16
25
|
export * from "./ListEnterpriseSupportLinkedAccountChargesCommand";
|
|
17
26
|
export * from "./ListSourceViewsForBillingViewCommand";
|
|
18
27
|
export * from "./ListTagsForResourceCommand";
|
|
@@ -24,6 +24,18 @@ export declare const ValidationExceptionReason: {
|
|
|
24
24
|
* @public
|
|
25
25
|
*/
|
|
26
26
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
* @enum
|
|
30
|
+
*/
|
|
31
|
+
export declare const AssociationStatus: {
|
|
32
|
+
readonly ASSOCIATED: "ASSOCIATED";
|
|
33
|
+
readonly NOT_ASSOCIATED: "NOT_ASSOCIATED";
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
export type AssociationStatus = (typeof AssociationStatus)[keyof typeof AssociationStatus];
|
|
27
39
|
/**
|
|
28
40
|
* @public
|
|
29
41
|
* @enum
|
|
@@ -122,6 +134,17 @@ export declare const BillingViewStatusReason: {
|
|
|
122
134
|
* @public
|
|
123
135
|
*/
|
|
124
136
|
export type BillingViewStatusReason = (typeof BillingViewStatusReason)[keyof typeof BillingViewStatusReason];
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
* @enum
|
|
140
|
+
*/
|
|
141
|
+
export declare const ContractRestriction: {
|
|
142
|
+
readonly ATTESTATION_SELF_SERVICE_BLOCKED: "ATTESTATION_SELF_SERVICE_BLOCKED";
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
export type ContractRestriction = (typeof ContractRestriction)[keyof typeof ContractRestriction];
|
|
125
148
|
/**
|
|
126
149
|
* @public
|
|
127
150
|
* @enum
|
|
@@ -171,3 +194,56 @@ export declare const BillingDomain: {
|
|
|
171
194
|
* @public
|
|
172
195
|
*/
|
|
173
196
|
export type BillingDomain = (typeof BillingDomain)[keyof typeof BillingDomain];
|
|
197
|
+
/**
|
|
198
|
+
* @public
|
|
199
|
+
* @enum
|
|
200
|
+
*/
|
|
201
|
+
export declare const ContractType: {
|
|
202
|
+
readonly CROSS_SERVICE: "Cross-Service";
|
|
203
|
+
readonly OTHER: "Other";
|
|
204
|
+
readonly SERVICE_SPECIFIC: "Service-Specific";
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
export type ContractType = (typeof ContractType)[keyof typeof ContractType];
|
|
210
|
+
/**
|
|
211
|
+
* @public
|
|
212
|
+
* @enum
|
|
213
|
+
*/
|
|
214
|
+
export declare const InvestmentAttestationStatus: {
|
|
215
|
+
readonly CANCELLED: "CANCELLED";
|
|
216
|
+
readonly DISBURSED: "DISBURSED";
|
|
217
|
+
readonly PENDING_CANCELLATION: "PENDING_CANCELLATION";
|
|
218
|
+
readonly PENDING_C_LEVEL_APPROVAL: "PENDING_C_LEVEL_APPROVAL";
|
|
219
|
+
readonly PENDING_REVIEW: "PENDING_REVIEW";
|
|
220
|
+
readonly REJECTED: "REJECTED";
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
export type InvestmentAttestationStatus = (typeof InvestmentAttestationStatus)[keyof typeof InvestmentAttestationStatus];
|
|
226
|
+
/**
|
|
227
|
+
* @public
|
|
228
|
+
* @enum
|
|
229
|
+
*/
|
|
230
|
+
export declare const MultiplierType: {
|
|
231
|
+
readonly CURRENCY_AMOUNT: "CURRENCY_AMOUNT";
|
|
232
|
+
readonly PERCENTAGE: "PERCENTAGE";
|
|
233
|
+
};
|
|
234
|
+
/**
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
export type MultiplierType = (typeof MultiplierType)[keyof typeof MultiplierType];
|
|
238
|
+
/**
|
|
239
|
+
* @public
|
|
240
|
+
* @enum
|
|
241
|
+
*/
|
|
242
|
+
export declare const InvestmentType: {
|
|
243
|
+
readonly MILESTONE_BASED: "MILESTONE_BASED";
|
|
244
|
+
readonly OUTCOME_BASED: "OUTCOME_BASED";
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
export type InvestmentType = (typeof InvestmentType)[keyof typeof InvestmentType];
|