@aws-sdk/client-redshift-serverless 3.787.0 → 3.796.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 +40 -0
- package/dist-cjs/index.js +271 -0
- package/dist-es/RedshiftServerless.js +10 -0
- package/dist-es/commands/CreateReservationCommand.js +22 -0
- package/dist-es/commands/GetReservationCommand.js +22 -0
- package/dist-es/commands/GetReservationOfferingCommand.js +22 -0
- package/dist-es/commands/ListReservationOfferingsCommand.js +22 -0
- package/dist-es/commands/ListReservationsCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/pagination/ListReservationOfferingsPaginator.js +4 -0
- package/dist-es/pagination/ListReservationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +167 -0
- package/dist-types/RedshiftServerless.d.ts +37 -0
- package/dist-types/RedshiftServerlessClient.d.ts +7 -2
- package/dist-types/commands/ConvertRecoveryPointToSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateReservationCommand.d.ts +111 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/GetReservationCommand.d.ts +100 -0
- package/dist-types/commands/GetReservationOfferingCommand.d.ts +91 -0
- package/dist-types/commands/ListReservationOfferingsCommand.d.ts +92 -0
- package/dist-types/commands/ListReservationsCommand.d.ts +100 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +250 -2
- package/dist-types/pagination/ListReservationOfferingsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListReservationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
- package/dist-types/ts3.4/RedshiftServerless.d.ts +87 -0
- package/dist-types/ts3.4/RedshiftServerlessClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateReservationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetReservationCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetReservationOfferingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListReservationOfferingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListReservationsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +58 -0
- package/dist-types/ts3.4/pagination/ListReservationOfferingsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListReservationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
- package/package.json +8 -6
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetReservationRequest, GetReservationResponse } from "../models/models_0";
|
|
4
|
+
import { RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetReservationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetReservationCommandInput extends GetReservationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetReservationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetReservationCommandOutput extends GetReservationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetReservationCommand_base: {
|
|
25
|
+
new (input: GetReservationCommandInput): import("@smithy/smithy-client").CommandImpl<GetReservationCommandInput, GetReservationCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetReservationCommandInput): import("@smithy/smithy-client").CommandImpl<GetReservationCommandInput, GetReservationCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs)
|
|
31
|
+
* for a year at a discount from Serverless on-demand (OD) rates.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { RedshiftServerlessClient, GetReservationCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
|
|
36
|
+
* // const { RedshiftServerlessClient, GetReservationCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
|
|
37
|
+
* const client = new RedshiftServerlessClient(config);
|
|
38
|
+
* const input = { // GetReservationRequest
|
|
39
|
+
* reservationId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetReservationCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetReservationResponse
|
|
44
|
+
* // reservation: { // Reservation
|
|
45
|
+
* // reservationId: "STRING_VALUE",
|
|
46
|
+
* // reservationArn: "STRING_VALUE",
|
|
47
|
+
* // startDate: new Date("TIMESTAMP"),
|
|
48
|
+
* // endDate: new Date("TIMESTAMP"),
|
|
49
|
+
* // capacity: Number("int"),
|
|
50
|
+
* // offering: { // ReservationOffering
|
|
51
|
+
* // offeringId: "STRING_VALUE",
|
|
52
|
+
* // duration: Number("int"),
|
|
53
|
+
* // upfrontCharge: Number("double"),
|
|
54
|
+
* // hourlyCharge: Number("double"),
|
|
55
|
+
* // currencyCode: "STRING_VALUE",
|
|
56
|
+
* // offeringType: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // status: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param GetReservationCommandInput - {@link GetReservationCommandInput}
|
|
65
|
+
* @returns {@link GetReservationCommandOutput}
|
|
66
|
+
* @see {@link GetReservationCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link GetReservationCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The resource could not be found.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>The input failed to satisfy the constraints specified by an AWS service.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link RedshiftServerlessServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from RedshiftServerless service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class GetReservationCommand extends GetReservationCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: GetReservationRequest;
|
|
93
|
+
output: GetReservationResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: GetReservationCommandInput;
|
|
97
|
+
output: GetReservationCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetReservationOfferingRequest, GetReservationOfferingResponse } from "../models/models_0";
|
|
4
|
+
import { RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetReservationOfferingCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetReservationOfferingCommandInput extends GetReservationOfferingRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetReservationOfferingCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetReservationOfferingCommandOutput extends GetReservationOfferingResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetReservationOfferingCommand_base: {
|
|
25
|
+
new (input: GetReservationOfferingCommandInput): import("@smithy/smithy-client").CommandImpl<GetReservationOfferingCommandInput, GetReservationOfferingCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetReservationOfferingCommandInput): import("@smithy/smithy-client").CommandImpl<GetReservationOfferingCommandInput, GetReservationOfferingCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns the reservation offering. The offering determines the payment schedule for the reservation.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { RedshiftServerlessClient, GetReservationOfferingCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
|
|
35
|
+
* // const { RedshiftServerlessClient, GetReservationOfferingCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
|
|
36
|
+
* const client = new RedshiftServerlessClient(config);
|
|
37
|
+
* const input = { // GetReservationOfferingRequest
|
|
38
|
+
* offeringId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetReservationOfferingCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetReservationOfferingResponse
|
|
43
|
+
* // reservationOffering: { // ReservationOffering
|
|
44
|
+
* // offeringId: "STRING_VALUE",
|
|
45
|
+
* // duration: Number("int"),
|
|
46
|
+
* // upfrontCharge: Number("double"),
|
|
47
|
+
* // hourlyCharge: Number("double"),
|
|
48
|
+
* // currencyCode: "STRING_VALUE",
|
|
49
|
+
* // offeringType: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetReservationOfferingCommandInput - {@link GetReservationOfferingCommandInput}
|
|
56
|
+
* @returns {@link GetReservationOfferingCommandOutput}
|
|
57
|
+
* @see {@link GetReservationOfferingCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetReservationOfferingCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerException} (server fault)
|
|
62
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>The resource could not be found.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
68
|
+
* <p>The request was denied due to request throttling.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ValidationException} (client fault)
|
|
71
|
+
* <p>The input failed to satisfy the constraints specified by an AWS service.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link RedshiftServerlessServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from RedshiftServerless service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class GetReservationOfferingCommand extends GetReservationOfferingCommand_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: GetReservationOfferingRequest;
|
|
84
|
+
output: GetReservationOfferingResponse;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: GetReservationOfferingCommandInput;
|
|
88
|
+
output: GetReservationOfferingCommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListReservationOfferingsRequest, ListReservationOfferingsResponse } from "../models/models_0";
|
|
4
|
+
import { RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListReservationOfferingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListReservationOfferingsCommandInput extends ListReservationOfferingsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListReservationOfferingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListReservationOfferingsCommandOutput extends ListReservationOfferingsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListReservationOfferingsCommand_base: {
|
|
25
|
+
new (input: ListReservationOfferingsCommandInput): import("@smithy/smithy-client").CommandImpl<ListReservationOfferingsCommandInput, ListReservationOfferingsCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListReservationOfferingsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListReservationOfferingsCommandInput, ListReservationOfferingsCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns the current reservation offerings in your account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { RedshiftServerlessClient, ListReservationOfferingsCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
|
|
35
|
+
* // const { RedshiftServerlessClient, ListReservationOfferingsCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
|
|
36
|
+
* const client = new RedshiftServerlessClient(config);
|
|
37
|
+
* const input = { // ListReservationOfferingsRequest
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListReservationOfferingsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListReservationOfferingsResponse
|
|
44
|
+
* // reservationOfferingsList: [ // ReservationOfferingsList // required
|
|
45
|
+
* // { // ReservationOffering
|
|
46
|
+
* // offeringId: "STRING_VALUE",
|
|
47
|
+
* // duration: Number("int"),
|
|
48
|
+
* // upfrontCharge: Number("double"),
|
|
49
|
+
* // hourlyCharge: Number("double"),
|
|
50
|
+
* // currencyCode: "STRING_VALUE",
|
|
51
|
+
* // offeringType: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListReservationOfferingsCommandInput - {@link ListReservationOfferingsCommandInput}
|
|
60
|
+
* @returns {@link ListReservationOfferingsCommandOutput}
|
|
61
|
+
* @see {@link ListReservationOfferingsCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListReservationOfferingsCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>The request was denied due to request throttling.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p>The input failed to satisfy the constraints specified by an AWS service.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link RedshiftServerlessServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from RedshiftServerless service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class ListReservationOfferingsCommand extends ListReservationOfferingsCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: ListReservationOfferingsRequest;
|
|
85
|
+
output: ListReservationOfferingsResponse;
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: ListReservationOfferingsCommandInput;
|
|
89
|
+
output: ListReservationOfferingsCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListReservationsRequest, ListReservationsResponse } from "../models/models_0";
|
|
4
|
+
import { RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftServerlessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListReservationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListReservationsCommandInput extends ListReservationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListReservationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListReservationsCommandOutput extends ListReservationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListReservationsCommand_base: {
|
|
25
|
+
new (input: ListReservationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListReservationsCommandInput, ListReservationsCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListReservationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListReservationsCommandInput, ListReservationsCommandOutput, RedshiftServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of Reservation objects.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { RedshiftServerlessClient, ListReservationsCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
|
|
35
|
+
* // const { RedshiftServerlessClient, ListReservationsCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
|
|
36
|
+
* const client = new RedshiftServerlessClient(config);
|
|
37
|
+
* const input = { // ListReservationsRequest
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListReservationsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListReservationsResponse
|
|
44
|
+
* // reservationsList: [ // ReservationsList // required
|
|
45
|
+
* // { // Reservation
|
|
46
|
+
* // reservationId: "STRING_VALUE",
|
|
47
|
+
* // reservationArn: "STRING_VALUE",
|
|
48
|
+
* // startDate: new Date("TIMESTAMP"),
|
|
49
|
+
* // endDate: new Date("TIMESTAMP"),
|
|
50
|
+
* // capacity: Number("int"),
|
|
51
|
+
* // offering: { // ReservationOffering
|
|
52
|
+
* // offeringId: "STRING_VALUE",
|
|
53
|
+
* // duration: Number("int"),
|
|
54
|
+
* // upfrontCharge: Number("double"),
|
|
55
|
+
* // hourlyCharge: Number("double"),
|
|
56
|
+
* // currencyCode: "STRING_VALUE",
|
|
57
|
+
* // offeringType: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // status: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // nextToken: "STRING_VALUE",
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param ListReservationsCommandInput - {@link ListReservationsCommandInput}
|
|
68
|
+
* @returns {@link ListReservationsCommandOutput}
|
|
69
|
+
* @see {@link ListReservationsCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link ListReservationsCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalServerException} (server fault)
|
|
74
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>The input failed to satisfy the constraints specified by an AWS service.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link RedshiftServerlessServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from RedshiftServerless service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class ListReservationsCommand extends ListReservationsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: ListReservationsRequest;
|
|
93
|
+
output: ListReservationsResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: ListReservationsCommandInput;
|
|
97
|
+
output: ListReservationsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -2,6 +2,7 @@ export * from "./ConvertRecoveryPointToSnapshotCommand";
|
|
|
2
2
|
export * from "./CreateCustomDomainAssociationCommand";
|
|
3
3
|
export * from "./CreateEndpointAccessCommand";
|
|
4
4
|
export * from "./CreateNamespaceCommand";
|
|
5
|
+
export * from "./CreateReservationCommand";
|
|
5
6
|
export * from "./CreateScheduledActionCommand";
|
|
6
7
|
export * from "./CreateSnapshotCommand";
|
|
7
8
|
export * from "./CreateSnapshotCopyConfigurationCommand";
|
|
@@ -21,6 +22,8 @@ export * from "./GetCustomDomainAssociationCommand";
|
|
|
21
22
|
export * from "./GetEndpointAccessCommand";
|
|
22
23
|
export * from "./GetNamespaceCommand";
|
|
23
24
|
export * from "./GetRecoveryPointCommand";
|
|
25
|
+
export * from "./GetReservationCommand";
|
|
26
|
+
export * from "./GetReservationOfferingCommand";
|
|
24
27
|
export * from "./GetResourcePolicyCommand";
|
|
25
28
|
export * from "./GetScheduledActionCommand";
|
|
26
29
|
export * from "./GetSnapshotCommand";
|
|
@@ -33,6 +36,8 @@ export * from "./ListEndpointAccessCommand";
|
|
|
33
36
|
export * from "./ListManagedWorkgroupsCommand";
|
|
34
37
|
export * from "./ListNamespacesCommand";
|
|
35
38
|
export * from "./ListRecoveryPointsCommand";
|
|
39
|
+
export * from "./ListReservationOfferingsCommand";
|
|
40
|
+
export * from "./ListReservationsCommand";
|
|
36
41
|
export * from "./ListScheduledActionsCommand";
|
|
37
42
|
export * from "./ListSnapshotCopyConfigurationsCommand";
|
|
38
43
|
export * from "./ListSnapshotsCommand";
|
|
@@ -739,6 +739,153 @@ export interface CreateNamespaceResponse {
|
|
|
739
739
|
*/
|
|
740
740
|
namespace?: Namespace | undefined;
|
|
741
741
|
}
|
|
742
|
+
/**
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
export interface CreateReservationRequest {
|
|
746
|
+
/**
|
|
747
|
+
* <p>The number of Redshift Processing Units (RPUs) to reserve.</p>
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
capacity: number | undefined;
|
|
751
|
+
/**
|
|
752
|
+
* <p>The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.</p>
|
|
753
|
+
* @public
|
|
754
|
+
*/
|
|
755
|
+
offeringId: string | undefined;
|
|
756
|
+
/**
|
|
757
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services
|
|
758
|
+
* SDK populates this field. This token must be a valid UUIDv4 value. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">
|
|
759
|
+
* Making retries safe with idempotent APIs
|
|
760
|
+
* </a>.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
clientToken?: string | undefined;
|
|
764
|
+
}
|
|
765
|
+
/**
|
|
766
|
+
* @public
|
|
767
|
+
* @enum
|
|
768
|
+
*/
|
|
769
|
+
export declare const OfferingType: {
|
|
770
|
+
readonly ALL_UPFRONT: "ALL_UPFRONT";
|
|
771
|
+
readonly NO_UPFRONT: "NO_UPFRONT";
|
|
772
|
+
};
|
|
773
|
+
/**
|
|
774
|
+
* @public
|
|
775
|
+
*/
|
|
776
|
+
export type OfferingType = (typeof OfferingType)[keyof typeof OfferingType];
|
|
777
|
+
/**
|
|
778
|
+
* <p>The class of offering for the reservation. The offering class determines the payment
|
|
779
|
+
* schedule for the reservation.</p>
|
|
780
|
+
* @public
|
|
781
|
+
*/
|
|
782
|
+
export interface ReservationOffering {
|
|
783
|
+
/**
|
|
784
|
+
* <p>The offering identifier.</p>
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
offeringId?: string | undefined;
|
|
788
|
+
/**
|
|
789
|
+
* <p>The duration, in seconds, for which the reservation reserves the RPUs.</p>
|
|
790
|
+
* @public
|
|
791
|
+
*/
|
|
792
|
+
duration?: number | undefined;
|
|
793
|
+
/**
|
|
794
|
+
* <p>The up-front price you are charged for the reservation.</p>
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
upfrontCharge?: number | undefined;
|
|
798
|
+
/**
|
|
799
|
+
* <p>The rate you are charged for each hour the reservation is active.</p>
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
hourlyCharge?: number | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* <p>The currency code for the offering.</p>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
currencyCode?: string | undefined;
|
|
808
|
+
/**
|
|
809
|
+
* <p>Determines the payment schedule for the reservation.</p>
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
812
|
+
offeringType?: OfferingType | undefined;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* <p>Represents an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs)
|
|
816
|
+
* for a year at a discount from Serverless on-demand (OD) rates.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
export interface Reservation {
|
|
820
|
+
/**
|
|
821
|
+
* <p>The identifier that uniquely identifies the serverless reservation.</p>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
reservationId?: string | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.</p>
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
reservationArn?: string | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <p>The start date for the serverless reservation. This is the date you specified for the reservation to start when
|
|
832
|
+
* you created the reservation.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
startDate?: Date | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* <p>The end date for the serverless reservation. This date is one year after the start date that you specify.</p>
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
endDate?: Date | undefined;
|
|
841
|
+
/**
|
|
842
|
+
* <p>The number of Redshift Processing Units (RPUs) to reserve.</p>
|
|
843
|
+
* @public
|
|
844
|
+
*/
|
|
845
|
+
capacity?: number | undefined;
|
|
846
|
+
/**
|
|
847
|
+
* <p>The type of offering for the reservation. The offering class determines the payment schedule for the reservation.</p>
|
|
848
|
+
* @public
|
|
849
|
+
*/
|
|
850
|
+
offering?: ReservationOffering | undefined;
|
|
851
|
+
/**
|
|
852
|
+
* <p>The status of the reservation. Possible values include the following:</p>
|
|
853
|
+
* <ul>
|
|
854
|
+
* <li>
|
|
855
|
+
* <p>
|
|
856
|
+
* <code>payment-pending</code>
|
|
857
|
+
* </p>
|
|
858
|
+
* </li>
|
|
859
|
+
* <li>
|
|
860
|
+
* <p>
|
|
861
|
+
* <code>active</code>
|
|
862
|
+
* </p>
|
|
863
|
+
* </li>
|
|
864
|
+
* <li>
|
|
865
|
+
* <p>
|
|
866
|
+
* <code>payment-failed</code>
|
|
867
|
+
* </p>
|
|
868
|
+
* </li>
|
|
869
|
+
* <li>
|
|
870
|
+
* <p>
|
|
871
|
+
* <code>retired</code>
|
|
872
|
+
* </p>
|
|
873
|
+
* </li>
|
|
874
|
+
* </ul>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
status?: string | undefined;
|
|
878
|
+
}
|
|
879
|
+
/**
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
export interface CreateReservationResponse {
|
|
883
|
+
/**
|
|
884
|
+
* <p>The reservation object that the <code>CreateReservation</code> action created.</p>
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
reservation?: Reservation | undefined;
|
|
888
|
+
}
|
|
742
889
|
/**
|
|
743
890
|
* <p>The schedule of when Amazon Redshift Serverless should run the scheduled action.</p>
|
|
744
891
|
* @public
|
|
@@ -2026,6 +2173,46 @@ export interface GetRecoveryPointResponse {
|
|
|
2026
2173
|
*/
|
|
2027
2174
|
recoveryPoint?: RecoveryPoint | undefined;
|
|
2028
2175
|
}
|
|
2176
|
+
/**
|
|
2177
|
+
* @public
|
|
2178
|
+
*/
|
|
2179
|
+
export interface GetReservationRequest {
|
|
2180
|
+
/**
|
|
2181
|
+
* <p>The ID of the reservation to retrieve.</p>
|
|
2182
|
+
* @public
|
|
2183
|
+
*/
|
|
2184
|
+
reservationId: string | undefined;
|
|
2185
|
+
}
|
|
2186
|
+
/**
|
|
2187
|
+
* @public
|
|
2188
|
+
*/
|
|
2189
|
+
export interface GetReservationResponse {
|
|
2190
|
+
/**
|
|
2191
|
+
* <p>The returned reservation object.</p>
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
reservation: Reservation | undefined;
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* @public
|
|
2198
|
+
*/
|
|
2199
|
+
export interface GetReservationOfferingRequest {
|
|
2200
|
+
/**
|
|
2201
|
+
* <p>The identifier for the offering..</p>
|
|
2202
|
+
* @public
|
|
2203
|
+
*/
|
|
2204
|
+
offeringId: string | undefined;
|
|
2205
|
+
}
|
|
2206
|
+
/**
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
export interface GetReservationOfferingResponse {
|
|
2210
|
+
/**
|
|
2211
|
+
* <p>The returned reservation offering. The offering determines the payment schedule for the reservation.</p>
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
reservationOffering: ReservationOffering | undefined;
|
|
2215
|
+
}
|
|
2029
2216
|
/**
|
|
2030
2217
|
* @public
|
|
2031
2218
|
*/
|
|
@@ -2556,6 +2743,66 @@ export interface ListRecoveryPointsResponse {
|
|
|
2556
2743
|
*/
|
|
2557
2744
|
nextToken?: string | undefined;
|
|
2558
2745
|
}
|
|
2746
|
+
/**
|
|
2747
|
+
* @public
|
|
2748
|
+
*/
|
|
2749
|
+
export interface ListReservationOfferingsRequest {
|
|
2750
|
+
/**
|
|
2751
|
+
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
nextToken?: string | undefined;
|
|
2755
|
+
/**
|
|
2756
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
|
|
2757
|
+
* @public
|
|
2758
|
+
*/
|
|
2759
|
+
maxResults?: number | undefined;
|
|
2760
|
+
}
|
|
2761
|
+
/**
|
|
2762
|
+
* @public
|
|
2763
|
+
*/
|
|
2764
|
+
export interface ListReservationOfferingsResponse {
|
|
2765
|
+
/**
|
|
2766
|
+
* <p>The returned list of reservation offerings.</p>
|
|
2767
|
+
* @public
|
|
2768
|
+
*/
|
|
2769
|
+
reservationOfferingsList: ReservationOffering[] | undefined;
|
|
2770
|
+
/**
|
|
2771
|
+
* <p>The token to use when requesting the next set of items.</p>
|
|
2772
|
+
* @public
|
|
2773
|
+
*/
|
|
2774
|
+
nextToken?: string | undefined;
|
|
2775
|
+
}
|
|
2776
|
+
/**
|
|
2777
|
+
* @public
|
|
2778
|
+
*/
|
|
2779
|
+
export interface ListReservationsRequest {
|
|
2780
|
+
/**
|
|
2781
|
+
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
2782
|
+
* @public
|
|
2783
|
+
*/
|
|
2784
|
+
nextToken?: string | undefined;
|
|
2785
|
+
/**
|
|
2786
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
|
|
2787
|
+
* @public
|
|
2788
|
+
*/
|
|
2789
|
+
maxResults?: number | undefined;
|
|
2790
|
+
}
|
|
2791
|
+
/**
|
|
2792
|
+
* @public
|
|
2793
|
+
*/
|
|
2794
|
+
export interface ListReservationsResponse {
|
|
2795
|
+
/**
|
|
2796
|
+
* <p>The serverless reservations returned by the request.</p>
|
|
2797
|
+
* @public
|
|
2798
|
+
*/
|
|
2799
|
+
reservationsList: Reservation[] | undefined;
|
|
2800
|
+
/**
|
|
2801
|
+
* <p>The token to use when requesting the next set of items.</p>
|
|
2802
|
+
* @public
|
|
2803
|
+
*/
|
|
2804
|
+
nextToken?: string | undefined;
|
|
2805
|
+
}
|
|
2559
2806
|
/**
|
|
2560
2807
|
* @public
|
|
2561
2808
|
*/
|
|
@@ -3184,8 +3431,9 @@ export interface RestoreFromSnapshotRequest {
|
|
|
3184
3431
|
*/
|
|
3185
3432
|
snapshotName?: string | undefined;
|
|
3186
3433
|
/**
|
|
3187
|
-
* <p>The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring
|
|
3188
|
-
*
|
|
3434
|
+
* <p>The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring
|
|
3435
|
+
* from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as
|
|
3436
|
+
* <code>snapshotName</code>.</p>
|
|
3189
3437
|
* <p>The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.</p>
|
|
3190
3438
|
* @public
|
|
3191
3439
|
*/
|