@aws-sdk/client-redshift-serverless 3.533.0 → 3.540.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/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/RedshiftServerless.d.ts +13 -1
- package/dist-types/RedshiftServerlessClient.d.ts +1 -1
- package/dist-types/commands/ConvertRecoveryPointToSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/CreateCustomDomainAssociationCommand.d.ts +2 -1
- package/dist-types/commands/CreateEndpointAccessCommand.d.ts +2 -1
- package/dist-types/commands/CreateNamespaceCommand.d.ts +2 -1
- package/dist-types/commands/CreateScheduledActionCommand.d.ts +2 -1
- package/dist-types/commands/CreateSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/CreateSnapshotCopyConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/CreateUsageLimitCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkgroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCustomDomainAssociationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEndpointAccessCommand.d.ts +2 -1
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteScheduledActionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSnapshotCopyConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUsageLimitCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkgroupCommand.d.ts +2 -1
- package/dist-types/commands/GetCredentialsCommand.d.ts +2 -1
- package/dist-types/commands/GetCustomDomainAssociationCommand.d.ts +2 -1
- package/dist-types/commands/GetEndpointAccessCommand.d.ts +2 -1
- package/dist-types/commands/GetNamespaceCommand.d.ts +2 -1
- package/dist-types/commands/GetRecoveryPointCommand.d.ts +2 -1
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetScheduledActionCommand.d.ts +2 -1
- package/dist-types/commands/GetSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/GetTableRestoreStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetUsageLimitCommand.d.ts +2 -1
- package/dist-types/commands/GetWorkgroupCommand.d.ts +2 -1
- package/dist-types/commands/ListCustomDomainAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListEndpointAccessCommand.d.ts +2 -1
- package/dist-types/commands/ListNamespacesCommand.d.ts +2 -1
- package/dist-types/commands/ListRecoveryPointsCommand.d.ts +2 -1
- package/dist-types/commands/ListScheduledActionsCommand.d.ts +2 -1
- package/dist-types/commands/ListSnapshotCopyConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListSnapshotsCommand.d.ts +2 -1
- package/dist-types/commands/ListTableRestoreStatusCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListUsageLimitsCommand.d.ts +2 -1
- package/dist-types/commands/ListWorkgroupsCommand.d.ts +2 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/RestoreFromRecoveryPointCommand.d.ts +2 -1
- package/dist-types/commands/RestoreFromSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/RestoreTableFromRecoveryPointCommand.d.ts +2 -1
- package/dist-types/commands/RestoreTableFromSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCustomDomainAssociationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEndpointAccessCommand.d.ts +2 -1
- package/dist-types/commands/UpdateNamespaceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateScheduledActionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSnapshotCopyConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUsageLimitCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkgroupCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +451 -451
- package/dist-types/ts3.4/RedshiftServerless.d.ts +12 -0
- package/dist-types/ts3.4/commands/ConvertRecoveryPointToSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCustomDomainAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateEndpointAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateNamespaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateScheduledActionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSnapshotCopyConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUsageLimitCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkgroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCustomDomainAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteEndpointAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteNamespaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteScheduledActionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSnapshotCopyConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteUsageLimitCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWorkgroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCredentialsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCustomDomainAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetEndpointAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetNamespaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRecoveryPointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetScheduledActionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTableRestoreStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetUsageLimitCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetWorkgroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCustomDomainAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEndpointAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRecoveryPointsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListScheduledActionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSnapshotCopyConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSnapshotsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTableRestoreStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListUsageLimitsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListWorkgroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreFromRecoveryPointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreFromSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreTableFromRecoveryPointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreTableFromSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCustomDomainAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateEndpointAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateNamespaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateScheduledActionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSnapshotCopyConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUsageLimitCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkgroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { RedshiftServerlessServiceException as __BaseException } from "./RedshiftServerlessServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -14,54 +14,54 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @public
|
|
18
17
|
* <p>An object that represents the custom domain name association.</p>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
export interface Association {
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
23
|
+
* @public
|
|
24
24
|
*/
|
|
25
25
|
customDomainCertificateArn?: string;
|
|
26
26
|
/**
|
|
27
|
-
* @public
|
|
28
27
|
* <p>The expiration time for the certificate.</p>
|
|
28
|
+
* @public
|
|
29
29
|
*/
|
|
30
30
|
customDomainCertificateExpiryTime?: Date;
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
customDomainName?: string;
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>The name of the workgroup associated with the database.</p>
|
|
38
|
+
* @public
|
|
39
39
|
*/
|
|
40
40
|
workgroupName?: string;
|
|
41
41
|
}
|
|
42
42
|
/**
|
|
43
|
-
* @public
|
|
44
43
|
* <p>An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
export interface ConfigParameter {
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>The key of the parameter. The
|
|
50
49
|
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitive_identifier</code>, <code>enable_user_activity_logging</code>,
|
|
51
50
|
* <code>query_group</code>, <code>search_path</code>, <code>require_ssl</code>, and query monitoring metrics that let
|
|
52
51
|
* you define performance boundaries. For more information about query monitoring rules and available metrics, see
|
|
53
52
|
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless">Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
parameterKey?: string;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The value of the parameter to set.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
parameterValue?: string;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>The submitted action has conflicts.</p>
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
export declare class ConflictException extends __BaseException {
|
|
67
67
|
readonly name: "ConflictException";
|
|
@@ -72,18 +72,18 @@ export declare class ConflictException extends __BaseException {
|
|
|
72
72
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* @public
|
|
76
75
|
* <p>A map of key-value pairs.</p>
|
|
76
|
+
* @public
|
|
77
77
|
*/
|
|
78
78
|
export interface Tag {
|
|
79
79
|
/**
|
|
80
|
-
* @public
|
|
81
80
|
* <p>The key to use in the tag.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
key: string | undefined;
|
|
84
84
|
/**
|
|
85
|
-
* @public
|
|
86
85
|
* <p>The value of the tag.</p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
value: string | undefined;
|
|
89
89
|
}
|
|
@@ -92,24 +92,24 @@ export interface Tag {
|
|
|
92
92
|
*/
|
|
93
93
|
export interface ConvertRecoveryPointToSnapshotRequest {
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>The unique identifier of the recovery point.</p>
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
recoveryPointId: string | undefined;
|
|
99
99
|
/**
|
|
100
|
-
* @public
|
|
101
100
|
* <p>The name of the snapshot.</p>
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
snapshotName: string | undefined;
|
|
104
104
|
/**
|
|
105
|
-
* @public
|
|
106
105
|
* <p>How long to retain the snapshot.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
retentionPeriod?: number;
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>An array of <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html">Tag objects</a>
|
|
112
111
|
* to associate with the created snapshot.</p>
|
|
112
|
+
* @public
|
|
113
113
|
*/
|
|
114
114
|
tags?: Tag[];
|
|
115
115
|
}
|
|
@@ -130,119 +130,119 @@ export declare const SnapshotStatus: {
|
|
|
130
130
|
*/
|
|
131
131
|
export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus];
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>A snapshot object that contains databases.</p>
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
export interface Snapshot {
|
|
137
137
|
/**
|
|
138
|
-
* @public
|
|
139
138
|
* <p>The name of the namepsace.</p>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
namespaceName?: string;
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>The Amazon Resource Name (ARN) of the namespace the snapshot was created from.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
namespaceArn?: string;
|
|
147
147
|
/**
|
|
148
|
-
* @public
|
|
149
148
|
* <p>The name of the snapshot.</p>
|
|
149
|
+
* @public
|
|
150
150
|
*/
|
|
151
151
|
snapshotName?: string;
|
|
152
152
|
/**
|
|
153
|
-
* @public
|
|
154
153
|
* <p>The timestamp of when the snapshot was created.</p>
|
|
154
|
+
* @public
|
|
155
155
|
*/
|
|
156
156
|
snapshotCreateTime?: Date;
|
|
157
157
|
/**
|
|
158
|
-
* @public
|
|
159
158
|
* <p>The username of the database within a snapshot.</p>
|
|
159
|
+
* @public
|
|
160
160
|
*/
|
|
161
161
|
adminUsername?: string;
|
|
162
162
|
/**
|
|
163
|
-
* @public
|
|
164
163
|
* <p>The status of the snapshot.</p>
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
status?: SnapshotStatus;
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p>The unique identifier of the KMS key used to encrypt the snapshot.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
kmsKeyId?: string;
|
|
172
172
|
/**
|
|
173
|
-
* @public
|
|
174
173
|
* <p>The owner Amazon Web Services; account of the snapshot.</p>
|
|
174
|
+
* @public
|
|
175
175
|
*/
|
|
176
176
|
ownerAccount?: string;
|
|
177
177
|
/**
|
|
178
|
-
* @public
|
|
179
178
|
* <p>The total size, in megabytes, of how big the snapshot is.</p>
|
|
179
|
+
* @public
|
|
180
180
|
*/
|
|
181
181
|
totalBackupSizeInMegaBytes?: number;
|
|
182
182
|
/**
|
|
183
|
-
* @public
|
|
184
183
|
* <p>The size of the incremental backup in megabytes.</p>
|
|
184
|
+
* @public
|
|
185
185
|
*/
|
|
186
186
|
actualIncrementalBackupSizeInMegaBytes?: number;
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>The size in megabytes of the data that has been backed up to a snapshot.</p>
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
backupProgressInMegaBytes?: number;
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>The rate at which data is backed up into a snapshot in megabytes per second.</p>
|
|
194
|
+
* @public
|
|
195
195
|
*/
|
|
196
196
|
currentBackupRateInMegaBytesPerSecond?: number;
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p>The estimated amount of seconds until the snapshot completes backup.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
estimatedSecondsToCompletion?: number;
|
|
202
202
|
/**
|
|
203
|
-
* @public
|
|
204
203
|
* <p>The amount of time it took to back up data into a snapshot.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
elapsedTimeInSeconds?: number;
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>The period of time, in days, of how long the snapshot is retained.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
snapshotRetentionPeriod?: number;
|
|
212
212
|
/**
|
|
213
|
-
* @public
|
|
214
213
|
* <p>The amount of days until the snapshot is deleted.</p>
|
|
214
|
+
* @public
|
|
215
215
|
*/
|
|
216
216
|
snapshotRemainingDays?: number;
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>The timestamp of when data within the snapshot started getting retained.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
snapshotRetentionStartTime?: Date;
|
|
222
222
|
/**
|
|
223
|
-
* @public
|
|
224
223
|
* <p>The Amazon Resource Name (ARN) of the snapshot.</p>
|
|
224
|
+
* @public
|
|
225
225
|
*/
|
|
226
226
|
snapshotArn?: string;
|
|
227
227
|
/**
|
|
228
|
-
* @public
|
|
229
228
|
* <p>All of the Amazon Web Services accounts that have access to
|
|
230
229
|
* restore a snapshot to a namespace.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
accountsWithRestoreAccess?: string[];
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <p>All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.</p>
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
accountsWithProvisionedRestoreAccess?: string[];
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.</p>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
adminPasswordSecretArn?: string;
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
adminPasswordSecretKmsKeyId?: string;
|
|
248
248
|
}
|
|
@@ -251,14 +251,14 @@ export interface Snapshot {
|
|
|
251
251
|
*/
|
|
252
252
|
export interface ConvertRecoveryPointToSnapshotResponse {
|
|
253
253
|
/**
|
|
254
|
-
* @public
|
|
255
254
|
* <p>The snapshot converted from the recovery point.</p>
|
|
255
|
+
* @public
|
|
256
256
|
*/
|
|
257
257
|
snapshot?: Snapshot;
|
|
258
258
|
}
|
|
259
259
|
/**
|
|
260
|
-
* @public
|
|
261
260
|
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
261
|
+
* @public
|
|
262
262
|
*/
|
|
263
263
|
export declare class InternalServerException extends __BaseException {
|
|
264
264
|
readonly name: "InternalServerException";
|
|
@@ -270,15 +270,15 @@ export declare class InternalServerException extends __BaseException {
|
|
|
270
270
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
271
271
|
}
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The resource could not be found.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
277
277
|
readonly name: "ResourceNotFoundException";
|
|
278
278
|
readonly $fault: "client";
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>The name of the resource that could not be found.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
resourceName?: string;
|
|
284
284
|
/**
|
|
@@ -287,8 +287,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
287
287
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
288
288
|
}
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <p>The service limit was exceeded.</p>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
294
294
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -299,15 +299,15 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
299
299
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
300
300
|
}
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>The request exceeded the number of tags allowed for a resource.</p>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
export declare class TooManyTagsException extends __BaseException {
|
|
306
306
|
readonly name: "TooManyTagsException";
|
|
307
307
|
readonly $fault: "client";
|
|
308
308
|
/**
|
|
309
|
-
* @public
|
|
310
309
|
* <p>The name of the resource that exceeded the number of tags allowed for a resource.</p>
|
|
310
|
+
* @public
|
|
311
311
|
*/
|
|
312
312
|
resourceName?: string;
|
|
313
313
|
/**
|
|
@@ -316,8 +316,8 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
316
316
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
317
317
|
}
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <p>The input failed to satisfy the constraints specified by an AWS service.</p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
export declare class ValidationException extends __BaseException {
|
|
323
323
|
readonly name: "ValidationException";
|
|
@@ -332,18 +332,18 @@ export declare class ValidationException extends __BaseException {
|
|
|
332
332
|
*/
|
|
333
333
|
export interface CreateCustomDomainAssociationRequest {
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>The name of the workgroup associated with the database.</p>
|
|
336
|
+
* @public
|
|
337
337
|
*/
|
|
338
338
|
workgroupName: string | undefined;
|
|
339
339
|
/**
|
|
340
|
-
* @public
|
|
341
340
|
* <p>The custom domain name to associate with the workgroup.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
customDomainName: string | undefined;
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
346
|
+
* @public
|
|
347
347
|
*/
|
|
348
348
|
customDomainCertificateArn: string | undefined;
|
|
349
349
|
}
|
|
@@ -352,29 +352,29 @@ export interface CreateCustomDomainAssociationRequest {
|
|
|
352
352
|
*/
|
|
353
353
|
export interface CreateCustomDomainAssociationResponse {
|
|
354
354
|
/**
|
|
355
|
-
* @public
|
|
356
355
|
* <p>The custom domain name to associate with the workgroup.</p>
|
|
356
|
+
* @public
|
|
357
357
|
*/
|
|
358
358
|
customDomainName?: string;
|
|
359
359
|
/**
|
|
360
|
-
* @public
|
|
361
360
|
* <p>The name of the workgroup associated with the database.</p>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
workgroupName?: string;
|
|
364
364
|
/**
|
|
365
|
-
* @public
|
|
366
365
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
customDomainCertificateArn?: string;
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>The expiration time for the certificate.</p>
|
|
371
|
+
* @public
|
|
372
372
|
*/
|
|
373
373
|
customDomainCertificateExpiryTime?: Date;
|
|
374
374
|
}
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>The request was denied due to request throttling.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
export declare class ThrottlingException extends __BaseException {
|
|
380
380
|
readonly name: "ThrottlingException";
|
|
@@ -391,154 +391,154 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
391
391
|
*/
|
|
392
392
|
export interface CreateEndpointAccessRequest {
|
|
393
393
|
/**
|
|
394
|
-
* @public
|
|
395
394
|
* <p>The name of the VPC endpoint. An endpoint name must contain 1-30 characters.
|
|
396
395
|
* Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter.
|
|
397
396
|
* The name can't contain two consecutive hyphens or end with a hyphen.</p>
|
|
397
|
+
* @public
|
|
398
398
|
*/
|
|
399
399
|
endpointName: string | undefined;
|
|
400
400
|
/**
|
|
401
|
-
* @public
|
|
402
401
|
* <p>The unique identifers of subnets from which
|
|
403
402
|
* Amazon Redshift Serverless chooses one to deploy a VPC endpoint.</p>
|
|
403
|
+
* @public
|
|
404
404
|
*/
|
|
405
405
|
subnetIds: string[] | undefined;
|
|
406
406
|
/**
|
|
407
|
-
* @public
|
|
408
407
|
* <p>The name of the workgroup to associate with the VPC endpoint.</p>
|
|
408
|
+
* @public
|
|
409
409
|
*/
|
|
410
410
|
workgroupName: string | undefined;
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p>The unique identifiers of the security group that defines the ports,
|
|
414
413
|
* protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>
|
|
414
|
+
* @public
|
|
415
415
|
*/
|
|
416
416
|
vpcSecurityGroupIds?: string[];
|
|
417
417
|
/**
|
|
418
|
-
* @public
|
|
419
418
|
* <p>The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.</p>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
ownerAccount?: string;
|
|
422
422
|
}
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>Contains information about a network interface
|
|
426
425
|
* in an Amazon Redshift Serverless managed VPC endpoint.
|
|
427
426
|
* </p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
export interface NetworkInterface {
|
|
430
430
|
/**
|
|
431
|
-
* @public
|
|
432
431
|
* <p>The unique identifier of the network interface.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
networkInterfaceId?: string;
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p>The unique identifier of the subnet.</p>
|
|
437
|
+
* @public
|
|
438
438
|
*/
|
|
439
439
|
subnetId?: string;
|
|
440
440
|
/**
|
|
441
|
-
* @public
|
|
442
441
|
* <p>The IPv4 address of the network interface within the subnet.</p>
|
|
442
|
+
* @public
|
|
443
443
|
*/
|
|
444
444
|
privateIpAddress?: string;
|
|
445
445
|
/**
|
|
446
|
-
* @public
|
|
447
446
|
* <p>The availability Zone.</p>
|
|
447
|
+
* @public
|
|
448
448
|
*/
|
|
449
449
|
availabilityZone?: string;
|
|
450
450
|
}
|
|
451
451
|
/**
|
|
452
|
-
* @public
|
|
453
452
|
* <p>The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.</p>
|
|
453
|
+
* @public
|
|
454
454
|
*/
|
|
455
455
|
export interface VpcEndpoint {
|
|
456
456
|
/**
|
|
457
|
-
* @public
|
|
458
457
|
* <p>The connection endpoint ID for connecting to Amazon Redshift Serverless.</p>
|
|
458
|
+
* @public
|
|
459
459
|
*/
|
|
460
460
|
vpcEndpointId?: string;
|
|
461
461
|
/**
|
|
462
|
-
* @public
|
|
463
462
|
* <p>The VPC identifier that the endpoint is associated with.</p>
|
|
463
|
+
* @public
|
|
464
464
|
*/
|
|
465
465
|
vpcId?: string;
|
|
466
466
|
/**
|
|
467
|
-
* @public
|
|
468
467
|
* <p>One or more network interfaces of the endpoint. Also known as an interface endpoint.</p>
|
|
468
|
+
* @public
|
|
469
469
|
*/
|
|
470
470
|
networkInterfaces?: NetworkInterface[];
|
|
471
471
|
}
|
|
472
472
|
/**
|
|
473
|
-
* @public
|
|
474
473
|
* <p>Describes the members of a VPC security group.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
export interface VpcSecurityGroupMembership {
|
|
477
477
|
/**
|
|
478
|
-
* @public
|
|
479
478
|
* <p>The unique identifier of the VPC security group.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
vpcSecurityGroupId?: string;
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>The status of the VPC security group.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
status?: string;
|
|
487
487
|
}
|
|
488
488
|
/**
|
|
489
|
-
* @public
|
|
490
489
|
* <p>Information about an Amazon Redshift Serverless VPC endpoint.</p>
|
|
490
|
+
* @public
|
|
491
491
|
*/
|
|
492
492
|
export interface EndpointAccess {
|
|
493
493
|
/**
|
|
494
|
-
* @public
|
|
495
494
|
* <p>The name of the VPC endpoint.</p>
|
|
495
|
+
* @public
|
|
496
496
|
*/
|
|
497
497
|
endpointName?: string;
|
|
498
498
|
/**
|
|
499
|
-
* @public
|
|
500
499
|
* <p>The status of the VPC endpoint.</p>
|
|
500
|
+
* @public
|
|
501
501
|
*/
|
|
502
502
|
endpointStatus?: string;
|
|
503
503
|
/**
|
|
504
|
-
* @public
|
|
505
504
|
* <p>The name of the workgroup associated with the endpoint.</p>
|
|
505
|
+
* @public
|
|
506
506
|
*/
|
|
507
507
|
workgroupName?: string;
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>The time that the endpoint was created.</p>
|
|
510
|
+
* @public
|
|
511
511
|
*/
|
|
512
512
|
endpointCreateTime?: Date;
|
|
513
513
|
/**
|
|
514
|
-
* @public
|
|
515
514
|
* <p>The port number on which Amazon Redshift Serverless accepts incoming connections.</p>
|
|
515
|
+
* @public
|
|
516
516
|
*/
|
|
517
517
|
port?: number;
|
|
518
518
|
/**
|
|
519
|
-
* @public
|
|
520
519
|
* <p>The DNS address of the endpoint.</p>
|
|
520
|
+
* @public
|
|
521
521
|
*/
|
|
522
522
|
address?: string;
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>The unique identifier of subnets
|
|
526
525
|
* where Amazon Redshift Serverless choose to deploy the VPC endpoint.</p>
|
|
526
|
+
* @public
|
|
527
527
|
*/
|
|
528
528
|
subnetIds?: string[];
|
|
529
529
|
/**
|
|
530
|
-
* @public
|
|
531
530
|
* <p>The security groups associated with the endpoint.</p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
vpcSecurityGroups?: VpcSecurityGroupMembership[];
|
|
534
534
|
/**
|
|
535
|
-
* @public
|
|
536
535
|
* <p>The connection endpoint for connecting to Amazon Redshift Serverless.</p>
|
|
536
|
+
* @public
|
|
537
537
|
*/
|
|
538
538
|
vpcEndpoint?: VpcEndpoint;
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* <p>The Amazon Resource Name (ARN) of the VPC endpoint.</p>
|
|
541
|
+
* @public
|
|
542
542
|
*/
|
|
543
543
|
endpointArn?: string;
|
|
544
544
|
}
|
|
@@ -547,8 +547,8 @@ export interface EndpointAccess {
|
|
|
547
547
|
*/
|
|
548
548
|
export interface CreateEndpointAccessResponse {
|
|
549
549
|
/**
|
|
550
|
-
* @public
|
|
551
550
|
* <p>The created VPC endpoint.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
endpoint?: EndpointAccess;
|
|
554
554
|
}
|
|
@@ -570,70 +570,70 @@ export type LogExport = (typeof LogExport)[keyof typeof LogExport];
|
|
|
570
570
|
*/
|
|
571
571
|
export interface CreateNamespaceRequest {
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>The name of the namespace.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
namespaceName: string | undefined;
|
|
577
577
|
/**
|
|
578
|
-
* @public
|
|
579
578
|
* <p>The username of the administrator for the first database created in the namespace.</p>
|
|
579
|
+
* @public
|
|
580
580
|
*/
|
|
581
581
|
adminUsername?: string;
|
|
582
582
|
/**
|
|
583
|
-
* @public
|
|
584
583
|
* <p>The password of the administrator for the first database created in the namespace.</p>
|
|
585
584
|
* <p>You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true. </p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
adminUserPassword?: string;
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* <p>The name of the first database created in the namespace.</p>
|
|
590
|
+
* @public
|
|
591
591
|
*/
|
|
592
592
|
dbName?: string;
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>The ID of the Amazon Web Services Key Management Service key used to encrypt your data.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
kmsKeyId?: string;
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.</p>
|
|
600
|
+
* @public
|
|
601
601
|
*/
|
|
602
602
|
defaultIamRoleArn?: string;
|
|
603
603
|
/**
|
|
604
|
-
* @public
|
|
605
604
|
* <p>A list of IAM roles to associate with the namespace.</p>
|
|
605
|
+
* @public
|
|
606
606
|
*/
|
|
607
607
|
iamRoles?: string[];
|
|
608
608
|
/**
|
|
609
|
-
* @public
|
|
610
609
|
* <p>The types of logs the namespace can export.
|
|
611
610
|
* Available export types are <code>userlog</code>, <code>connectionlog</code>, and <code>useractivitylog</code>.</p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
logExports?: LogExport[];
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>A list of tag instances.</p>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
tags?: Tag[];
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>If <code>true</code>, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials.
|
|
622
621
|
* You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true.
|
|
623
622
|
* If <code>manageAdminPassword</code> is false or not set, Amazon Redshift uses
|
|
624
623
|
* <code>adminUserPassword</code> for the admin user account's password.
|
|
625
624
|
* </p>
|
|
625
|
+
* @public
|
|
626
626
|
*/
|
|
627
627
|
manageAdminPassword?: boolean;
|
|
628
628
|
/**
|
|
629
|
-
* @public
|
|
630
629
|
* <p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
|
|
631
630
|
* You can only use this parameter if <code>manageAdminPassword</code> is true.</p>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
adminPasswordSecretKmsKeyId?: string;
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>The ARN for the Redshift application that integrates with IAM Identity Center.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
redshiftIdcApplicationArn?: string;
|
|
639
639
|
}
|
|
@@ -651,76 +651,76 @@ export declare const NamespaceStatus: {
|
|
|
651
651
|
*/
|
|
652
652
|
export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus];
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>A collection of database objects and users.</p>
|
|
655
|
+
* @public
|
|
656
656
|
*/
|
|
657
657
|
export interface Namespace {
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <p>The Amazon Resource Name (ARN) associated with a namespace.</p>
|
|
660
|
+
* @public
|
|
661
661
|
*/
|
|
662
662
|
namespaceArn?: string;
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <p>The unique identifier of a namespace.</p>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
namespaceId?: string;
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <p>The name of the namespace.
|
|
671
670
|
* Must be between 3-64 alphanumeric characters in lowercase,
|
|
672
671
|
* and it cannot be a reserved word. A list of reserved words can be found
|
|
673
672
|
* in <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
namespaceName?: string;
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The username of the administrator for the first database created in the namespace.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
adminUsername?: string;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>The name of the first database created in the namespace.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
dbName?: string;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>The ID of the Amazon Web Services Key Management Service key used to encrypt your data.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
kmsKeyId?: string;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
defaultIamRoleArn?: string;
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>A list of IAM roles to associate with the namespace.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
iamRoles?: string[];
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
logExports?: LogExport[];
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>The status of the namespace.</p>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
status?: NamespaceStatus;
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* <p>The date of when the namespace was created.</p>
|
|
713
|
+
* @public
|
|
714
714
|
*/
|
|
715
715
|
creationDate?: Date;
|
|
716
716
|
/**
|
|
717
|
-
* @public
|
|
718
717
|
* <p>The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.</p>
|
|
718
|
+
* @public
|
|
719
719
|
*/
|
|
720
720
|
adminPasswordSecretArn?: string;
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
adminPasswordSecretKmsKeyId?: string;
|
|
726
726
|
}
|
|
@@ -729,14 +729,14 @@ export interface Namespace {
|
|
|
729
729
|
*/
|
|
730
730
|
export interface CreateNamespaceResponse {
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>The created namespace object.</p>
|
|
733
|
+
* @public
|
|
734
734
|
*/
|
|
735
735
|
namespace?: Namespace;
|
|
736
736
|
}
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>The schedule of when Amazon Redshift Serverless should run the scheduled action.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
export type Schedule = Schedule.AtMember | Schedule.CronMember | Schedule.$UnknownMember;
|
|
742
742
|
/**
|
|
@@ -744,8 +744,8 @@ export type Schedule = Schedule.AtMember | Schedule.CronMember | Schedule.$Unkno
|
|
|
744
744
|
*/
|
|
745
745
|
export declare namespace Schedule {
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
interface AtMember {
|
|
751
751
|
at: Date;
|
|
@@ -753,10 +753,10 @@ export declare namespace Schedule {
|
|
|
753
753
|
$unknown?: never;
|
|
754
754
|
}
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.</p>
|
|
758
757
|
* <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see
|
|
759
758
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>
|
|
759
|
+
* @public
|
|
760
760
|
*/
|
|
761
761
|
interface CronMember {
|
|
762
762
|
at?: never;
|
|
@@ -779,39 +779,39 @@ export declare namespace Schedule {
|
|
|
779
779
|
const visit: <T>(value: Schedule, visitor: Visitor<T>) => T;
|
|
780
780
|
}
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>The parameters that you can use to configure a <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html">scheduled action</a> to create a snapshot. For more information about creating a scheduled action, see
|
|
784
783
|
* <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html">CreateScheduledAction</a>.</p>
|
|
784
|
+
* @public
|
|
785
785
|
*/
|
|
786
786
|
export interface CreateSnapshotScheduleActionParameters {
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>The name of the namespace for which you want to configure a scheduled action to create a snapshot.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
namespaceName: string | undefined;
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>A string prefix that is attached to the name of the snapshot created by the scheduled action. The final
|
|
795
794
|
* name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
snapshotNamePrefix: string | undefined;
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>The retention period of the snapshot created by the scheduled action.</p>
|
|
800
|
+
* @public
|
|
801
801
|
*/
|
|
802
802
|
retentionPeriod?: number;
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>An array of <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html">Tag objects</a> to associate with the snapshot.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
tags?: Tag[];
|
|
808
808
|
}
|
|
809
809
|
/**
|
|
810
|
-
* @public
|
|
811
810
|
* <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
|
|
812
811
|
* <p>
|
|
813
812
|
* <code>"\{"CreateSnapshot": \{"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"\}\}"</code>
|
|
814
813
|
* </p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
export type TargetAction = TargetAction.CreateSnapshotMember | TargetAction.$UnknownMember;
|
|
817
817
|
/**
|
|
@@ -819,9 +819,9 @@ export type TargetAction = TargetAction.CreateSnapshotMember | TargetAction.$Unk
|
|
|
819
819
|
*/
|
|
820
820
|
export declare namespace TargetAction {
|
|
821
821
|
/**
|
|
822
|
-
* @public
|
|
823
822
|
* <p>The parameters that you can use to configure a <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html">scheduled action</a> to create a snapshot. For more information about creating a scheduled action, see
|
|
824
823
|
* <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html">CreateScheduledAction</a>.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
interface CreateSnapshotMember {
|
|
827
827
|
createSnapshot: CreateSnapshotScheduleActionParameters;
|
|
@@ -845,58 +845,58 @@ export declare namespace TargetAction {
|
|
|
845
845
|
*/
|
|
846
846
|
export interface CreateScheduledActionRequest {
|
|
847
847
|
/**
|
|
848
|
-
* @public
|
|
849
848
|
* <p>The name of the scheduled action.</p>
|
|
849
|
+
* @public
|
|
850
850
|
*/
|
|
851
851
|
scheduledActionName: string | undefined;
|
|
852
852
|
/**
|
|
853
|
-
* @public
|
|
854
853
|
* <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
|
|
855
854
|
* <p>
|
|
856
855
|
* <code>"\{"CreateSnapshot": \{"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"\}\}"</code>
|
|
857
856
|
* </p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
targetAction: TargetAction | undefined;
|
|
860
860
|
/**
|
|
861
|
-
* @public
|
|
862
861
|
* <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p>
|
|
863
862
|
* <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p>
|
|
864
863
|
* <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see
|
|
865
864
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
schedule: Schedule | undefined;
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action.
|
|
871
870
|
* This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.
|
|
872
871
|
* For more information about the IAM role to use with the Amazon Redshift scheduler, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for
|
|
873
872
|
* Amazon Redshift</a> in the Amazon Redshift Cluster Management Guide</p>
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
roleArn: string | undefined;
|
|
876
876
|
/**
|
|
877
|
-
* @public
|
|
878
877
|
* <p>The name of the namespace for which to create a scheduled action.</p>
|
|
878
|
+
* @public
|
|
879
879
|
*/
|
|
880
880
|
namespaceName: string | undefined;
|
|
881
881
|
/**
|
|
882
|
-
* @public
|
|
883
882
|
* <p>Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code>
|
|
884
883
|
* of the scheduled action, see <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
enabled?: boolean;
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The description of the scheduled action.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
scheduledActionDescription?: string;
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
startTime?: Date;
|
|
897
897
|
/**
|
|
898
|
-
* @public
|
|
899
898
|
* <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
endTime?: Date;
|
|
902
902
|
}
|
|
@@ -913,72 +913,72 @@ export declare const State: {
|
|
|
913
913
|
*/
|
|
914
914
|
export type State = (typeof State)[keyof typeof State];
|
|
915
915
|
/**
|
|
916
|
-
* @public
|
|
917
916
|
* <p>The returned scheduled action object.</p>
|
|
917
|
+
* @public
|
|
918
918
|
*/
|
|
919
919
|
export interface ScheduledActionResponse {
|
|
920
920
|
/**
|
|
921
|
-
* @public
|
|
922
921
|
* <p>The name of the scheduled action.</p>
|
|
922
|
+
* @public
|
|
923
923
|
*/
|
|
924
924
|
scheduledActionName?: string;
|
|
925
925
|
/**
|
|
926
|
-
* @public
|
|
927
926
|
* <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p>
|
|
928
927
|
* <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p>
|
|
929
928
|
* <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see
|
|
930
929
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
schedule?: Schedule;
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>The description of the scheduled action.</p>
|
|
935
|
+
* @public
|
|
936
936
|
*/
|
|
937
937
|
scheduledActionDescription?: string;
|
|
938
938
|
/**
|
|
939
|
-
* @public
|
|
940
939
|
* <p>An array of timestamps of when the next scheduled actions will trigger.</p>
|
|
940
|
+
* @public
|
|
941
941
|
*/
|
|
942
942
|
nextInvocations?: Date[];
|
|
943
943
|
/**
|
|
944
|
-
* @public
|
|
945
944
|
* <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action.
|
|
946
945
|
* This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.
|
|
947
946
|
* For more information about the IAM role to use with the Amazon Redshift scheduler, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for
|
|
948
947
|
* Amazon Redshift</a> in the Amazon Redshift Cluster Management Guide</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
roleArn?: string;
|
|
951
951
|
/**
|
|
952
|
-
* @public
|
|
953
952
|
* <p>The state of the scheduled action.</p>
|
|
953
|
+
* @public
|
|
954
954
|
*/
|
|
955
955
|
state?: State;
|
|
956
956
|
/**
|
|
957
|
-
* @public
|
|
958
957
|
* <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
startTime?: Date;
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The end time of </p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
endTime?: Date;
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
|
|
969
968
|
* <p>
|
|
970
969
|
* <code>"\{"CreateSnapshot": \{"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"\}\}"</code>
|
|
971
970
|
* </p>
|
|
971
|
+
* @public
|
|
972
972
|
*/
|
|
973
973
|
targetAction?: TargetAction;
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
namespaceName?: string;
|
|
979
979
|
/**
|
|
980
|
-
* @public
|
|
981
980
|
* <p>The uuid of the scheduled action.</p>
|
|
981
|
+
* @public
|
|
982
982
|
*/
|
|
983
983
|
scheduledActionUuid?: string;
|
|
984
984
|
}
|
|
@@ -987,8 +987,8 @@ export interface ScheduledActionResponse {
|
|
|
987
987
|
*/
|
|
988
988
|
export interface CreateScheduledActionResponse {
|
|
989
989
|
/**
|
|
990
|
-
* @public
|
|
991
990
|
* <p>The returned <code>ScheduledAction</code> object that describes the properties of a scheduled action.</p>
|
|
991
|
+
* @public
|
|
992
992
|
*/
|
|
993
993
|
scheduledAction?: ScheduledActionResponse;
|
|
994
994
|
}
|
|
@@ -997,23 +997,23 @@ export interface CreateScheduledActionResponse {
|
|
|
997
997
|
*/
|
|
998
998
|
export interface CreateSnapshotRequest {
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>The namespace to create a snapshot for.</p>
|
|
1001
|
+
* @public
|
|
1002
1002
|
*/
|
|
1003
1003
|
namespaceName: string | undefined;
|
|
1004
1004
|
/**
|
|
1005
|
-
* @public
|
|
1006
1005
|
* <p>The name of the snapshot.</p>
|
|
1006
|
+
* @public
|
|
1007
1007
|
*/
|
|
1008
1008
|
snapshotName: string | undefined;
|
|
1009
1009
|
/**
|
|
1010
|
-
* @public
|
|
1011
1010
|
* <p>How long to retain the created snapshot.</p>
|
|
1011
|
+
* @public
|
|
1012
1012
|
*/
|
|
1013
1013
|
retentionPeriod?: number;
|
|
1014
1014
|
/**
|
|
1015
|
-
* @public
|
|
1016
1015
|
* <p>An array of <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html">Tag objects</a> to associate with the snapshot.</p>
|
|
1016
|
+
* @public
|
|
1017
1017
|
*/
|
|
1018
1018
|
tags?: Tag[];
|
|
1019
1019
|
}
|
|
@@ -1022,8 +1022,8 @@ export interface CreateSnapshotRequest {
|
|
|
1022
1022
|
*/
|
|
1023
1023
|
export interface CreateSnapshotResponse {
|
|
1024
1024
|
/**
|
|
1025
|
-
* @public
|
|
1026
1025
|
* <p>The created snapshot object.</p>
|
|
1026
|
+
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
snapshot?: Snapshot;
|
|
1029
1029
|
}
|
|
@@ -1032,59 +1032,59 @@ export interface CreateSnapshotResponse {
|
|
|
1032
1032
|
*/
|
|
1033
1033
|
export interface CreateSnapshotCopyConfigurationRequest {
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <p>The name of the namespace to copy snapshots from.</p>
|
|
1036
|
+
* @public
|
|
1037
1037
|
*/
|
|
1038
1038
|
namespaceName: string | undefined;
|
|
1039
1039
|
/**
|
|
1040
|
-
* @public
|
|
1041
1040
|
* <p>The destination Amazon Web Services Region that you want to copy snapshots to.</p>
|
|
1041
|
+
* @public
|
|
1042
1042
|
*/
|
|
1043
1043
|
destinationRegion: string | undefined;
|
|
1044
1044
|
/**
|
|
1045
|
-
* @public
|
|
1046
1045
|
* <p>The retention period of the snapshots that you copy to the destination Amazon Web Services Region.</p>
|
|
1046
|
+
* @public
|
|
1047
1047
|
*/
|
|
1048
1048
|
snapshotRetentionPeriod?: number;
|
|
1049
1049
|
/**
|
|
1050
|
-
* @public
|
|
1051
1050
|
* <p>The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.</p>
|
|
1051
|
+
* @public
|
|
1052
1052
|
*/
|
|
1053
1053
|
destinationKmsKeyId?: string;
|
|
1054
1054
|
}
|
|
1055
1055
|
/**
|
|
1056
|
-
* @public
|
|
1057
1056
|
* <p>The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.</p>
|
|
1057
|
+
* @public
|
|
1058
1058
|
*/
|
|
1059
1059
|
export interface SnapshotCopyConfiguration {
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>The ID of the snapshot copy configuration object.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
snapshotCopyConfigurationId?: string;
|
|
1065
1065
|
/**
|
|
1066
|
-
* @public
|
|
1067
1066
|
* <p>The ARN of the snapshot copy configuration object.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
snapshotCopyConfigurationArn?: string;
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The name of the namespace to copy snapshots from in the source Amazon Web Services Region.</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
namespaceName?: string;
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>The destination Amazon Web Services Region to copy snapshots to.</p>
|
|
1077
|
+
* @public
|
|
1078
1078
|
*/
|
|
1079
1079
|
destinationRegion?: string;
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The retention period of snapshots that are copied to the destination Amazon Web Services Region.</p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
snapshotRetentionPeriod?: number;
|
|
1085
1085
|
/**
|
|
1086
|
-
* @public
|
|
1087
1086
|
* <p>The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.</p>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
destinationKmsKeyId?: string;
|
|
1090
1090
|
}
|
|
@@ -1093,8 +1093,8 @@ export interface SnapshotCopyConfiguration {
|
|
|
1093
1093
|
*/
|
|
1094
1094
|
export interface CreateSnapshotCopyConfigurationResponse {
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>The snapshot copy configuration object that is returned.</p>
|
|
1097
|
+
* @public
|
|
1098
1098
|
*/
|
|
1099
1099
|
snapshotCopyConfiguration: SnapshotCopyConfiguration | undefined;
|
|
1100
1100
|
}
|
|
@@ -1141,70 +1141,70 @@ export type UsageLimitUsageType = (typeof UsageLimitUsageType)[keyof typeof Usag
|
|
|
1141
1141
|
*/
|
|
1142
1142
|
export interface CreateUsageLimitRequest {
|
|
1143
1143
|
/**
|
|
1144
|
-
* @public
|
|
1145
1144
|
* <p>The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.</p>
|
|
1145
|
+
* @public
|
|
1146
1146
|
*/
|
|
1147
1147
|
resourceArn: string | undefined;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The type of Amazon Redshift Serverless usage to create a usage limit for.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
usageType: UsageLimitUsageType | undefined;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data
|
|
1156
1155
|
* transferred between Regions in cross-account sharing. The value must be a positive number.</p>
|
|
1156
|
+
* @public
|
|
1157
1157
|
*/
|
|
1158
1158
|
amount: number | undefined;
|
|
1159
1159
|
/**
|
|
1160
|
-
* @public
|
|
1161
1160
|
* <p>The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.</p>
|
|
1161
|
+
* @public
|
|
1162
1162
|
*/
|
|
1163
1163
|
period?: UsageLimitPeriod;
|
|
1164
1164
|
/**
|
|
1165
|
-
* @public
|
|
1166
1165
|
* <p>The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
breachAction?: UsageLimitBreachAction;
|
|
1169
1169
|
}
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>The usage limit object.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
export interface UsageLimit {
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The identifier of the usage limit.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
usageLimitId?: string;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The Amazon Resource Name (ARN) of the resource associated with the usage limit.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
usageLimitArn?: string;
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
resourceArn?: string;
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>The Amazon Redshift Serverless feature to limit.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
usageType?: UsageLimitUsageType;
|
|
1195
1195
|
/**
|
|
1196
|
-
* @public
|
|
1197
1196
|
* <p>The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
amount?: number;
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
period?: UsageLimitPeriod;
|
|
1205
1205
|
/**
|
|
1206
|
-
* @public
|
|
1207
1206
|
* <p>The action that Amazon Redshift Serverless takes when the limit is reached.</p>
|
|
1207
|
+
* @public
|
|
1208
1208
|
*/
|
|
1209
1209
|
breachAction?: UsageLimitBreachAction;
|
|
1210
1210
|
}
|
|
@@ -1213,8 +1213,8 @@ export interface UsageLimit {
|
|
|
1213
1213
|
*/
|
|
1214
1214
|
export interface CreateUsageLimitResponse {
|
|
1215
1215
|
/**
|
|
1216
|
-
* @public
|
|
1217
1216
|
* <p>The returned usage limit object.</p>
|
|
1217
|
+
* @public
|
|
1218
1218
|
*/
|
|
1219
1219
|
usageLimit?: UsageLimit;
|
|
1220
1220
|
}
|
|
@@ -1223,84 +1223,84 @@ export interface CreateUsageLimitResponse {
|
|
|
1223
1223
|
*/
|
|
1224
1224
|
export interface CreateWorkgroupRequest {
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>The name of the created workgroup.</p>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
workgroupName: string | undefined;
|
|
1230
1230
|
/**
|
|
1231
|
-
* @public
|
|
1232
1231
|
* <p>The name of the namespace to associate with the workgroup.</p>
|
|
1232
|
+
* @public
|
|
1233
1233
|
*/
|
|
1234
1234
|
namespaceName: string | undefined;
|
|
1235
1235
|
/**
|
|
1236
|
-
* @public
|
|
1237
1236
|
* <p>The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).</p>
|
|
1237
|
+
* @public
|
|
1238
1238
|
*/
|
|
1239
1239
|
baseCapacity?: number;
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>The value that specifies whether to turn on enhanced virtual
|
|
1243
1242
|
* private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
enhancedVpcRouting?: boolean;
|
|
1246
1246
|
/**
|
|
1247
|
-
* @public
|
|
1248
1247
|
* <p>An array of parameters to set for advanced control over a database. The
|
|
1249
1248
|
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitive_identifier</code>, <code>enable_user_activity_logging</code>,
|
|
1250
1249
|
* <code>query_group</code>, <code>search_path</code>, <code>require_ssl</code>, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see
|
|
1251
1250
|
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless">
|
|
1252
1251
|
* Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
|
|
1252
|
+
* @public
|
|
1253
1253
|
*/
|
|
1254
1254
|
configParameters?: ConfigParameter[];
|
|
1255
1255
|
/**
|
|
1256
|
-
* @public
|
|
1257
1256
|
* <p>An array of security group IDs to associate with the workgroup.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
securityGroupIds?: string[];
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>An array of VPC subnet IDs to associate with the workgroup.</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
subnetIds?: string[];
|
|
1265
1265
|
/**
|
|
1266
|
-
* @public
|
|
1267
1266
|
* <p>A value that specifies whether the workgroup can be accessed from a public network.</p>
|
|
1267
|
+
* @public
|
|
1268
1268
|
*/
|
|
1269
1269
|
publiclyAccessible?: boolean;
|
|
1270
1270
|
/**
|
|
1271
|
-
* @public
|
|
1272
1271
|
* <p>A array of tag instances.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
tags?: Tag[];
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.</p>
|
|
1277
|
+
* @public
|
|
1278
1278
|
*/
|
|
1279
1279
|
port?: number;
|
|
1280
1280
|
/**
|
|
1281
|
-
* @public
|
|
1282
1281
|
* <p>The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
maxCapacity?: number;
|
|
1285
1285
|
}
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The VPC endpoint object.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
export interface Endpoint {
|
|
1291
1291
|
/**
|
|
1292
|
-
* @public
|
|
1293
1292
|
* <p>The DNS address of the VPC endpoint.</p>
|
|
1293
|
+
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
address?: string;
|
|
1296
1296
|
/**
|
|
1297
|
-
* @public
|
|
1298
1297
|
* <p>The port that Amazon Redshift Serverless listens on.</p>
|
|
1298
|
+
* @public
|
|
1299
1299
|
*/
|
|
1300
1300
|
port?: number;
|
|
1301
1301
|
/**
|
|
1302
|
-
* @public
|
|
1303
1302
|
* <p>An array of <code>VpcEndpoint</code> objects.</p>
|
|
1303
|
+
* @public
|
|
1304
1304
|
*/
|
|
1305
1305
|
vpcEndpoints?: VpcEndpoint[];
|
|
1306
1306
|
}
|
|
@@ -1319,119 +1319,119 @@ export declare const WorkgroupStatus: {
|
|
|
1319
1319
|
*/
|
|
1320
1320
|
export type WorkgroupStatus = (typeof WorkgroupStatus)[keyof typeof WorkgroupStatus];
|
|
1321
1321
|
/**
|
|
1322
|
-
* @public
|
|
1323
1322
|
* <p>The collection of computing resources from which an endpoint is created.</p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
export interface Workgroup {
|
|
1326
1326
|
/**
|
|
1327
|
-
* @public
|
|
1328
1327
|
* <p>The unique identifier of the workgroup.</p>
|
|
1328
|
+
* @public
|
|
1329
1329
|
*/
|
|
1330
1330
|
workgroupId?: string;
|
|
1331
1331
|
/**
|
|
1332
|
-
* @public
|
|
1333
1332
|
* <p>The Amazon Resource Name (ARN) that links to the workgroup.</p>
|
|
1333
|
+
* @public
|
|
1334
1334
|
*/
|
|
1335
1335
|
workgroupArn?: string;
|
|
1336
1336
|
/**
|
|
1337
|
-
* @public
|
|
1338
1337
|
* <p>The name of the workgroup.</p>
|
|
1338
|
+
* @public
|
|
1339
1339
|
*/
|
|
1340
1340
|
workgroupName?: string;
|
|
1341
1341
|
/**
|
|
1342
|
-
* @public
|
|
1343
1342
|
* <p>The namespace the workgroup is associated with.</p>
|
|
1343
|
+
* @public
|
|
1344
1344
|
*/
|
|
1345
1345
|
namespaceName?: string;
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <p>The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
baseCapacity?: number;
|
|
1351
1351
|
/**
|
|
1352
|
-
* @public
|
|
1353
1352
|
* <p>The value that specifies whether to enable enhanced virtual
|
|
1354
1353
|
* private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
enhancedVpcRouting?: boolean;
|
|
1357
1357
|
/**
|
|
1358
|
-
* @public
|
|
1359
1358
|
* <p>An array of parameters to set for advanced control over a database. The
|
|
1360
1359
|
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitive_identifier</code>, <code>enable_user_activity_logging</code>,
|
|
1361
1360
|
* <code>query_group</code>, <code>search_path</code>, <code>require_ssl</code>, and query monitoring metrics that let you define performance boundaries.
|
|
1362
1361
|
* For more information about query monitoring rules and available metrics, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless"> Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
|
|
1362
|
+
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
configParameters?: ConfigParameter[];
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>An array of security group IDs to associate with the workgroup.</p>
|
|
1367
|
+
* @public
|
|
1368
1368
|
*/
|
|
1369
1369
|
securityGroupIds?: string[];
|
|
1370
1370
|
/**
|
|
1371
|
-
* @public
|
|
1372
1371
|
* <p>An array of subnet IDs the workgroup is associated with.</p>
|
|
1372
|
+
* @public
|
|
1373
1373
|
*/
|
|
1374
1374
|
subnetIds?: string[];
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>The status of the workgroup.</p>
|
|
1377
|
+
* @public
|
|
1378
1378
|
*/
|
|
1379
1379
|
status?: WorkgroupStatus;
|
|
1380
1380
|
/**
|
|
1381
|
-
* @public
|
|
1382
1381
|
* <p>The endpoint that is created from the workgroup.</p>
|
|
1382
|
+
* @public
|
|
1383
1383
|
*/
|
|
1384
1384
|
endpoint?: Endpoint;
|
|
1385
1385
|
/**
|
|
1386
|
-
* @public
|
|
1387
1386
|
* <p>A value that specifies whether the workgroup
|
|
1388
1387
|
* can be accessible from a public network</p>
|
|
1388
|
+
* @public
|
|
1389
1389
|
*/
|
|
1390
1390
|
publiclyAccessible?: boolean;
|
|
1391
1391
|
/**
|
|
1392
|
-
* @public
|
|
1393
1392
|
* <p>The creation date of the workgroup.</p>
|
|
1393
|
+
* @public
|
|
1394
1394
|
*/
|
|
1395
1395
|
creationDate?: Date;
|
|
1396
1396
|
/**
|
|
1397
|
-
* @public
|
|
1398
1397
|
* <p>The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.</p>
|
|
1398
|
+
* @public
|
|
1399
1399
|
*/
|
|
1400
1400
|
port?: number;
|
|
1401
1401
|
/**
|
|
1402
|
-
* @public
|
|
1403
1402
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
customDomainName?: string;
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
customDomainCertificateArn?: string;
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p>The expiration time for the certificate.</p>
|
|
1413
|
+
* @public
|
|
1414
1414
|
*/
|
|
1415
1415
|
customDomainCertificateExpiryTime?: Date;
|
|
1416
1416
|
/**
|
|
1417
|
-
* @public
|
|
1418
1417
|
* <p>The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see<a href="https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html">Cluster versions for Amazon Redshift</a>.</p>
|
|
1418
|
+
* @public
|
|
1419
1419
|
*/
|
|
1420
1420
|
workgroupVersion?: string;
|
|
1421
1421
|
/**
|
|
1422
|
-
* @public
|
|
1423
1422
|
* <p>The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see
|
|
1424
1423
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html">Cluster versions for Amazon Redshift</a>.</p>
|
|
1424
|
+
* @public
|
|
1425
1425
|
*/
|
|
1426
1426
|
patchVersion?: string;
|
|
1427
1427
|
/**
|
|
1428
|
-
* @public
|
|
1429
1428
|
* <p>The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.</p>
|
|
1429
|
+
* @public
|
|
1430
1430
|
*/
|
|
1431
1431
|
maxCapacity?: number;
|
|
1432
1432
|
/**
|
|
1433
|
-
* @public
|
|
1434
1433
|
* <p>A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.</p>
|
|
1434
|
+
* @public
|
|
1435
1435
|
*/
|
|
1436
1436
|
crossAccountVpcs?: string[];
|
|
1437
1437
|
}
|
|
@@ -1440,14 +1440,14 @@ export interface Workgroup {
|
|
|
1440
1440
|
*/
|
|
1441
1441
|
export interface CreateWorkgroupResponse {
|
|
1442
1442
|
/**
|
|
1443
|
-
* @public
|
|
1444
1443
|
* <p>The created workgroup object.</p>
|
|
1444
|
+
* @public
|
|
1445
1445
|
*/
|
|
1446
1446
|
workgroup?: Workgroup;
|
|
1447
1447
|
}
|
|
1448
1448
|
/**
|
|
1449
|
-
* @public
|
|
1450
1449
|
* <p>There is an insufficient capacity to perform the action.</p>
|
|
1450
|
+
* @public
|
|
1451
1451
|
*/
|
|
1452
1452
|
export declare class InsufficientCapacityException extends __BaseException {
|
|
1453
1453
|
readonly name: "InsufficientCapacityException";
|
|
@@ -1463,8 +1463,8 @@ export declare class InsufficientCapacityException extends __BaseException {
|
|
|
1463
1463
|
*/
|
|
1464
1464
|
export interface DeleteEndpointAccessRequest {
|
|
1465
1465
|
/**
|
|
1466
|
-
* @public
|
|
1467
1466
|
* <p>The name of the VPC endpoint to delete.</p>
|
|
1467
|
+
* @public
|
|
1468
1468
|
*/
|
|
1469
1469
|
endpointName: string | undefined;
|
|
1470
1470
|
}
|
|
@@ -1473,8 +1473,8 @@ export interface DeleteEndpointAccessRequest {
|
|
|
1473
1473
|
*/
|
|
1474
1474
|
export interface DeleteEndpointAccessResponse {
|
|
1475
1475
|
/**
|
|
1476
|
-
* @public
|
|
1477
1476
|
* <p>The deleted VPC endpoint.</p>
|
|
1477
|
+
* @public
|
|
1478
1478
|
*/
|
|
1479
1479
|
endpoint?: EndpointAccess;
|
|
1480
1480
|
}
|
|
@@ -1483,8 +1483,8 @@ export interface DeleteEndpointAccessResponse {
|
|
|
1483
1483
|
*/
|
|
1484
1484
|
export interface GetEndpointAccessRequest {
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>The name of the VPC endpoint to return information for.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
endpointName: string | undefined;
|
|
1490
1490
|
}
|
|
@@ -1493,8 +1493,8 @@ export interface GetEndpointAccessRequest {
|
|
|
1493
1493
|
*/
|
|
1494
1494
|
export interface GetEndpointAccessResponse {
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>The returned VPC endpoint.</p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
endpoint?: EndpointAccess;
|
|
1500
1500
|
}
|
|
@@ -1503,31 +1503,31 @@ export interface GetEndpointAccessResponse {
|
|
|
1503
1503
|
*/
|
|
1504
1504
|
export interface ListEndpointAccessRequest {
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>If your initial <code>ListEndpointAccess</code> operation returns a <code>nextToken</code>,
|
|
1508
1507
|
* you can include the returned <code>nextToken</code> in following <code>ListEndpointAccess</code> operations,
|
|
1509
1508
|
* which returns results in the next page.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
nextToken?: string;
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
1515
1514
|
* You can use <code>nextToken</code> to display the next page of results.</p>
|
|
1515
|
+
* @public
|
|
1516
1516
|
*/
|
|
1517
1517
|
maxResults?: number;
|
|
1518
1518
|
/**
|
|
1519
|
-
* @public
|
|
1520
1519
|
* <p>The name of the workgroup associated with the VPC endpoint to return.</p>
|
|
1520
|
+
* @public
|
|
1521
1521
|
*/
|
|
1522
1522
|
workgroupName?: string;
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
vpcId?: string;
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
ownerAccount?: string;
|
|
1533
1533
|
}
|
|
@@ -1536,15 +1536,15 @@ export interface ListEndpointAccessRequest {
|
|
|
1536
1536
|
*/
|
|
1537
1537
|
export interface ListEndpointAccessResponse {
|
|
1538
1538
|
/**
|
|
1539
|
-
* @public
|
|
1540
1539
|
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
1541
1540
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
1542
1541
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
1542
|
+
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
nextToken?: string;
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>The returned VPC endpoints.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
endpoints: EndpointAccess[] | undefined;
|
|
1550
1550
|
}
|
|
@@ -1553,13 +1553,13 @@ export interface ListEndpointAccessResponse {
|
|
|
1553
1553
|
*/
|
|
1554
1554
|
export interface UpdateEndpointAccessRequest {
|
|
1555
1555
|
/**
|
|
1556
|
-
* @public
|
|
1557
1556
|
* <p>The name of the VPC endpoint to update.</p>
|
|
1557
|
+
* @public
|
|
1558
1558
|
*/
|
|
1559
1559
|
endpointName: string | undefined;
|
|
1560
1560
|
/**
|
|
1561
|
-
* @public
|
|
1562
1561
|
* <p>The list of VPC security groups associated with the endpoint after the endpoint is modified.</p>
|
|
1562
|
+
* @public
|
|
1563
1563
|
*/
|
|
1564
1564
|
vpcSecurityGroupIds?: string[];
|
|
1565
1565
|
}
|
|
@@ -1568,8 +1568,8 @@ export interface UpdateEndpointAccessRequest {
|
|
|
1568
1568
|
*/
|
|
1569
1569
|
export interface UpdateEndpointAccessResponse {
|
|
1570
1570
|
/**
|
|
1571
|
-
* @public
|
|
1572
1571
|
* <p>The updated VPC endpoint.</p>
|
|
1572
|
+
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
endpoint?: EndpointAccess;
|
|
1575
1575
|
}
|
|
@@ -1578,13 +1578,13 @@ export interface UpdateEndpointAccessResponse {
|
|
|
1578
1578
|
*/
|
|
1579
1579
|
export interface DeleteCustomDomainAssociationRequest {
|
|
1580
1580
|
/**
|
|
1581
|
-
* @public
|
|
1582
1581
|
* <p>The name of the workgroup associated with the database.</p>
|
|
1582
|
+
* @public
|
|
1583
1583
|
*/
|
|
1584
1584
|
workgroupName: string | undefined;
|
|
1585
1585
|
/**
|
|
1586
|
-
* @public
|
|
1587
1586
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
1587
|
+
* @public
|
|
1588
1588
|
*/
|
|
1589
1589
|
customDomainName: string | undefined;
|
|
1590
1590
|
}
|
|
@@ -1598,18 +1598,18 @@ export interface DeleteCustomDomainAssociationResponse {
|
|
|
1598
1598
|
*/
|
|
1599
1599
|
export interface DeleteNamespaceRequest {
|
|
1600
1600
|
/**
|
|
1601
|
-
* @public
|
|
1602
1601
|
* <p>The name of the namespace to delete.</p>
|
|
1602
|
+
* @public
|
|
1603
1603
|
*/
|
|
1604
1604
|
namespaceName: string | undefined;
|
|
1605
1605
|
/**
|
|
1606
|
-
* @public
|
|
1607
1606
|
* <p>The name of the snapshot to be created before the namespace is deleted.</p>
|
|
1607
|
+
* @public
|
|
1608
1608
|
*/
|
|
1609
1609
|
finalSnapshotName?: string;
|
|
1610
1610
|
/**
|
|
1611
|
-
* @public
|
|
1612
1611
|
* <p>How long to retain the final snapshot.</p>
|
|
1612
|
+
* @public
|
|
1613
1613
|
*/
|
|
1614
1614
|
finalSnapshotRetentionPeriod?: number;
|
|
1615
1615
|
}
|
|
@@ -1618,8 +1618,8 @@ export interface DeleteNamespaceRequest {
|
|
|
1618
1618
|
*/
|
|
1619
1619
|
export interface DeleteNamespaceResponse {
|
|
1620
1620
|
/**
|
|
1621
|
-
* @public
|
|
1622
1621
|
* <p>The deleted namespace object.</p>
|
|
1622
|
+
* @public
|
|
1623
1623
|
*/
|
|
1624
1624
|
namespace: Namespace | undefined;
|
|
1625
1625
|
}
|
|
@@ -1628,8 +1628,8 @@ export interface DeleteNamespaceResponse {
|
|
|
1628
1628
|
*/
|
|
1629
1629
|
export interface DeleteResourcePolicyRequest {
|
|
1630
1630
|
/**
|
|
1631
|
-
* @public
|
|
1632
1631
|
* <p>The Amazon Resource Name (ARN) of the policy to delete.</p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
resourceArn: string | undefined;
|
|
1635
1635
|
}
|
|
@@ -1643,8 +1643,8 @@ export interface DeleteResourcePolicyResponse {
|
|
|
1643
1643
|
*/
|
|
1644
1644
|
export interface DeleteScheduledActionRequest {
|
|
1645
1645
|
/**
|
|
1646
|
-
* @public
|
|
1647
1646
|
* <p>The name of the scheduled action to delete.</p>
|
|
1647
|
+
* @public
|
|
1648
1648
|
*/
|
|
1649
1649
|
scheduledActionName: string | undefined;
|
|
1650
1650
|
}
|
|
@@ -1653,8 +1653,8 @@ export interface DeleteScheduledActionRequest {
|
|
|
1653
1653
|
*/
|
|
1654
1654
|
export interface DeleteScheduledActionResponse {
|
|
1655
1655
|
/**
|
|
1656
|
-
* @public
|
|
1657
1656
|
* <p>The deleted scheduled action object.</p>
|
|
1657
|
+
* @public
|
|
1658
1658
|
*/
|
|
1659
1659
|
scheduledAction?: ScheduledActionResponse;
|
|
1660
1660
|
}
|
|
@@ -1663,8 +1663,8 @@ export interface DeleteScheduledActionResponse {
|
|
|
1663
1663
|
*/
|
|
1664
1664
|
export interface DeleteSnapshotRequest {
|
|
1665
1665
|
/**
|
|
1666
|
-
* @public
|
|
1667
1666
|
* <p>The name of the snapshot to be deleted.</p>
|
|
1667
|
+
* @public
|
|
1668
1668
|
*/
|
|
1669
1669
|
snapshotName: string | undefined;
|
|
1670
1670
|
}
|
|
@@ -1673,8 +1673,8 @@ export interface DeleteSnapshotRequest {
|
|
|
1673
1673
|
*/
|
|
1674
1674
|
export interface DeleteSnapshotResponse {
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>The deleted snapshot object.</p>
|
|
1677
|
+
* @public
|
|
1678
1678
|
*/
|
|
1679
1679
|
snapshot?: Snapshot;
|
|
1680
1680
|
}
|
|
@@ -1683,8 +1683,8 @@ export interface DeleteSnapshotResponse {
|
|
|
1683
1683
|
*/
|
|
1684
1684
|
export interface DeleteSnapshotCopyConfigurationRequest {
|
|
1685
1685
|
/**
|
|
1686
|
-
* @public
|
|
1687
1686
|
* <p>The ID of the snapshot copy configuration to delete.</p>
|
|
1687
|
+
* @public
|
|
1688
1688
|
*/
|
|
1689
1689
|
snapshotCopyConfigurationId: string | undefined;
|
|
1690
1690
|
}
|
|
@@ -1693,8 +1693,8 @@ export interface DeleteSnapshotCopyConfigurationRequest {
|
|
|
1693
1693
|
*/
|
|
1694
1694
|
export interface DeleteSnapshotCopyConfigurationResponse {
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>The deleted snapshot copy configuration object.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
snapshotCopyConfiguration: SnapshotCopyConfiguration | undefined;
|
|
1700
1700
|
}
|
|
@@ -1703,8 +1703,8 @@ export interface DeleteSnapshotCopyConfigurationResponse {
|
|
|
1703
1703
|
*/
|
|
1704
1704
|
export interface DeleteUsageLimitRequest {
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>The unique identifier of the usage limit to delete.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
usageLimitId: string | undefined;
|
|
1710
1710
|
}
|
|
@@ -1713,8 +1713,8 @@ export interface DeleteUsageLimitRequest {
|
|
|
1713
1713
|
*/
|
|
1714
1714
|
export interface DeleteUsageLimitResponse {
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>The deleted usage limit object.</p>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
usageLimit?: UsageLimit;
|
|
1720
1720
|
}
|
|
@@ -1723,8 +1723,8 @@ export interface DeleteUsageLimitResponse {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
export interface DeleteWorkgroupRequest {
|
|
1725
1725
|
/**
|
|
1726
|
-
* @public
|
|
1727
1726
|
* <p>The name of the workgroup to be deleted.</p>
|
|
1727
|
+
* @public
|
|
1728
1728
|
*/
|
|
1729
1729
|
workgroupName: string | undefined;
|
|
1730
1730
|
}
|
|
@@ -1733,8 +1733,8 @@ export interface DeleteWorkgroupRequest {
|
|
|
1733
1733
|
*/
|
|
1734
1734
|
export interface DeleteWorkgroupResponse {
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>The deleted workgroup object.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
workgroup: Workgroup | undefined;
|
|
1740
1740
|
}
|
|
@@ -1743,7 +1743,6 @@ export interface DeleteWorkgroupResponse {
|
|
|
1743
1743
|
*/
|
|
1744
1744
|
export interface GetCredentialsRequest {
|
|
1745
1745
|
/**
|
|
1746
|
-
* @public
|
|
1747
1746
|
* <p>The name of the database to get temporary authorization to log on to.</p>
|
|
1748
1747
|
* <p>Constraints:</p>
|
|
1749
1748
|
* <ul>
|
|
@@ -1765,22 +1764,23 @@ export interface GetCredentialsRequest {
|
|
|
1765
1764
|
* in the Amazon Redshift Database Developer Guide</p>
|
|
1766
1765
|
* </li>
|
|
1767
1766
|
* </ul>
|
|
1767
|
+
* @public
|
|
1768
1768
|
*/
|
|
1769
1769
|
dbName?: string;
|
|
1770
1770
|
/**
|
|
1771
|
-
* @public
|
|
1772
1771
|
* <p>The number of seconds until the returned temporary password expires.
|
|
1773
1772
|
* The minimum is 900 seconds, and the maximum is 3600 seconds.</p>
|
|
1773
|
+
* @public
|
|
1774
1774
|
*/
|
|
1775
1775
|
durationSeconds?: number;
|
|
1776
1776
|
/**
|
|
1777
|
-
* @public
|
|
1778
1777
|
* <p>The name of the workgroup associated with the database.</p>
|
|
1778
|
+
* @public
|
|
1779
1779
|
*/
|
|
1780
1780
|
workgroupName?: string;
|
|
1781
1781
|
/**
|
|
1782
|
-
* @public
|
|
1783
1782
|
* <p>The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.</p>
|
|
1783
|
+
* @public
|
|
1784
1784
|
*/
|
|
1785
1785
|
customDomainName?: string;
|
|
1786
1786
|
}
|
|
@@ -1789,28 +1789,28 @@ export interface GetCredentialsRequest {
|
|
|
1789
1789
|
*/
|
|
1790
1790
|
export interface GetCredentialsResponse {
|
|
1791
1791
|
/**
|
|
1792
|
-
* @public
|
|
1793
1792
|
* <p>A database user name that is authorized to log on to the database <code>DbName</code>
|
|
1794
1793
|
* using the password <code>DbPassword</code>. If the specified <code>DbUser</code> exists in the database,
|
|
1795
1794
|
* the new user name has the same database privileges as the the user named in
|
|
1796
1795
|
* <code>DbUser</code>. By default, the user is added to PUBLIC.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
dbUser?: string;
|
|
1799
1799
|
/**
|
|
1800
|
-
* @public
|
|
1801
1800
|
* <p>A temporary password that authorizes the user name returned by
|
|
1802
1801
|
* <code>DbUser</code> to log on to the database <code>DbName</code>.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
dbPassword?: string;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>The date and time the password in <code>DbPassword</code> expires.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
expiration?: Date;
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>The date and time of when the <code>DbUser</code> and <code>DbPassword</code>
|
|
1813
1812
|
* authorization refreshes.</p>
|
|
1813
|
+
* @public
|
|
1814
1814
|
*/
|
|
1815
1815
|
nextRefreshTime?: Date;
|
|
1816
1816
|
}
|
|
@@ -1819,13 +1819,13 @@ export interface GetCredentialsResponse {
|
|
|
1819
1819
|
*/
|
|
1820
1820
|
export interface GetCustomDomainAssociationRequest {
|
|
1821
1821
|
/**
|
|
1822
|
-
* @public
|
|
1823
1822
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
1823
|
+
* @public
|
|
1824
1824
|
*/
|
|
1825
1825
|
customDomainName: string | undefined;
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>The name of the workgroup associated with the database.</p>
|
|
1828
|
+
* @public
|
|
1829
1829
|
*/
|
|
1830
1830
|
workgroupName: string | undefined;
|
|
1831
1831
|
}
|
|
@@ -1834,23 +1834,23 @@ export interface GetCustomDomainAssociationRequest {
|
|
|
1834
1834
|
*/
|
|
1835
1835
|
export interface GetCustomDomainAssociationResponse {
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
1838
|
+
* @public
|
|
1839
1839
|
*/
|
|
1840
1840
|
customDomainName?: string;
|
|
1841
1841
|
/**
|
|
1842
|
-
* @public
|
|
1843
1842
|
* <p>The name of the workgroup associated with the database.</p>
|
|
1843
|
+
* @public
|
|
1844
1844
|
*/
|
|
1845
1845
|
workgroupName?: string;
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
customDomainCertificateArn?: string;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>The expiration time for the certificate.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
customDomainCertificateExpiryTime?: Date;
|
|
1856
1856
|
}
|
|
@@ -1859,8 +1859,8 @@ export interface GetCustomDomainAssociationResponse {
|
|
|
1859
1859
|
*/
|
|
1860
1860
|
export interface GetNamespaceRequest {
|
|
1861
1861
|
/**
|
|
1862
|
-
* @public
|
|
1863
1862
|
* <p>The name of the namespace to retrieve information for.</p>
|
|
1863
|
+
* @public
|
|
1864
1864
|
*/
|
|
1865
1865
|
namespaceName: string | undefined;
|
|
1866
1866
|
}
|
|
@@ -1869,8 +1869,8 @@ export interface GetNamespaceRequest {
|
|
|
1869
1869
|
*/
|
|
1870
1870
|
export interface GetNamespaceResponse {
|
|
1871
1871
|
/**
|
|
1872
|
-
* @public
|
|
1873
1872
|
* <p>The returned namespace object.</p>
|
|
1873
|
+
* @public
|
|
1874
1874
|
*/
|
|
1875
1875
|
namespace: Namespace | undefined;
|
|
1876
1876
|
}
|
|
@@ -1879,45 +1879,45 @@ export interface GetNamespaceResponse {
|
|
|
1879
1879
|
*/
|
|
1880
1880
|
export interface GetRecoveryPointRequest {
|
|
1881
1881
|
/**
|
|
1882
|
-
* @public
|
|
1883
1882
|
* <p>The unique identifier of the recovery point to return information for.</p>
|
|
1883
|
+
* @public
|
|
1884
1884
|
*/
|
|
1885
1885
|
recoveryPointId: string | undefined;
|
|
1886
1886
|
}
|
|
1887
1887
|
/**
|
|
1888
|
-
* @public
|
|
1889
1888
|
* <p>The automatically created recovery point of a namespace.
|
|
1890
1889
|
* Recovery points are created every 30 minutes and kept for 24 hours.</p>
|
|
1890
|
+
* @public
|
|
1891
1891
|
*/
|
|
1892
1892
|
export interface RecoveryPoint {
|
|
1893
1893
|
/**
|
|
1894
|
-
* @public
|
|
1895
1894
|
* <p>The unique identifier of the recovery point.</p>
|
|
1895
|
+
* @public
|
|
1896
1896
|
*/
|
|
1897
1897
|
recoveryPointId?: string;
|
|
1898
1898
|
/**
|
|
1899
|
-
* @public
|
|
1900
1899
|
* <p>The time the recovery point is created.</p>
|
|
1900
|
+
* @public
|
|
1901
1901
|
*/
|
|
1902
1902
|
recoveryPointCreateTime?: Date;
|
|
1903
1903
|
/**
|
|
1904
|
-
* @public
|
|
1905
1904
|
* <p>The total size of the data in the recovery point in megabytes.</p>
|
|
1905
|
+
* @public
|
|
1906
1906
|
*/
|
|
1907
1907
|
totalSizeInMegaBytes?: number;
|
|
1908
1908
|
/**
|
|
1909
|
-
* @public
|
|
1910
1909
|
* <p>The name of the namespace the recovery point is associated with.</p>
|
|
1910
|
+
* @public
|
|
1911
1911
|
*/
|
|
1912
1912
|
namespaceName?: string;
|
|
1913
1913
|
/**
|
|
1914
|
-
* @public
|
|
1915
1914
|
* <p>The name of the workgroup the recovery point is associated with.</p>
|
|
1915
|
+
* @public
|
|
1916
1916
|
*/
|
|
1917
1917
|
workgroupName?: string;
|
|
1918
1918
|
/**
|
|
1919
|
-
* @public
|
|
1920
1919
|
* <p>The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.</p>
|
|
1920
|
+
* @public
|
|
1921
1921
|
*/
|
|
1922
1922
|
namespaceArn?: string;
|
|
1923
1923
|
}
|
|
@@ -1926,8 +1926,8 @@ export interface RecoveryPoint {
|
|
|
1926
1926
|
*/
|
|
1927
1927
|
export interface GetRecoveryPointResponse {
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>The returned recovery point object.</p>
|
|
1930
|
+
* @public
|
|
1931
1931
|
*/
|
|
1932
1932
|
recoveryPoint?: RecoveryPoint;
|
|
1933
1933
|
}
|
|
@@ -1936,24 +1936,24 @@ export interface GetRecoveryPointResponse {
|
|
|
1936
1936
|
*/
|
|
1937
1937
|
export interface GetResourcePolicyRequest {
|
|
1938
1938
|
/**
|
|
1939
|
-
* @public
|
|
1940
1939
|
* <p>The Amazon Resource Name (ARN) of the resource to return.</p>
|
|
1940
|
+
* @public
|
|
1941
1941
|
*/
|
|
1942
1942
|
resourceArn: string | undefined;
|
|
1943
1943
|
}
|
|
1944
1944
|
/**
|
|
1945
|
-
* @public
|
|
1946
1945
|
* <p>The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.</p>
|
|
1946
|
+
* @public
|
|
1947
1947
|
*/
|
|
1948
1948
|
export interface ResourcePolicy {
|
|
1949
1949
|
/**
|
|
1950
|
-
* @public
|
|
1951
1950
|
* <p>The Amazon Resource Name (ARN) of the policy.</p>
|
|
1951
|
+
* @public
|
|
1952
1952
|
*/
|
|
1953
1953
|
resourceArn?: string;
|
|
1954
1954
|
/**
|
|
1955
|
-
* @public
|
|
1956
1955
|
* <p>The resource policy.</p>
|
|
1956
|
+
* @public
|
|
1957
1957
|
*/
|
|
1958
1958
|
policy?: string;
|
|
1959
1959
|
}
|
|
@@ -1962,8 +1962,8 @@ export interface ResourcePolicy {
|
|
|
1962
1962
|
*/
|
|
1963
1963
|
export interface GetResourcePolicyResponse {
|
|
1964
1964
|
/**
|
|
1965
|
-
* @public
|
|
1966
1965
|
* <p>The returned resource policy.</p>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
resourcePolicy?: ResourcePolicy;
|
|
1969
1969
|
}
|
|
@@ -1972,8 +1972,8 @@ export interface GetResourcePolicyResponse {
|
|
|
1972
1972
|
*/
|
|
1973
1973
|
export interface GetScheduledActionRequest {
|
|
1974
1974
|
/**
|
|
1975
|
-
* @public
|
|
1976
1975
|
* <p>The name of the scheduled action.</p>
|
|
1976
|
+
* @public
|
|
1977
1977
|
*/
|
|
1978
1978
|
scheduledActionName: string | undefined;
|
|
1979
1979
|
}
|
|
@@ -1982,8 +1982,8 @@ export interface GetScheduledActionRequest {
|
|
|
1982
1982
|
*/
|
|
1983
1983
|
export interface GetScheduledActionResponse {
|
|
1984
1984
|
/**
|
|
1985
|
-
* @public
|
|
1986
1985
|
* <p>The returned scheduled action object.</p>
|
|
1986
|
+
* @public
|
|
1987
1987
|
*/
|
|
1988
1988
|
scheduledAction?: ScheduledActionResponse;
|
|
1989
1989
|
}
|
|
@@ -1992,18 +1992,18 @@ export interface GetScheduledActionResponse {
|
|
|
1992
1992
|
*/
|
|
1993
1993
|
export interface GetSnapshotRequest {
|
|
1994
1994
|
/**
|
|
1995
|
-
* @public
|
|
1996
1995
|
* <p>The name of the snapshot to return.</p>
|
|
1996
|
+
* @public
|
|
1997
1997
|
*/
|
|
1998
1998
|
snapshotName?: string;
|
|
1999
1999
|
/**
|
|
2000
|
-
* @public
|
|
2001
2000
|
* <p>The owner Amazon Web Services account of a snapshot shared with another user.</p>
|
|
2001
|
+
* @public
|
|
2002
2002
|
*/
|
|
2003
2003
|
ownerAccount?: string;
|
|
2004
2004
|
/**
|
|
2005
|
-
* @public
|
|
2006
2005
|
* <p>The Amazon Resource Name (ARN) of the snapshot to return.</p>
|
|
2006
|
+
* @public
|
|
2007
2007
|
*/
|
|
2008
2008
|
snapshotArn?: string;
|
|
2009
2009
|
}
|
|
@@ -2012,8 +2012,8 @@ export interface GetSnapshotRequest {
|
|
|
2012
2012
|
*/
|
|
2013
2013
|
export interface GetSnapshotResponse {
|
|
2014
2014
|
/**
|
|
2015
|
-
* @public
|
|
2016
2015
|
* <p>The returned snapshot object.</p>
|
|
2016
|
+
* @public
|
|
2017
2017
|
*/
|
|
2018
2018
|
snapshot?: Snapshot;
|
|
2019
2019
|
}
|
|
@@ -2022,96 +2022,96 @@ export interface GetSnapshotResponse {
|
|
|
2022
2022
|
*/
|
|
2023
2023
|
export interface GetTableRestoreStatusRequest {
|
|
2024
2024
|
/**
|
|
2025
|
-
* @public
|
|
2026
2025
|
* <p>The ID of the <code>RestoreTableFromSnapshot</code> request to return status for.</p>
|
|
2026
|
+
* @public
|
|
2027
2027
|
*/
|
|
2028
2028
|
tableRestoreRequestId: string | undefined;
|
|
2029
2029
|
}
|
|
2030
2030
|
/**
|
|
2031
|
-
* @public
|
|
2032
2031
|
* <p>Contains information about a table restore request.</p>
|
|
2032
|
+
* @public
|
|
2033
2033
|
*/
|
|
2034
2034
|
export interface TableRestoreStatus {
|
|
2035
2035
|
/**
|
|
2036
|
-
* @public
|
|
2037
2036
|
* <p>The ID of the RestoreTableFromSnapshot request.</p>
|
|
2037
|
+
* @public
|
|
2038
2038
|
*/
|
|
2039
2039
|
tableRestoreRequestId?: string;
|
|
2040
2040
|
/**
|
|
2041
|
-
* @public
|
|
2042
2041
|
* <p>A value that describes the current state of the table restore request.
|
|
2043
2042
|
* Possible values are <code>SUCCEEDED</code>, <code>FAILED</code>, <code>CANCELED</code>, <code>PENDING</code>, and <code>IN_PROGRESS</code>.</p>
|
|
2043
|
+
* @public
|
|
2044
2044
|
*/
|
|
2045
2045
|
status?: string;
|
|
2046
2046
|
/**
|
|
2047
|
-
* @public
|
|
2048
2047
|
* <p>A message that explains the returned status. For example, if the status of the operation is <code>FAILED</code>, the message explains why the operation failed.</p>
|
|
2048
|
+
* @public
|
|
2049
2049
|
*/
|
|
2050
2050
|
message?: string;
|
|
2051
2051
|
/**
|
|
2052
|
-
* @public
|
|
2053
2052
|
* <p>The time that the table restore request was made,
|
|
2054
2053
|
* in Universal Coordinated Time (UTC).</p>
|
|
2054
|
+
* @public
|
|
2055
2055
|
*/
|
|
2056
2056
|
requestTime?: Date;
|
|
2057
2057
|
/**
|
|
2058
|
-
* @public
|
|
2059
2058
|
* <p>The namespace of the table being restored from.</p>
|
|
2059
|
+
* @public
|
|
2060
2060
|
*/
|
|
2061
2061
|
namespaceName?: string;
|
|
2062
2062
|
/**
|
|
2063
|
-
* @public
|
|
2064
2063
|
* <p>The name of the workgroup being restored from.</p>
|
|
2064
|
+
* @public
|
|
2065
2065
|
*/
|
|
2066
2066
|
workgroupName?: string;
|
|
2067
2067
|
/**
|
|
2068
|
-
* @public
|
|
2069
2068
|
* <p>The name of the snapshot being restored from.</p>
|
|
2069
|
+
* @public
|
|
2070
2070
|
*/
|
|
2071
2071
|
snapshotName?: string;
|
|
2072
2072
|
/**
|
|
2073
|
-
* @public
|
|
2074
2073
|
* <p>The amount of data restored to the new table so far, in megabytes (MB).</p>
|
|
2074
|
+
* @public
|
|
2075
2075
|
*/
|
|
2076
2076
|
progressInMegaBytes?: number;
|
|
2077
2077
|
/**
|
|
2078
|
-
* @public
|
|
2079
2078
|
* <p>The total amount of data to restore to the new table, in megabytes (MB).</p>
|
|
2079
|
+
* @public
|
|
2080
2080
|
*/
|
|
2081
2081
|
totalDataInMegaBytes?: number;
|
|
2082
2082
|
/**
|
|
2083
|
-
* @public
|
|
2084
2083
|
* <p>The name of the source database being restored from.</p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
sourceDatabaseName?: string;
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>The name of the source schema being restored from.</p>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
sourceSchemaName?: string;
|
|
2092
2092
|
/**
|
|
2093
|
-
* @public
|
|
2094
2093
|
* <p>The name of the source table being restored from.</p>
|
|
2094
|
+
* @public
|
|
2095
2095
|
*/
|
|
2096
2096
|
sourceTableName?: string;
|
|
2097
2097
|
/**
|
|
2098
|
-
* @public
|
|
2099
2098
|
* <p>The name of the database to restore to.</p>
|
|
2099
|
+
* @public
|
|
2100
2100
|
*/
|
|
2101
2101
|
targetDatabaseName?: string;
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>The name of the schema to restore to.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
targetSchemaName?: string;
|
|
2107
2107
|
/**
|
|
2108
|
-
* @public
|
|
2109
2108
|
* <p>The name of the table to create from the restore operation.</p>
|
|
2109
|
+
* @public
|
|
2110
2110
|
*/
|
|
2111
2111
|
newTableName?: string;
|
|
2112
2112
|
/**
|
|
2113
|
-
* @public
|
|
2114
2113
|
* <p>The ID of the recovery point being restored from.</p>
|
|
2114
|
+
* @public
|
|
2115
2115
|
*/
|
|
2116
2116
|
recoveryPointId?: string;
|
|
2117
2117
|
}
|
|
@@ -2120,9 +2120,9 @@ export interface TableRestoreStatus {
|
|
|
2120
2120
|
*/
|
|
2121
2121
|
export interface GetTableRestoreStatusResponse {
|
|
2122
2122
|
/**
|
|
2123
|
-
* @public
|
|
2124
2123
|
* <p>The returned <code>TableRestoreStatus</code> object that contains information about
|
|
2125
2124
|
* the status of your <code>RestoreTableFromSnapshot</code> request.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
tableRestoreStatus?: TableRestoreStatus;
|
|
2128
2128
|
}
|
|
@@ -2131,8 +2131,8 @@ export interface GetTableRestoreStatusResponse {
|
|
|
2131
2131
|
*/
|
|
2132
2132
|
export interface GetUsageLimitRequest {
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p>The unique identifier of the usage limit to return information for.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
usageLimitId: string | undefined;
|
|
2138
2138
|
}
|
|
@@ -2141,8 +2141,8 @@ export interface GetUsageLimitRequest {
|
|
|
2141
2141
|
*/
|
|
2142
2142
|
export interface GetUsageLimitResponse {
|
|
2143
2143
|
/**
|
|
2144
|
-
* @public
|
|
2145
2144
|
* <p>The returned usage limit object.</p>
|
|
2145
|
+
* @public
|
|
2146
2146
|
*/
|
|
2147
2147
|
usageLimit?: UsageLimit;
|
|
2148
2148
|
}
|
|
@@ -2151,8 +2151,8 @@ export interface GetUsageLimitResponse {
|
|
|
2151
2151
|
*/
|
|
2152
2152
|
export interface GetWorkgroupRequest {
|
|
2153
2153
|
/**
|
|
2154
|
-
* @public
|
|
2155
2154
|
* <p>The name of the workgroup to return information for.</p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
workgroupName: string | undefined;
|
|
2158
2158
|
}
|
|
@@ -2161,14 +2161,14 @@ export interface GetWorkgroupRequest {
|
|
|
2161
2161
|
*/
|
|
2162
2162
|
export interface GetWorkgroupResponse {
|
|
2163
2163
|
/**
|
|
2164
|
-
* @public
|
|
2165
2164
|
* <p>The returned workgroup object.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
workgroup: Workgroup | undefined;
|
|
2168
2168
|
}
|
|
2169
2169
|
/**
|
|
2170
|
-
* @public
|
|
2171
2170
|
* <p>The provided pagination token is invalid.</p>
|
|
2171
|
+
* @public
|
|
2172
2172
|
*/
|
|
2173
2173
|
export declare class InvalidPaginationException extends __BaseException {
|
|
2174
2174
|
readonly name: "InvalidPaginationException";
|
|
@@ -2183,26 +2183,26 @@ export declare class InvalidPaginationException extends __BaseException {
|
|
|
2183
2183
|
*/
|
|
2184
2184
|
export interface ListCustomDomainAssociationsRequest {
|
|
2185
2185
|
/**
|
|
2186
|
-
* @public
|
|
2187
2186
|
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
2188
2187
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2189
2188
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2189
|
+
* @public
|
|
2190
2190
|
*/
|
|
2191
2191
|
nextToken?: string;
|
|
2192
2192
|
/**
|
|
2193
|
-
* @public
|
|
2194
2193
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
2195
2194
|
* You can use <code>nextToken</code> to display the next page of results.</p>
|
|
2195
|
+
* @public
|
|
2196
2196
|
*/
|
|
2197
2197
|
maxResults?: number;
|
|
2198
2198
|
/**
|
|
2199
|
-
* @public
|
|
2200
2199
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
2200
|
+
* @public
|
|
2201
2201
|
*/
|
|
2202
2202
|
customDomainName?: string;
|
|
2203
2203
|
/**
|
|
2204
|
-
* @public
|
|
2205
2204
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
2205
|
+
* @public
|
|
2206
2206
|
*/
|
|
2207
2207
|
customDomainCertificateArn?: string;
|
|
2208
2208
|
}
|
|
@@ -2211,15 +2211,15 @@ export interface ListCustomDomainAssociationsRequest {
|
|
|
2211
2211
|
*/
|
|
2212
2212
|
export interface ListCustomDomainAssociationsResponse {
|
|
2213
2213
|
/**
|
|
2214
|
-
* @public
|
|
2215
2214
|
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
2216
2215
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2217
2216
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2217
|
+
* @public
|
|
2218
2218
|
*/
|
|
2219
2219
|
nextToken?: string;
|
|
2220
2220
|
/**
|
|
2221
|
-
* @public
|
|
2222
2221
|
* <p>A list of Association objects.</p>
|
|
2222
|
+
* @public
|
|
2223
2223
|
*/
|
|
2224
2224
|
associations?: Association[];
|
|
2225
2225
|
}
|
|
@@ -2228,16 +2228,16 @@ export interface ListCustomDomainAssociationsResponse {
|
|
|
2228
2228
|
*/
|
|
2229
2229
|
export interface ListNamespacesRequest {
|
|
2230
2230
|
/**
|
|
2231
|
-
* @public
|
|
2232
2231
|
* <p>If your initial <code>ListNamespaces</code> operation returns a <code>nextToken</code>,
|
|
2233
2232
|
* you can include the returned <code>nextToken</code> in following <code>ListNamespaces</code> operations,
|
|
2234
2233
|
* which returns results in the next page.</p>
|
|
2234
|
+
* @public
|
|
2235
2235
|
*/
|
|
2236
2236
|
nextToken?: string;
|
|
2237
2237
|
/**
|
|
2238
|
-
* @public
|
|
2239
2238
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
2240
2239
|
* You can use <code>nextToken</code> to display the next page of results.</p>
|
|
2240
|
+
* @public
|
|
2241
2241
|
*/
|
|
2242
2242
|
maxResults?: number;
|
|
2243
2243
|
}
|
|
@@ -2246,15 +2246,15 @@ export interface ListNamespacesRequest {
|
|
|
2246
2246
|
*/
|
|
2247
2247
|
export interface ListNamespacesResponse {
|
|
2248
2248
|
/**
|
|
2249
|
-
* @public
|
|
2250
2249
|
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
2251
2250
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2252
2251
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2252
|
+
* @public
|
|
2253
2253
|
*/
|
|
2254
2254
|
nextToken?: string;
|
|
2255
2255
|
/**
|
|
2256
|
-
* @public
|
|
2257
2256
|
* <p>The list of returned namespaces.</p>
|
|
2257
|
+
* @public
|
|
2258
2258
|
*/
|
|
2259
2259
|
namespaces: Namespace[] | undefined;
|
|
2260
2260
|
}
|
|
@@ -2263,36 +2263,36 @@ export interface ListNamespacesResponse {
|
|
|
2263
2263
|
*/
|
|
2264
2264
|
export interface ListRecoveryPointsRequest {
|
|
2265
2265
|
/**
|
|
2266
|
-
* @public
|
|
2267
2266
|
* <p>If your initial <code>ListRecoveryPoints</code> operation returns a <code>nextToken</code>,
|
|
2268
2267
|
* you can include the returned <code>nextToken</code> in following <code>ListRecoveryPoints</code> operations,
|
|
2269
2268
|
* which returns results in the next page.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
nextToken?: string;
|
|
2272
2272
|
/**
|
|
2273
|
-
* @public
|
|
2274
2273
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
2275
2274
|
* You can use <code>nextToken</code> to display the next page of results.</p>
|
|
2275
|
+
* @public
|
|
2276
2276
|
*/
|
|
2277
2277
|
maxResults?: number;
|
|
2278
2278
|
/**
|
|
2279
|
-
* @public
|
|
2280
2279
|
* <p>The time when the recovery point's creation was initiated.</p>
|
|
2280
|
+
* @public
|
|
2281
2281
|
*/
|
|
2282
2282
|
startTime?: Date;
|
|
2283
2283
|
/**
|
|
2284
|
-
* @public
|
|
2285
2284
|
* <p>The time when creation of the recovery point finished.</p>
|
|
2285
|
+
* @public
|
|
2286
2286
|
*/
|
|
2287
2287
|
endTime?: Date;
|
|
2288
2288
|
/**
|
|
2289
|
-
* @public
|
|
2290
2289
|
* <p>The name of the namespace to list recovery points for.</p>
|
|
2290
|
+
* @public
|
|
2291
2291
|
*/
|
|
2292
2292
|
namespaceName?: string;
|
|
2293
2293
|
/**
|
|
2294
|
-
* @public
|
|
2295
2294
|
* <p>The Amazon Resource Name (ARN) of the namespace from which to list recovery points.</p>
|
|
2295
|
+
* @public
|
|
2296
2296
|
*/
|
|
2297
2297
|
namespaceArn?: string;
|
|
2298
2298
|
}
|
|
@@ -2301,15 +2301,15 @@ export interface ListRecoveryPointsRequest {
|
|
|
2301
2301
|
*/
|
|
2302
2302
|
export interface ListRecoveryPointsResponse {
|
|
2303
2303
|
/**
|
|
2304
|
-
* @public
|
|
2305
2304
|
* <p>The returned recovery point objects.</p>
|
|
2305
|
+
* @public
|
|
2306
2306
|
*/
|
|
2307
2307
|
recoveryPoints?: RecoveryPoint[];
|
|
2308
2308
|
/**
|
|
2309
|
-
* @public
|
|
2310
2309
|
* <p>If <code>nextToken</code> is returned, there are more results available.
|
|
2311
2310
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2312
2311
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2312
|
+
* @public
|
|
2313
2313
|
*/
|
|
2314
2314
|
nextToken?: string;
|
|
2315
2315
|
}
|
|
@@ -2318,19 +2318,19 @@ export interface ListRecoveryPointsResponse {
|
|
|
2318
2318
|
*/
|
|
2319
2319
|
export interface ListScheduledActionsRequest {
|
|
2320
2320
|
/**
|
|
2321
|
-
* @public
|
|
2322
2321
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2323
2322
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2323
|
+
* @public
|
|
2324
2324
|
*/
|
|
2325
2325
|
nextToken?: string;
|
|
2326
2326
|
/**
|
|
2327
|
-
* @public
|
|
2328
2327
|
* <p>An optional parameter that specifies the maximum number of results to return. Use <code>nextToken</code> to display the next page of results.</p>
|
|
2328
|
+
* @public
|
|
2329
2329
|
*/
|
|
2330
2330
|
maxResults?: number;
|
|
2331
2331
|
/**
|
|
2332
|
-
* @public
|
|
2333
2332
|
* <p>The name of namespace associated with the scheduled action to retrieve.</p>
|
|
2333
|
+
* @public
|
|
2334
2334
|
*/
|
|
2335
2335
|
namespaceName?: string;
|
|
2336
2336
|
}
|
|
@@ -2339,13 +2339,13 @@ export interface ListScheduledActionsRequest {
|
|
|
2339
2339
|
*/
|
|
2340
2340
|
export interface ListScheduledActionsResponse {
|
|
2341
2341
|
/**
|
|
2342
|
-
* @public
|
|
2343
2342
|
* <p>If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
|
|
2343
|
+
* @public
|
|
2344
2344
|
*/
|
|
2345
2345
|
nextToken?: string;
|
|
2346
2346
|
/**
|
|
2347
|
-
* @public
|
|
2348
2347
|
* <p>All of the returned scheduled action objects.</p>
|
|
2348
|
+
* @public
|
|
2349
2349
|
*/
|
|
2350
2350
|
scheduledActions?: string[];
|
|
2351
2351
|
}
|
|
@@ -2354,19 +2354,19 @@ export interface ListScheduledActionsResponse {
|
|
|
2354
2354
|
*/
|
|
2355
2355
|
export interface ListSnapshotCopyConfigurationsRequest {
|
|
2356
2356
|
/**
|
|
2357
|
-
* @public
|
|
2358
2357
|
* <p>The namespace from which to list all snapshot copy configurations.</p>
|
|
2358
|
+
* @public
|
|
2359
2359
|
*/
|
|
2360
2360
|
namespaceName?: string;
|
|
2361
2361
|
/**
|
|
2362
|
-
* @public
|
|
2363
2362
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using
|
|
2364
2363
|
* the returned token to retrieve the next page.</p>
|
|
2364
|
+
* @public
|
|
2365
2365
|
*/
|
|
2366
2366
|
nextToken?: string;
|
|
2367
2367
|
/**
|
|
2368
|
-
* @public
|
|
2369
2368
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>
|
|
2369
|
+
* @public
|
|
2370
2370
|
*/
|
|
2371
2371
|
maxResults?: number;
|
|
2372
2372
|
}
|
|
@@ -2375,14 +2375,14 @@ export interface ListSnapshotCopyConfigurationsRequest {
|
|
|
2375
2375
|
*/
|
|
2376
2376
|
export interface ListSnapshotCopyConfigurationsResponse {
|
|
2377
2377
|
/**
|
|
2378
|
-
* @public
|
|
2379
2378
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using
|
|
2380
2379
|
* the returned token to retrieve the next page.</p>
|
|
2380
|
+
* @public
|
|
2381
2381
|
*/
|
|
2382
2382
|
nextToken?: string;
|
|
2383
2383
|
/**
|
|
2384
|
-
* @public
|
|
2385
2384
|
* <p>All of the returned snapshot copy configurations.</p>
|
|
2385
|
+
* @public
|
|
2386
2386
|
*/
|
|
2387
2387
|
snapshotCopyConfigurations: SnapshotCopyConfiguration[] | undefined;
|
|
2388
2388
|
}
|
|
@@ -2391,41 +2391,41 @@ export interface ListSnapshotCopyConfigurationsResponse {
|
|
|
2391
2391
|
*/
|
|
2392
2392
|
export interface ListSnapshotsRequest {
|
|
2393
2393
|
/**
|
|
2394
|
-
* @public
|
|
2395
2394
|
* <p>If <code>nextToken</code> is returned, there are more results available.
|
|
2396
2395
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2397
2396
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2397
|
+
* @public
|
|
2398
2398
|
*/
|
|
2399
2399
|
nextToken?: string;
|
|
2400
2400
|
/**
|
|
2401
|
-
* @public
|
|
2402
2401
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
2403
2402
|
* You can use <code>nextToken</code> to display the next page of results.</p>
|
|
2403
|
+
* @public
|
|
2404
2404
|
*/
|
|
2405
2405
|
maxResults?: number;
|
|
2406
2406
|
/**
|
|
2407
|
-
* @public
|
|
2408
2407
|
* <p>The namespace from which to list all snapshots.</p>
|
|
2408
|
+
* @public
|
|
2409
2409
|
*/
|
|
2410
2410
|
namespaceName?: string;
|
|
2411
2411
|
/**
|
|
2412
|
-
* @public
|
|
2413
2412
|
* <p>The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.</p>
|
|
2413
|
+
* @public
|
|
2414
2414
|
*/
|
|
2415
2415
|
namespaceArn?: string;
|
|
2416
2416
|
/**
|
|
2417
|
-
* @public
|
|
2418
2417
|
* <p>The owner Amazon Web Services account of the snapshot.</p>
|
|
2418
|
+
* @public
|
|
2419
2419
|
*/
|
|
2420
2420
|
ownerAccount?: string;
|
|
2421
2421
|
/**
|
|
2422
|
-
* @public
|
|
2423
2422
|
* <p>The time when the creation of the snapshot was initiated.</p>
|
|
2423
|
+
* @public
|
|
2424
2424
|
*/
|
|
2425
2425
|
startTime?: Date;
|
|
2426
2426
|
/**
|
|
2427
|
-
* @public
|
|
2428
2427
|
* <p>The timestamp showing when the snapshot creation finished.</p>
|
|
2428
|
+
* @public
|
|
2429
2429
|
*/
|
|
2430
2430
|
endTime?: Date;
|
|
2431
2431
|
}
|
|
@@ -2434,15 +2434,15 @@ export interface ListSnapshotsRequest {
|
|
|
2434
2434
|
*/
|
|
2435
2435
|
export interface ListSnapshotsResponse {
|
|
2436
2436
|
/**
|
|
2437
|
-
* @public
|
|
2438
2437
|
* <p>If <code>nextToken</code> is returned, there are more results available.
|
|
2439
2438
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2440
2439
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2440
|
+
* @public
|
|
2441
2441
|
*/
|
|
2442
2442
|
nextToken?: string;
|
|
2443
2443
|
/**
|
|
2444
|
-
* @public
|
|
2445
2444
|
* <p>All of the returned snapshot objects.</p>
|
|
2445
|
+
* @public
|
|
2446
2446
|
*/
|
|
2447
2447
|
snapshots?: Snapshot[];
|
|
2448
2448
|
}
|
|
@@ -2451,26 +2451,26 @@ export interface ListSnapshotsResponse {
|
|
|
2451
2451
|
*/
|
|
2452
2452
|
export interface ListTableRestoreStatusRequest {
|
|
2453
2453
|
/**
|
|
2454
|
-
* @public
|
|
2455
2454
|
* <p>If your initial <code>ListTableRestoreStatus</code> operation returns a nextToken,
|
|
2456
2455
|
* you can include the returned <code>nextToken</code> in following <code>ListTableRestoreStatus</code>
|
|
2457
2456
|
* operations. This will return results on the next page.</p>
|
|
2457
|
+
* @public
|
|
2458
2458
|
*/
|
|
2459
2459
|
nextToken?: string;
|
|
2460
2460
|
/**
|
|
2461
|
-
* @public
|
|
2462
2461
|
* <p>An optional parameter that specifies the maximum number of results to
|
|
2463
2462
|
* return. You can use nextToken to display the next page of results.</p>
|
|
2463
|
+
* @public
|
|
2464
2464
|
*/
|
|
2465
2465
|
maxResults?: number;
|
|
2466
2466
|
/**
|
|
2467
|
-
* @public
|
|
2468
2467
|
* <p>The namespace from which to list all of the statuses of <code>RestoreTableFromSnapshot</code> operations .</p>
|
|
2468
|
+
* @public
|
|
2469
2469
|
*/
|
|
2470
2470
|
namespaceName?: string;
|
|
2471
2471
|
/**
|
|
2472
|
-
* @public
|
|
2473
2472
|
* <p>The workgroup from which to list all of the statuses of <code>RestoreTableFromSnapshot</code> operations.</p>
|
|
2473
|
+
* @public
|
|
2474
2474
|
*/
|
|
2475
2475
|
workgroupName?: string;
|
|
2476
2476
|
}
|
|
@@ -2479,15 +2479,15 @@ export interface ListTableRestoreStatusRequest {
|
|
|
2479
2479
|
*/
|
|
2480
2480
|
export interface ListTableRestoreStatusResponse {
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>If your initial <code>ListTableRestoreStatus</code> operation returns a <code>nextToken</code>,
|
|
2484
2483
|
* you can include the returned <code>nextToken</code> in following <code>ListTableRestoreStatus</code>
|
|
2485
2484
|
* operations. This will returns results on the next page.</p>
|
|
2485
|
+
* @public
|
|
2486
2486
|
*/
|
|
2487
2487
|
nextToken?: string;
|
|
2488
2488
|
/**
|
|
2489
|
-
* @public
|
|
2490
2489
|
* <p>The array of returned <code>TableRestoreStatus</code> objects.</p>
|
|
2490
|
+
* @public
|
|
2491
2491
|
*/
|
|
2492
2492
|
tableRestoreStatuses?: TableRestoreStatus[];
|
|
2493
2493
|
}
|
|
@@ -2496,8 +2496,8 @@ export interface ListTableRestoreStatusResponse {
|
|
|
2496
2496
|
*/
|
|
2497
2497
|
export interface ListTagsForResourceRequest {
|
|
2498
2498
|
/**
|
|
2499
|
-
* @public
|
|
2500
2499
|
* <p>The Amazon Resource Name (ARN) of the resource to list tags for.</p>
|
|
2500
|
+
* @public
|
|
2501
2501
|
*/
|
|
2502
2502
|
resourceArn: string | undefined;
|
|
2503
2503
|
}
|
|
@@ -2506,8 +2506,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2506
2506
|
*/
|
|
2507
2507
|
export interface ListTagsForResourceResponse {
|
|
2508
2508
|
/**
|
|
2509
|
-
* @public
|
|
2510
2509
|
* <p>A map of the key-value pairs assigned to the resource.</p>
|
|
2510
|
+
* @public
|
|
2511
2511
|
*/
|
|
2512
2512
|
tags?: Tag[];
|
|
2513
2513
|
}
|
|
@@ -2516,27 +2516,27 @@ export interface ListTagsForResourceResponse {
|
|
|
2516
2516
|
*/
|
|
2517
2517
|
export interface ListUsageLimitsRequest {
|
|
2518
2518
|
/**
|
|
2519
|
-
* @public
|
|
2520
2519
|
* <p>The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.</p>
|
|
2520
|
+
* @public
|
|
2521
2521
|
*/
|
|
2522
2522
|
resourceArn?: string;
|
|
2523
2523
|
/**
|
|
2524
|
-
* @public
|
|
2525
2524
|
* <p>The Amazon Redshift Serverless feature whose limits you want to see.</p>
|
|
2525
|
+
* @public
|
|
2526
2526
|
*/
|
|
2527
2527
|
usageType?: UsageLimitUsageType;
|
|
2528
2528
|
/**
|
|
2529
|
-
* @public
|
|
2530
2529
|
* <p>If your initial <code>ListUsageLimits</code> operation returns a <code>nextToken</code>,
|
|
2531
2530
|
* you can include the returned <code>nextToken</code> in following <code>ListUsageLimits</code> operations,
|
|
2532
2531
|
* which returns results in the next page.
|
|
2533
2532
|
* </p>
|
|
2533
|
+
* @public
|
|
2534
2534
|
*/
|
|
2535
2535
|
nextToken?: string;
|
|
2536
2536
|
/**
|
|
2537
|
-
* @public
|
|
2538
2537
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
2539
2538
|
* You can use <code>nextToken</code> to get the next page of results. The default is 100.</p>
|
|
2539
|
+
* @public
|
|
2540
2540
|
*/
|
|
2541
2541
|
maxResults?: number;
|
|
2542
2542
|
}
|
|
@@ -2545,15 +2545,15 @@ export interface ListUsageLimitsRequest {
|
|
|
2545
2545
|
*/
|
|
2546
2546
|
export interface ListUsageLimitsResponse {
|
|
2547
2547
|
/**
|
|
2548
|
-
* @public
|
|
2549
2548
|
* <p>An array of returned usage limit objects.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
usageLimits?: UsageLimit[];
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>When <code>nextToken</code> is returned, there are more results available.
|
|
2555
2554
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2556
2555
|
* Make the call again using the returned token to retrieve the next page.</p>
|
|
2556
|
+
* @public
|
|
2557
2557
|
*/
|
|
2558
2558
|
nextToken?: string;
|
|
2559
2559
|
}
|
|
@@ -2562,21 +2562,21 @@ export interface ListUsageLimitsResponse {
|
|
|
2562
2562
|
*/
|
|
2563
2563
|
export interface ListWorkgroupsRequest {
|
|
2564
2564
|
/**
|
|
2565
|
-
* @public
|
|
2566
2565
|
* <p>If your initial ListWorkgroups operation returns a <code>nextToken</code>,
|
|
2567
2566
|
* you can include the returned <code>nextToken</code> in following ListNamespaces operations,
|
|
2568
2567
|
* which returns results in the next page.</p>
|
|
2568
|
+
* @public
|
|
2569
2569
|
*/
|
|
2570
2570
|
nextToken?: string;
|
|
2571
2571
|
/**
|
|
2572
|
-
* @public
|
|
2573
2572
|
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
2574
2573
|
* You can use <code>nextToken</code> to display the next page of results.</p>
|
|
2574
|
+
* @public
|
|
2575
2575
|
*/
|
|
2576
2576
|
maxResults?: number;
|
|
2577
2577
|
/**
|
|
2578
|
-
* @public
|
|
2579
2578
|
* <p>The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.</p>
|
|
2579
|
+
* @public
|
|
2580
2580
|
*/
|
|
2581
2581
|
ownerAccount?: string;
|
|
2582
2582
|
}
|
|
@@ -2585,16 +2585,16 @@ export interface ListWorkgroupsRequest {
|
|
|
2585
2585
|
*/
|
|
2586
2586
|
export interface ListWorkgroupsResponse {
|
|
2587
2587
|
/**
|
|
2588
|
-
* @public
|
|
2589
2588
|
* <p>
|
|
2590
2589
|
* If <code>nextToken</code> is returned, there are more results available.
|
|
2591
2590
|
* The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2592
2591
|
* To retrieve the next page, make the call again using the returned token.</p>
|
|
2592
|
+
* @public
|
|
2593
2593
|
*/
|
|
2594
2594
|
nextToken?: string;
|
|
2595
2595
|
/**
|
|
2596
|
-
* @public
|
|
2597
2596
|
* <p>The returned array of workgroups.</p>
|
|
2597
|
+
* @public
|
|
2598
2598
|
*/
|
|
2599
2599
|
workgroups: Workgroup[] | undefined;
|
|
2600
2600
|
}
|
|
@@ -2603,57 +2603,57 @@ export interface ListWorkgroupsResponse {
|
|
|
2603
2603
|
*/
|
|
2604
2604
|
export interface UpdateNamespaceRequest {
|
|
2605
2605
|
/**
|
|
2606
|
-
* @public
|
|
2607
2606
|
* <p>The name of the namespace to update. You can't update the name of a namespace once it is created.</p>
|
|
2607
|
+
* @public
|
|
2608
2608
|
*/
|
|
2609
2609
|
namespaceName: string | undefined;
|
|
2610
2610
|
/**
|
|
2611
|
-
* @public
|
|
2612
2611
|
* <p>The password of the administrator for the first database created in the namespace. This parameter must be updated together
|
|
2613
2612
|
* with <code>adminUsername</code>.</p>
|
|
2614
2613
|
* <p>You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true. </p>
|
|
2614
|
+
* @public
|
|
2615
2615
|
*/
|
|
2616
2616
|
adminUserPassword?: string;
|
|
2617
2617
|
/**
|
|
2618
|
-
* @public
|
|
2619
2618
|
* <p>The username of the administrator for the first database created in the namespace. This parameter must be updated
|
|
2620
2619
|
* together with <code>adminUserPassword</code>.</p>
|
|
2620
|
+
* @public
|
|
2621
2621
|
*/
|
|
2622
2622
|
adminUsername?: string;
|
|
2623
2623
|
/**
|
|
2624
|
-
* @public
|
|
2625
2624
|
* <p>The ID of the Amazon Web Services Key Management Service key used to encrypt your data.</p>
|
|
2625
|
+
* @public
|
|
2626
2626
|
*/
|
|
2627
2627
|
kmsKeyId?: string;
|
|
2628
2628
|
/**
|
|
2629
|
-
* @public
|
|
2630
2629
|
* <p>The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together
|
|
2631
2630
|
* with <code>iamRoles</code>.</p>
|
|
2631
|
+
* @public
|
|
2632
2632
|
*/
|
|
2633
2633
|
defaultIamRoleArn?: string;
|
|
2634
2634
|
/**
|
|
2635
|
-
* @public
|
|
2636
2635
|
* <p>A list of IAM roles to associate with the namespace. This parameter must be updated together with <code>defaultIamRoleArn</code>.</p>
|
|
2636
|
+
* @public
|
|
2637
2637
|
*/
|
|
2638
2638
|
iamRoles?: string[];
|
|
2639
2639
|
/**
|
|
2640
|
-
* @public
|
|
2641
2640
|
* <p>The types of logs the namespace can export. The export types are <code>userlog</code>, <code>connectionlog</code>, and <code>useractivitylog</code>.</p>
|
|
2641
|
+
* @public
|
|
2642
2642
|
*/
|
|
2643
2643
|
logExports?: LogExport[];
|
|
2644
2644
|
/**
|
|
2645
|
-
* @public
|
|
2646
2645
|
* <p>If <code>true</code>, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials.
|
|
2647
2646
|
* You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true.
|
|
2648
2647
|
* If <code>manageAdminPassword</code> is false or not set, Amazon Redshift uses
|
|
2649
2648
|
* <code>adminUserPassword</code> for the admin user account's password.
|
|
2650
2649
|
* </p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
manageAdminPassword?: boolean;
|
|
2653
2653
|
/**
|
|
2654
|
-
* @public
|
|
2655
2654
|
* <p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
|
|
2656
2655
|
* You can only use this parameter if <code>manageAdminPassword</code> is true.</p>
|
|
2656
|
+
* @public
|
|
2657
2657
|
*/
|
|
2658
2658
|
adminPasswordSecretKmsKeyId?: string;
|
|
2659
2659
|
}
|
|
@@ -2662,8 +2662,8 @@ export interface UpdateNamespaceRequest {
|
|
|
2662
2662
|
*/
|
|
2663
2663
|
export interface UpdateNamespaceResponse {
|
|
2664
2664
|
/**
|
|
2665
|
-
* @public
|
|
2666
2665
|
* <p>A list of tag instances.</p>
|
|
2666
|
+
* @public
|
|
2667
2667
|
*/
|
|
2668
2668
|
namespace: Namespace | undefined;
|
|
2669
2669
|
}
|
|
@@ -2672,12 +2672,11 @@ export interface UpdateNamespaceResponse {
|
|
|
2672
2672
|
*/
|
|
2673
2673
|
export interface PutResourcePolicyRequest {
|
|
2674
2674
|
/**
|
|
2675
|
-
* @public
|
|
2676
2675
|
* <p>The Amazon Resource Name (ARN) of the account to create or update a resource policy for.</p>
|
|
2676
|
+
* @public
|
|
2677
2677
|
*/
|
|
2678
2678
|
resourceArn: string | undefined;
|
|
2679
2679
|
/**
|
|
2680
|
-
* @public
|
|
2681
2680
|
* <p>The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.</p>
|
|
2682
2681
|
* <p>
|
|
2683
2682
|
* <code>"\{\"Version\": \"2012-10-17\", \"Statement\" :
|
|
@@ -2685,6 +2684,7 @@ export interface PutResourcePolicyRequest {
|
|
|
2685
2684
|
* [\"739247239426\"]\}, \"Action\": [\"redshift-serverless:RestoreFromSnapshot\"]
|
|
2686
2685
|
* , \"Effect\": \"Allow\" \}]\}"</code>
|
|
2687
2686
|
* </p>
|
|
2687
|
+
* @public
|
|
2688
2688
|
*/
|
|
2689
2689
|
policy: string | undefined;
|
|
2690
2690
|
}
|
|
@@ -2693,8 +2693,8 @@ export interface PutResourcePolicyRequest {
|
|
|
2693
2693
|
*/
|
|
2694
2694
|
export interface PutResourcePolicyResponse {
|
|
2695
2695
|
/**
|
|
2696
|
-
* @public
|
|
2697
2696
|
* <p>The policy that was created or updated.</p>
|
|
2697
|
+
* @public
|
|
2698
2698
|
*/
|
|
2699
2699
|
resourcePolicy?: ResourcePolicy;
|
|
2700
2700
|
}
|
|
@@ -2703,18 +2703,18 @@ export interface PutResourcePolicyResponse {
|
|
|
2703
2703
|
*/
|
|
2704
2704
|
export interface RestoreFromRecoveryPointRequest {
|
|
2705
2705
|
/**
|
|
2706
|
-
* @public
|
|
2707
2706
|
* <p>The unique identifier of the recovery point to restore from.</p>
|
|
2707
|
+
* @public
|
|
2708
2708
|
*/
|
|
2709
2709
|
recoveryPointId: string | undefined;
|
|
2710
2710
|
/**
|
|
2711
|
-
* @public
|
|
2712
2711
|
* <p>The name of the namespace to restore data into.</p>
|
|
2712
|
+
* @public
|
|
2713
2713
|
*/
|
|
2714
2714
|
namespaceName: string | undefined;
|
|
2715
2715
|
/**
|
|
2716
|
-
* @public
|
|
2717
2716
|
* <p>The name of the workgroup used to restore data.</p>
|
|
2717
|
+
* @public
|
|
2718
2718
|
*/
|
|
2719
2719
|
workgroupName: string | undefined;
|
|
2720
2720
|
}
|
|
@@ -2723,13 +2723,13 @@ export interface RestoreFromRecoveryPointRequest {
|
|
|
2723
2723
|
*/
|
|
2724
2724
|
export interface RestoreFromRecoveryPointResponse {
|
|
2725
2725
|
/**
|
|
2726
|
-
* @public
|
|
2727
2726
|
* <p>The unique identifier of the recovery point used for the restore.</p>
|
|
2727
|
+
* @public
|
|
2728
2728
|
*/
|
|
2729
2729
|
recoveryPointId?: string;
|
|
2730
2730
|
/**
|
|
2731
|
-
* @public
|
|
2732
2731
|
* <p>The namespace that data was restored into.</p>
|
|
2732
|
+
* @public
|
|
2733
2733
|
*/
|
|
2734
2734
|
namespace?: Namespace;
|
|
2735
2735
|
}
|
|
@@ -2738,53 +2738,53 @@ export interface RestoreFromRecoveryPointResponse {
|
|
|
2738
2738
|
*/
|
|
2739
2739
|
export interface RestoreTableFromRecoveryPointRequest {
|
|
2740
2740
|
/**
|
|
2741
|
-
* @public
|
|
2742
2741
|
* <p>Namespace of the recovery point to restore from.</p>
|
|
2742
|
+
* @public
|
|
2743
2743
|
*/
|
|
2744
2744
|
namespaceName: string | undefined;
|
|
2745
2745
|
/**
|
|
2746
|
-
* @public
|
|
2747
2746
|
* <p>The workgroup to restore the table to.</p>
|
|
2747
|
+
* @public
|
|
2748
2748
|
*/
|
|
2749
2749
|
workgroupName: string | undefined;
|
|
2750
2750
|
/**
|
|
2751
|
-
* @public
|
|
2752
2751
|
* <p>The ID of the recovery point to restore the table from.</p>
|
|
2752
|
+
* @public
|
|
2753
2753
|
*/
|
|
2754
2754
|
recoveryPointId: string | undefined;
|
|
2755
2755
|
/**
|
|
2756
|
-
* @public
|
|
2757
2756
|
* <p>The name of the source database that contains the table being restored.</p>
|
|
2757
|
+
* @public
|
|
2758
2758
|
*/
|
|
2759
2759
|
sourceDatabaseName: string | undefined;
|
|
2760
2760
|
/**
|
|
2761
|
-
* @public
|
|
2762
2761
|
* <p>The name of the source schema that contains the table being restored.</p>
|
|
2762
|
+
* @public
|
|
2763
2763
|
*/
|
|
2764
2764
|
sourceSchemaName?: string;
|
|
2765
2765
|
/**
|
|
2766
|
-
* @public
|
|
2767
2766
|
* <p>The name of the source table being restored.</p>
|
|
2767
|
+
* @public
|
|
2768
2768
|
*/
|
|
2769
2769
|
sourceTableName: string | undefined;
|
|
2770
2770
|
/**
|
|
2771
|
-
* @public
|
|
2772
2771
|
* <p>The name of the database to restore the table to.</p>
|
|
2772
|
+
* @public
|
|
2773
2773
|
*/
|
|
2774
2774
|
targetDatabaseName?: string;
|
|
2775
2775
|
/**
|
|
2776
|
-
* @public
|
|
2777
2776
|
* <p>The name of the schema to restore the table to.</p>
|
|
2777
|
+
* @public
|
|
2778
2778
|
*/
|
|
2779
2779
|
targetSchemaName?: string;
|
|
2780
2780
|
/**
|
|
2781
|
-
* @public
|
|
2782
2781
|
* <p>The name of the table to create from the restore operation.</p>
|
|
2782
|
+
* @public
|
|
2783
2783
|
*/
|
|
2784
2784
|
newTableName: string | undefined;
|
|
2785
2785
|
/**
|
|
2786
|
-
* @public
|
|
2787
2786
|
* <p>Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.</p>
|
|
2787
|
+
* @public
|
|
2788
2788
|
*/
|
|
2789
2789
|
activateCaseSensitiveIdentifier?: boolean;
|
|
2790
2790
|
}
|
|
@@ -2793,8 +2793,8 @@ export interface RestoreTableFromRecoveryPointRequest {
|
|
|
2793
2793
|
*/
|
|
2794
2794
|
export interface RestoreTableFromRecoveryPointResponse {
|
|
2795
2795
|
/**
|
|
2796
|
-
* @public
|
|
2797
2796
|
* <p>Contains information about a table restore request.</p>
|
|
2797
|
+
* @public
|
|
2798
2798
|
*/
|
|
2799
2799
|
tableRestoreStatus?: TableRestoreStatus;
|
|
2800
2800
|
}
|
|
@@ -2803,52 +2803,52 @@ export interface RestoreTableFromRecoveryPointResponse {
|
|
|
2803
2803
|
*/
|
|
2804
2804
|
export interface UpdateScheduledActionRequest {
|
|
2805
2805
|
/**
|
|
2806
|
-
* @public
|
|
2807
2806
|
* <p>The name of the scheduled action to update to.</p>
|
|
2807
|
+
* @public
|
|
2808
2808
|
*/
|
|
2809
2809
|
scheduledActionName: string | undefined;
|
|
2810
2810
|
/**
|
|
2811
|
-
* @public
|
|
2812
2811
|
* <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
|
|
2813
2812
|
* <p>
|
|
2814
2813
|
* <code>"\{"CreateSnapshot": \{"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"\}\}"</code>
|
|
2815
2814
|
* </p>
|
|
2815
|
+
* @public
|
|
2816
2816
|
*/
|
|
2817
2817
|
targetAction?: TargetAction;
|
|
2818
2818
|
/**
|
|
2819
|
-
* @public
|
|
2820
2819
|
* <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p>
|
|
2821
2820
|
* <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p>
|
|
2822
2821
|
* <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see
|
|
2823
2822
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>
|
|
2823
|
+
* @public
|
|
2824
2824
|
*/
|
|
2825
2825
|
schedule?: Schedule;
|
|
2826
2826
|
/**
|
|
2827
|
-
* @public
|
|
2828
2827
|
* <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action.
|
|
2829
2828
|
* This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.
|
|
2830
2829
|
* For more information about the IAM role to use with the Amazon Redshift scheduler, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for
|
|
2831
2830
|
* Amazon Redshift</a> in the Amazon Redshift Cluster Management Guide</p>
|
|
2831
|
+
* @public
|
|
2832
2832
|
*/
|
|
2833
2833
|
roleArn?: string;
|
|
2834
2834
|
/**
|
|
2835
|
-
* @public
|
|
2836
2835
|
* <p>Specifies whether to enable the scheduled action.</p>
|
|
2836
|
+
* @public
|
|
2837
2837
|
*/
|
|
2838
2838
|
enabled?: boolean;
|
|
2839
2839
|
/**
|
|
2840
|
-
* @public
|
|
2841
2840
|
* <p>The descripion of the scheduled action to update to.</p>
|
|
2841
|
+
* @public
|
|
2842
2842
|
*/
|
|
2843
2843
|
scheduledActionDescription?: string;
|
|
2844
2844
|
/**
|
|
2845
|
-
* @public
|
|
2846
2845
|
* <p>The start time in UTC of the scheduled action to update to.</p>
|
|
2846
|
+
* @public
|
|
2847
2847
|
*/
|
|
2848
2848
|
startTime?: Date;
|
|
2849
2849
|
/**
|
|
2850
|
-
* @public
|
|
2851
2850
|
* <p>The end time in UTC of the scheduled action to update.</p>
|
|
2851
|
+
* @public
|
|
2852
2852
|
*/
|
|
2853
2853
|
endTime?: Date;
|
|
2854
2854
|
}
|
|
@@ -2857,8 +2857,8 @@ export interface UpdateScheduledActionRequest {
|
|
|
2857
2857
|
*/
|
|
2858
2858
|
export interface UpdateScheduledActionResponse {
|
|
2859
2859
|
/**
|
|
2860
|
-
* @public
|
|
2861
2860
|
* <p>The ScheduledAction object that was updated.</p>
|
|
2861
|
+
* @public
|
|
2862
2862
|
*/
|
|
2863
2863
|
scheduledAction?: ScheduledActionResponse;
|
|
2864
2864
|
}
|
|
@@ -2867,43 +2867,43 @@ export interface UpdateScheduledActionResponse {
|
|
|
2867
2867
|
*/
|
|
2868
2868
|
export interface RestoreFromSnapshotRequest {
|
|
2869
2869
|
/**
|
|
2870
|
-
* @public
|
|
2871
2870
|
* <p>The name of the namespace to restore the snapshot to.</p>
|
|
2871
|
+
* @public
|
|
2872
2872
|
*/
|
|
2873
2873
|
namespaceName: string | undefined;
|
|
2874
2874
|
/**
|
|
2875
|
-
* @public
|
|
2876
2875
|
* <p>The name of the workgroup used to restore the snapshot.</p>
|
|
2876
|
+
* @public
|
|
2877
2877
|
*/
|
|
2878
2878
|
workgroupName: string | undefined;
|
|
2879
2879
|
/**
|
|
2880
|
-
* @public
|
|
2881
2880
|
* <p>The name of the snapshot to restore from. Must not be specified at the same time as <code>snapshotArn</code>.</p>
|
|
2881
|
+
* @public
|
|
2882
2882
|
*/
|
|
2883
2883
|
snapshotName?: string;
|
|
2884
2884
|
/**
|
|
2885
|
-
* @public
|
|
2886
2885
|
* <p>The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster.
|
|
2887
2886
|
* Must not be specified at the same time as <code>snapshotName</code>.</p>
|
|
2888
2887
|
* <p>The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.</p>
|
|
2888
|
+
* @public
|
|
2889
2889
|
*/
|
|
2890
2890
|
snapshotArn?: string;
|
|
2891
2891
|
/**
|
|
2892
|
-
* @public
|
|
2893
2892
|
* <p>The Amazon Web Services account that owns the snapshot.</p>
|
|
2893
|
+
* @public
|
|
2894
2894
|
*/
|
|
2895
2895
|
ownerAccount?: string;
|
|
2896
2896
|
/**
|
|
2897
|
-
* @public
|
|
2898
2897
|
* <p>If <code>true</code>, Amazon Redshift uses Secrets Manager to manage the restored
|
|
2899
2898
|
* snapshot's admin credentials. If <code>MmanageAdminPassword</code> is false or not set,
|
|
2900
2899
|
* Amazon Redshift uses the admin credentials that the namespace or cluster
|
|
2901
2900
|
* had at the time the snapshot was taken.</p>
|
|
2901
|
+
* @public
|
|
2902
2902
|
*/
|
|
2903
2903
|
manageAdminPassword?: boolean;
|
|
2904
2904
|
/**
|
|
2905
|
-
* @public
|
|
2906
2905
|
* <p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.</p>
|
|
2906
|
+
* @public
|
|
2907
2907
|
*/
|
|
2908
2908
|
adminPasswordSecretKmsKeyId?: string;
|
|
2909
2909
|
}
|
|
@@ -2912,18 +2912,18 @@ export interface RestoreFromSnapshotRequest {
|
|
|
2912
2912
|
*/
|
|
2913
2913
|
export interface RestoreFromSnapshotResponse {
|
|
2914
2914
|
/**
|
|
2915
|
-
* @public
|
|
2916
2915
|
* <p>The name of the snapshot used to restore the namespace.</p>
|
|
2916
|
+
* @public
|
|
2917
2917
|
*/
|
|
2918
2918
|
snapshotName?: string;
|
|
2919
2919
|
/**
|
|
2920
|
-
* @public
|
|
2921
2920
|
* <p>The owner Amazon Web Services; account of the snapshot that was restored.</p>
|
|
2921
|
+
* @public
|
|
2922
2922
|
*/
|
|
2923
2923
|
ownerAccount?: string;
|
|
2924
2924
|
/**
|
|
2925
|
-
* @public
|
|
2926
2925
|
* <p>A collection of database objects and users.</p>
|
|
2926
|
+
* @public
|
|
2927
2927
|
*/
|
|
2928
2928
|
namespace?: Namespace;
|
|
2929
2929
|
}
|
|
@@ -2932,55 +2932,55 @@ export interface RestoreFromSnapshotResponse {
|
|
|
2932
2932
|
*/
|
|
2933
2933
|
export interface RestoreTableFromSnapshotRequest {
|
|
2934
2934
|
/**
|
|
2935
|
-
* @public
|
|
2936
2935
|
* <p>The namespace of the snapshot to restore from.</p>
|
|
2936
|
+
* @public
|
|
2937
2937
|
*/
|
|
2938
2938
|
namespaceName: string | undefined;
|
|
2939
2939
|
/**
|
|
2940
|
-
* @public
|
|
2941
2940
|
* <p>The workgroup to restore the table to.</p>
|
|
2941
|
+
* @public
|
|
2942
2942
|
*/
|
|
2943
2943
|
workgroupName: string | undefined;
|
|
2944
2944
|
/**
|
|
2945
|
-
* @public
|
|
2946
2945
|
* <p>The name of the snapshot to restore the table from.</p>
|
|
2946
|
+
* @public
|
|
2947
2947
|
*/
|
|
2948
2948
|
snapshotName: string | undefined;
|
|
2949
2949
|
/**
|
|
2950
|
-
* @public
|
|
2951
2950
|
* <p>The name of the source database that contains the table being restored.</p>
|
|
2951
|
+
* @public
|
|
2952
2952
|
*/
|
|
2953
2953
|
sourceDatabaseName: string | undefined;
|
|
2954
2954
|
/**
|
|
2955
|
-
* @public
|
|
2956
2955
|
* <p>The name of the source schema that contains the table being restored.</p>
|
|
2956
|
+
* @public
|
|
2957
2957
|
*/
|
|
2958
2958
|
sourceSchemaName?: string;
|
|
2959
2959
|
/**
|
|
2960
|
-
* @public
|
|
2961
2960
|
* <p>The name of the source table being restored.</p>
|
|
2961
|
+
* @public
|
|
2962
2962
|
*/
|
|
2963
2963
|
sourceTableName: string | undefined;
|
|
2964
2964
|
/**
|
|
2965
|
-
* @public
|
|
2966
2965
|
* <p>The name of the database to restore the table to.</p>
|
|
2966
|
+
* @public
|
|
2967
2967
|
*/
|
|
2968
2968
|
targetDatabaseName?: string;
|
|
2969
2969
|
/**
|
|
2970
|
-
* @public
|
|
2971
2970
|
* <p>The name of the schema to restore the table to.</p>
|
|
2971
|
+
* @public
|
|
2972
2972
|
*/
|
|
2973
2973
|
targetSchemaName?: string;
|
|
2974
2974
|
/**
|
|
2975
|
-
* @public
|
|
2976
2975
|
* <p>The name of the table to create from the restore operation.</p>
|
|
2976
|
+
* @public
|
|
2977
2977
|
*/
|
|
2978
2978
|
newTableName: string | undefined;
|
|
2979
2979
|
/**
|
|
2980
|
-
* @public
|
|
2981
2980
|
* <p>Indicates whether name identifiers for database, schema, and table
|
|
2982
2981
|
* are case sensitive. If true, the names are case sensitive. If
|
|
2983
2982
|
* false, the names are not case sensitive. The default is false.</p>
|
|
2983
|
+
* @public
|
|
2984
2984
|
*/
|
|
2985
2985
|
activateCaseSensitiveIdentifier?: boolean;
|
|
2986
2986
|
}
|
|
@@ -2989,8 +2989,8 @@ export interface RestoreTableFromSnapshotRequest {
|
|
|
2989
2989
|
*/
|
|
2990
2990
|
export interface RestoreTableFromSnapshotResponse {
|
|
2991
2991
|
/**
|
|
2992
|
-
* @public
|
|
2993
2992
|
* <p>The TableRestoreStatus object that contains the status of the restore operation.</p>
|
|
2993
|
+
* @public
|
|
2994
2994
|
*/
|
|
2995
2995
|
tableRestoreStatus?: TableRestoreStatus;
|
|
2996
2996
|
}
|
|
@@ -2999,13 +2999,13 @@ export interface RestoreTableFromSnapshotResponse {
|
|
|
2999
2999
|
*/
|
|
3000
3000
|
export interface UpdateSnapshotRequest {
|
|
3001
3001
|
/**
|
|
3002
|
-
* @public
|
|
3003
3002
|
* <p>The name of the snapshot.</p>
|
|
3003
|
+
* @public
|
|
3004
3004
|
*/
|
|
3005
3005
|
snapshotName: string | undefined;
|
|
3006
3006
|
/**
|
|
3007
|
-
* @public
|
|
3008
3007
|
* <p>The new retention period of the snapshot.</p>
|
|
3008
|
+
* @public
|
|
3009
3009
|
*/
|
|
3010
3010
|
retentionPeriod?: number;
|
|
3011
3011
|
}
|
|
@@ -3014,8 +3014,8 @@ export interface UpdateSnapshotRequest {
|
|
|
3014
3014
|
*/
|
|
3015
3015
|
export interface UpdateSnapshotResponse {
|
|
3016
3016
|
/**
|
|
3017
|
-
* @public
|
|
3018
3017
|
* <p>The updated snapshot object.</p>
|
|
3018
|
+
* @public
|
|
3019
3019
|
*/
|
|
3020
3020
|
snapshot?: Snapshot;
|
|
3021
3021
|
}
|
|
@@ -3024,13 +3024,13 @@ export interface UpdateSnapshotResponse {
|
|
|
3024
3024
|
*/
|
|
3025
3025
|
export interface UpdateSnapshotCopyConfigurationRequest {
|
|
3026
3026
|
/**
|
|
3027
|
-
* @public
|
|
3028
3027
|
* <p>The ID of the snapshot copy configuration to update.</p>
|
|
3028
|
+
* @public
|
|
3029
3029
|
*/
|
|
3030
3030
|
snapshotCopyConfigurationId: string | undefined;
|
|
3031
3031
|
/**
|
|
3032
|
-
* @public
|
|
3033
3032
|
* <p>The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.</p>
|
|
3033
|
+
* @public
|
|
3034
3034
|
*/
|
|
3035
3035
|
snapshotRetentionPeriod?: number;
|
|
3036
3036
|
}
|
|
@@ -3039,8 +3039,8 @@ export interface UpdateSnapshotCopyConfigurationRequest {
|
|
|
3039
3039
|
*/
|
|
3040
3040
|
export interface UpdateSnapshotCopyConfigurationResponse {
|
|
3041
3041
|
/**
|
|
3042
|
-
* @public
|
|
3043
3042
|
* <p>The updated snapshot copy configuration object.</p>
|
|
3043
|
+
* @public
|
|
3044
3044
|
*/
|
|
3045
3045
|
snapshotCopyConfiguration: SnapshotCopyConfiguration | undefined;
|
|
3046
3046
|
}
|
|
@@ -3049,13 +3049,13 @@ export interface UpdateSnapshotCopyConfigurationResponse {
|
|
|
3049
3049
|
*/
|
|
3050
3050
|
export interface TagResourceRequest {
|
|
3051
3051
|
/**
|
|
3052
|
-
* @public
|
|
3053
3052
|
* <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
|
|
3053
|
+
* @public
|
|
3054
3054
|
*/
|
|
3055
3055
|
resourceArn: string | undefined;
|
|
3056
3056
|
/**
|
|
3057
|
-
* @public
|
|
3058
3057
|
* <p>The map of the key-value pairs used to tag the resource.</p>
|
|
3058
|
+
* @public
|
|
3059
3059
|
*/
|
|
3060
3060
|
tags: Tag[] | undefined;
|
|
3061
3061
|
}
|
|
@@ -3069,13 +3069,13 @@ export interface TagResourceResponse {
|
|
|
3069
3069
|
*/
|
|
3070
3070
|
export interface UntagResourceRequest {
|
|
3071
3071
|
/**
|
|
3072
|
-
* @public
|
|
3073
3072
|
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
|
|
3073
|
+
* @public
|
|
3074
3074
|
*/
|
|
3075
3075
|
resourceArn: string | undefined;
|
|
3076
3076
|
/**
|
|
3077
|
-
* @public
|
|
3078
3077
|
* <p>The tag or set of tags to remove from the resource.</p>
|
|
3078
|
+
* @public
|
|
3079
3079
|
*/
|
|
3080
3080
|
tagKeys: string[] | undefined;
|
|
3081
3081
|
}
|
|
@@ -3089,18 +3089,18 @@ export interface UntagResourceResponse {
|
|
|
3089
3089
|
*/
|
|
3090
3090
|
export interface UpdateCustomDomainAssociationRequest {
|
|
3091
3091
|
/**
|
|
3092
|
-
* @public
|
|
3093
3092
|
* <p>The name of the workgroup associated with the database.</p>
|
|
3093
|
+
* @public
|
|
3094
3094
|
*/
|
|
3095
3095
|
workgroupName: string | undefined;
|
|
3096
3096
|
/**
|
|
3097
|
-
* @public
|
|
3098
3097
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
3098
|
+
* @public
|
|
3099
3099
|
*/
|
|
3100
3100
|
customDomainName: string | undefined;
|
|
3101
3101
|
/**
|
|
3102
|
-
* @public
|
|
3103
3102
|
* <p>The custom domain name’s certificate Amazon resource name (ARN). This is optional.</p>
|
|
3103
|
+
* @public
|
|
3104
3104
|
*/
|
|
3105
3105
|
customDomainCertificateArn: string | undefined;
|
|
3106
3106
|
}
|
|
@@ -3109,23 +3109,23 @@ export interface UpdateCustomDomainAssociationRequest {
|
|
|
3109
3109
|
*/
|
|
3110
3110
|
export interface UpdateCustomDomainAssociationResponse {
|
|
3111
3111
|
/**
|
|
3112
|
-
* @public
|
|
3113
3112
|
* <p>The custom domain name associated with the workgroup.</p>
|
|
3113
|
+
* @public
|
|
3114
3114
|
*/
|
|
3115
3115
|
customDomainName?: string;
|
|
3116
3116
|
/**
|
|
3117
|
-
* @public
|
|
3118
3117
|
* <p>The name of the workgroup associated with the database.</p>
|
|
3118
|
+
* @public
|
|
3119
3119
|
*/
|
|
3120
3120
|
workgroupName?: string;
|
|
3121
3121
|
/**
|
|
3122
|
-
* @public
|
|
3123
3122
|
* <p>The custom domain name’s certificate Amazon resource name (ARN).</p>
|
|
3123
|
+
* @public
|
|
3124
3124
|
*/
|
|
3125
3125
|
customDomainCertificateArn?: string;
|
|
3126
3126
|
/**
|
|
3127
|
-
* @public
|
|
3128
3127
|
* <p>The expiration time for the certificate.</p>
|
|
3128
|
+
* @public
|
|
3129
3129
|
*/
|
|
3130
3130
|
customDomainCertificateExpiryTime?: Date;
|
|
3131
3131
|
}
|
|
@@ -3134,20 +3134,20 @@ export interface UpdateCustomDomainAssociationResponse {
|
|
|
3134
3134
|
*/
|
|
3135
3135
|
export interface UpdateUsageLimitRequest {
|
|
3136
3136
|
/**
|
|
3137
|
-
* @public
|
|
3138
3137
|
* <p>The identifier of the usage limit to update.</p>
|
|
3138
|
+
* @public
|
|
3139
3139
|
*/
|
|
3140
3140
|
usageLimitId: string | undefined;
|
|
3141
3141
|
/**
|
|
3142
|
-
* @public
|
|
3143
3142
|
* <p>The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour.
|
|
3144
3143
|
* If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing.
|
|
3145
3144
|
* The value must be a positive number.</p>
|
|
3145
|
+
* @public
|
|
3146
3146
|
*/
|
|
3147
3147
|
amount?: number;
|
|
3148
3148
|
/**
|
|
3149
|
-
* @public
|
|
3150
3149
|
* <p>The new action that Amazon Redshift Serverless takes when the limit is reached.</p>
|
|
3150
|
+
* @public
|
|
3151
3151
|
*/
|
|
3152
3152
|
breachAction?: UsageLimitBreachAction;
|
|
3153
3153
|
}
|
|
@@ -3156,8 +3156,8 @@ export interface UpdateUsageLimitRequest {
|
|
|
3156
3156
|
*/
|
|
3157
3157
|
export interface UpdateUsageLimitResponse {
|
|
3158
3158
|
/**
|
|
3159
|
-
* @public
|
|
3160
3159
|
* <p>The updated usage limit object.</p>
|
|
3160
|
+
* @public
|
|
3161
3161
|
*/
|
|
3162
3162
|
usageLimit?: UsageLimit;
|
|
3163
3163
|
}
|
|
@@ -3166,54 +3166,54 @@ export interface UpdateUsageLimitResponse {
|
|
|
3166
3166
|
*/
|
|
3167
3167
|
export interface UpdateWorkgroupRequest {
|
|
3168
3168
|
/**
|
|
3169
|
-
* @public
|
|
3170
3169
|
* <p>The name of the workgroup to update. You can't update the name of a workgroup once it is created.</p>
|
|
3170
|
+
* @public
|
|
3171
3171
|
*/
|
|
3172
3172
|
workgroupName: string | undefined;
|
|
3173
3173
|
/**
|
|
3174
|
-
* @public
|
|
3175
3174
|
* <p>The new base data warehouse capacity in Redshift Processing Units (RPUs).</p>
|
|
3175
|
+
* @public
|
|
3176
3176
|
*/
|
|
3177
3177
|
baseCapacity?: number;
|
|
3178
3178
|
/**
|
|
3179
|
-
* @public
|
|
3180
3179
|
* <p>The value that specifies whether to turn on enhanced virtual
|
|
3181
3180
|
* private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.</p>
|
|
3181
|
+
* @public
|
|
3182
3182
|
*/
|
|
3183
3183
|
enhancedVpcRouting?: boolean;
|
|
3184
3184
|
/**
|
|
3185
|
-
* @public
|
|
3186
3185
|
* <p>An array of parameters to set for advanced control over a database. The
|
|
3187
3186
|
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitive_identifier</code>, <code>enable_user_activity_logging</code>,
|
|
3188
3187
|
* <code>query_group</code>, <code>search_path</code>, <code>require_ssl</code>, and query monitoring metrics that let you
|
|
3189
3188
|
* define performance boundaries. For more information about query monitoring rules and available metrics, see
|
|
3190
3189
|
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless">
|
|
3191
3190
|
* Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
|
|
3191
|
+
* @public
|
|
3192
3192
|
*/
|
|
3193
3193
|
configParameters?: ConfigParameter[];
|
|
3194
3194
|
/**
|
|
3195
|
-
* @public
|
|
3196
3195
|
* <p>A value that specifies whether the workgroup can be accessible from a public network.</p>
|
|
3196
|
+
* @public
|
|
3197
3197
|
*/
|
|
3198
3198
|
publiclyAccessible?: boolean;
|
|
3199
3199
|
/**
|
|
3200
|
-
* @public
|
|
3201
3200
|
* <p>An array of VPC subnet IDs to associate with the workgroup.</p>
|
|
3201
|
+
* @public
|
|
3202
3202
|
*/
|
|
3203
3203
|
subnetIds?: string[];
|
|
3204
3204
|
/**
|
|
3205
|
-
* @public
|
|
3206
3205
|
* <p>An array of security group IDs to associate with the workgroup.</p>
|
|
3206
|
+
* @public
|
|
3207
3207
|
*/
|
|
3208
3208
|
securityGroupIds?: string[];
|
|
3209
3209
|
/**
|
|
3210
|
-
* @public
|
|
3211
3210
|
* <p>The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.</p>
|
|
3211
|
+
* @public
|
|
3212
3212
|
*/
|
|
3213
3213
|
port?: number;
|
|
3214
3214
|
/**
|
|
3215
|
-
* @public
|
|
3216
3215
|
* <p>The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.</p>
|
|
3216
|
+
* @public
|
|
3217
3217
|
*/
|
|
3218
3218
|
maxCapacity?: number;
|
|
3219
3219
|
}
|
|
@@ -3222,8 +3222,8 @@ export interface UpdateWorkgroupRequest {
|
|
|
3222
3222
|
*/
|
|
3223
3223
|
export interface UpdateWorkgroupResponse {
|
|
3224
3224
|
/**
|
|
3225
|
-
* @public
|
|
3226
3225
|
* <p>The updated workgroup object.</p>
|
|
3226
|
+
* @public
|
|
3227
3227
|
*/
|
|
3228
3228
|
workgroup: Workgroup | undefined;
|
|
3229
3229
|
}
|