💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2024-09-29 at 00:40:58. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2023-01-29)
-=-=-=-=-=-=-
dms.d.ts (67823B)
1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare class DMS extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: DMS.Types.ClientConfiguration)
13 config: Config & DMS.Types.ClientConfiguration;
14 /**
15 * Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.
16 */
17 addTagsToResource(params: DMS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
18 /**
19 * Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.
20 */
21 addTagsToResource(callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
22 /**
23 * Creates an endpoint using the provided settings.
24 */
25 createEndpoint(params: DMS.Types.CreateEndpointMessage, callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
26 /**
27 * Creates an endpoint using the provided settings.
28 */
29 createEndpoint(callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
30 /**
31 * Creates the replication instance using the specified parameters.
32 */
33 createReplicationInstance(params: DMS.Types.CreateReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
34 /**
35 * Creates the replication instance using the specified parameters.
36 */
37 createReplicationInstance(callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
38 /**
39 * Creates a replication subnet group given a list of the subnet IDs in a VPC.
40 */
41 createReplicationSubnetGroup(params: DMS.Types.CreateReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request<DMS.Types.CreateReplicationSubnetGroupResponse, AWSError>;
42 /**
43 * Creates a replication subnet group given a list of the subnet IDs in a VPC.
44 */
45 createReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request<DMS.Types.CreateReplicationSubnetGroupResponse, AWSError>;
46 /**
47 * Creates a replication task using the specified parameters.
48 */
49 createReplicationTask(params: DMS.Types.CreateReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request<DMS.Types.CreateReplicationTaskResponse, AWSError>;
50 /**
51 * Creates a replication task using the specified parameters.
52 */
53 createReplicationTask(callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request<DMS.Types.CreateReplicationTaskResponse, AWSError>;
54 /**
55 * Deletes the specified certificate.
56 */
57 deleteCertificate(params: DMS.Types.DeleteCertificateMessage, callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request<DMS.Types.DeleteCertificateResponse, AWSError>;
58 /**
59 * Deletes the specified certificate.
60 */
61 deleteCertificate(callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request<DMS.Types.DeleteCertificateResponse, AWSError>;
62 /**
63 * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
64 */
65 deleteEndpoint(params: DMS.Types.DeleteEndpointMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
66 /**
67 * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
68 */
69 deleteEndpoint(callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
70 /**
71 * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
72 */
73 deleteReplicationInstance(params: DMS.Types.DeleteReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request<DMS.Types.DeleteReplicationInstanceResponse, AWSError>;
74 /**
75 * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
76 */
77 deleteReplicationInstance(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request<DMS.Types.DeleteReplicationInstanceResponse, AWSError>;
78 /**
79 * Deletes a subnet group.
80 */
81 deleteReplicationSubnetGroup(params: DMS.Types.DeleteReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request<DMS.Types.DeleteReplicationSubnetGroupResponse, AWSError>;
82 /**
83 * Deletes a subnet group.
84 */
85 deleteReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request<DMS.Types.DeleteReplicationSubnetGroupResponse, AWSError>;
86 /**
87 * Deletes the specified replication task.
88 */
89 deleteReplicationTask(params: DMS.Types.DeleteReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
90 /**
91 * Deletes the specified replication task.
92 */
93 deleteReplicationTask(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
94 /**
95 * Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters.
96 */
97 describeAccountAttributes(params: DMS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
98 /**
99 * Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters.
100 */
101 describeAccountAttributes(callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
102 /**
103 * Provides a description of the certificate.
104 */
105 describeCertificates(params: DMS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request<DMS.Types.DescribeCertificatesResponse, AWSError>;
106 /**
107 * Provides a description of the certificate.
108 */
109 describeCertificates(callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request<DMS.Types.DescribeCertificatesResponse, AWSError>;
110 /**
111 * Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
112 */
113 describeConnections(params: DMS.Types.DescribeConnectionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
114 /**
115 * Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
116 */
117 describeConnections(callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
118 /**
119 * Returns information about the type of endpoints available.
120 */
121 describeEndpointTypes(params: DMS.Types.DescribeEndpointTypesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request<DMS.Types.DescribeEndpointTypesResponse, AWSError>;
122 /**
123 * Returns information about the type of endpoints available.
124 */
125 describeEndpointTypes(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request<DMS.Types.DescribeEndpointTypesResponse, AWSError>;
126 /**
127 * Returns information about the endpoints for your account in the current region.
128 */
129 describeEndpoints(params: DMS.Types.DescribeEndpointsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
130 /**
131 * Returns information about the endpoints for your account in the current region.
132 */
133 describeEndpoints(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
134 /**
135 * Returns information about the replication instance types that can be created in the specified region.
136 */
137 describeOrderableReplicationInstances(params: DMS.Types.DescribeOrderableReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request<DMS.Types.DescribeOrderableReplicationInstancesResponse, AWSError>;
138 /**
139 * Returns information about the replication instance types that can be created in the specified region.
140 */
141 describeOrderableReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request<DMS.Types.DescribeOrderableReplicationInstancesResponse, AWSError>;
142 /**
143 * Returns the status of the RefreshSchemas operation.
144 */
145 describeRefreshSchemasStatus(params: DMS.Types.DescribeRefreshSchemasStatusMessage, callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request<DMS.Types.DescribeRefreshSchemasStatusResponse, AWSError>;
146 /**
147 * Returns the status of the RefreshSchemas operation.
148 */
149 describeRefreshSchemasStatus(callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request<DMS.Types.DescribeRefreshSchemasStatusResponse, AWSError>;
150 /**
151 * Returns information about replication instances for your account in the current region.
152 */
153 describeReplicationInstances(params: DMS.Types.DescribeReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
154 /**
155 * Returns information about replication instances for your account in the current region.
156 */
157 describeReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
158 /**
159 * Returns information about the replication subnet groups.
160 */
161 describeReplicationSubnetGroups(params: DMS.Types.DescribeReplicationSubnetGroupsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
162 /**
163 * Returns information about the replication subnet groups.
164 */
165 describeReplicationSubnetGroups(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
166 /**
167 * Returns information about replication tasks for your account in the current region.
168 */
169 describeReplicationTasks(params: DMS.Types.DescribeReplicationTasksMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
170 /**
171 * Returns information about replication tasks for your account in the current region.
172 */
173 describeReplicationTasks(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
174 /**
175 * Returns information about the schema for the specified endpoint.
176 */
177 describeSchemas(params: DMS.Types.DescribeSchemasMessage, callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
178 /**
179 * Returns information about the schema for the specified endpoint.
180 */
181 describeSchemas(callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
182 /**
183 * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
184 */
185 describeTableStatistics(params: DMS.Types.DescribeTableStatisticsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
186 /**
187 * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
188 */
189 describeTableStatistics(callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
190 /**
191 * Uploads the specified certificate.
192 */
193 importCertificate(params: DMS.Types.ImportCertificateMessage, callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
194 /**
195 * Uploads the specified certificate.
196 */
197 importCertificate(callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
198 /**
199 * Lists all tags for an AWS DMS resource.
200 */
201 listTagsForResource(params: DMS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
202 /**
203 * Lists all tags for an AWS DMS resource.
204 */
205 listTagsForResource(callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
206 /**
207 * Modifies the specified endpoint.
208 */
209 modifyEndpoint(params: DMS.Types.ModifyEndpointMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
210 /**
211 * Modifies the specified endpoint.
212 */
213 modifyEndpoint(callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
214 /**
215 * Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
216 */
217 modifyReplicationInstance(params: DMS.Types.ModifyReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request<DMS.Types.ModifyReplicationInstanceResponse, AWSError>;
218 /**
219 * Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
220 */
221 modifyReplicationInstance(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request<DMS.Types.ModifyReplicationInstanceResponse, AWSError>;
222 /**
223 * Modifies the settings for the specified replication subnet group.
224 */
225 modifyReplicationSubnetGroup(params: DMS.Types.ModifyReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
226 /**
227 * Modifies the settings for the specified replication subnet group.
228 */
229 modifyReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
230 /**
231 * Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
232 */
233 refreshSchemas(params: DMS.Types.RefreshSchemasMessage, callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request<DMS.Types.RefreshSchemasResponse, AWSError>;
234 /**
235 * Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
236 */
237 refreshSchemas(callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request<DMS.Types.RefreshSchemasResponse, AWSError>;
238 /**
239 * Removes metadata tags from a DMS resource.
240 */
241 removeTagsFromResource(params: DMS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
242 /**
243 * Removes metadata tags from a DMS resource.
244 */
245 removeTagsFromResource(callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
246 /**
247 * Starts the replication task.
248 */
249 startReplicationTask(params: DMS.Types.StartReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
250 /**
251 * Starts the replication task.
252 */
253 startReplicationTask(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
254 /**
255 * Stops the replication task.
256 */
257 stopReplicationTask(params: DMS.Types.StopReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request<DMS.Types.StopReplicationTaskResponse, AWSError>;
258 /**
259 * Stops the replication task.
260 */
261 stopReplicationTask(callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request<DMS.Types.StopReplicationTaskResponse, AWSError>;
262 /**
263 * Tests the connection between the replication instance and the endpoint.
264 */
265 testConnection(params: DMS.Types.TestConnectionMessage, callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request<DMS.Types.TestConnectionResponse, AWSError>;
266 /**
267 * Tests the connection between the replication instance and the endpoint.
268 */
269 testConnection(callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request<DMS.Types.TestConnectionResponse, AWSError>;
270 }
271 declare namespace DMS.Types {
272 export interface AccountQuota {
273 /**
274 * The name of the AWS DMS quota for this AWS account.
275 */
276 AccountQuotaName?: String;
277 /**
278 * The amount currently used toward the quota maximum.
279 */
280 Used?: Long;
281 /**
282 * The maximum allowed value for the quota.
283 */
284 Max?: Long;
285 }
286 export type AccountQuotaList = AccountQuota[];
287 export interface AddTagsToResourceMessage {
288 /**
289 * The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to. AWS DMS resources include a replication instance, endpoint, and a replication task.
290 */
291 ResourceArn: String;
292 /**
293 * The tag to be assigned to the DMS resource.
294 */
295 Tags: TagList;
296 }
297 export interface AddTagsToResourceResponse {
298 }
299 export interface AvailabilityZone {
300 /**
301 * The name of the availability zone.
302 */
303 Name?: String;
304 }
305 export type Boolean = boolean;
306 export type BooleanOptional = boolean;
307 export interface Certificate {
308 /**
309 * The customer-assigned name of the certificate. Valid characters are [A-z_0-9].
310 */
311 CertificateIdentifier?: String;
312 /**
313 * the date the certificate was created.
314 */
315 CertificateCreationDate?: TStamp;
316 /**
317 * The contents of the .pem X.509 certificate file.
318 */
319 CertificatePem?: String;
320 /**
321 * The Amazon Resource Name (ARN) for the certificate.
322 */
323 CertificateArn?: String;
324 /**
325 * The owner of the certificate.
326 */
327 CertificateOwner?: String;
328 /**
329 * The beginning date the certificate is valid.
330 */
331 ValidFromDate?: TStamp;
332 /**
333 * the final date the certificate is valid.
334 */
335 ValidToDate?: TStamp;
336 /**
337 * The signing algorithm for the certificate.
338 */
339 SigningAlgorithm?: String;
340 /**
341 * The key length of the cryptographic algorithm being used.
342 */
343 KeyLength?: IntegerOptional;
344 }
345 export type CertificateList = Certificate[];
346 export interface Connection {
347 /**
348 * The Amazon Resource Name (ARN) of the replication instance.
349 */
350 ReplicationInstanceArn?: String;
351 /**
352 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
353 */
354 EndpointArn?: String;
355 /**
356 * The connection status.
357 */
358 Status?: String;
359 /**
360 * The error message when the connection last failed.
361 */
362 LastFailureMessage?: String;
363 /**
364 * The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
365 */
366 EndpointIdentifier?: String;
367 /**
368 * The replication instance identifier. This parameter is stored as a lowercase string.
369 */
370 ReplicationInstanceIdentifier?: String;
371 }
372 export type ConnectionList = Connection[];
373 export interface CreateEndpointMessage {
374 /**
375 * The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
376 */
377 EndpointIdentifier: String;
378 /**
379 * The type of endpoint.
380 */
381 EndpointType: ReplicationEndpointTypeValue;
382 /**
383 * The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, and SQLSERVER.
384 */
385 EngineName: String;
386 /**
387 * The user name to be used to login to the endpoint database.
388 */
389 Username: String;
390 /**
391 * The password to be used to login to the endpoint database.
392 */
393 Password: SecretString;
394 /**
395 * The name of the server where the endpoint database resides.
396 */
397 ServerName: String;
398 /**
399 * The port used by the endpoint database.
400 */
401 Port: IntegerOptional;
402 /**
403 * The name of the endpoint database.
404 */
405 DatabaseName?: String;
406 /**
407 * Additional attributes associated with the connection.
408 */
409 ExtraConnectionAttributes?: String;
410 /**
411 * The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
412 */
413 KmsKeyId?: String;
414 /**
415 * Tags to be added to the endpoint.
416 */
417 Tags?: TagList;
418 /**
419 * The Amazon Resource Number (ARN) for the certificate.
420 */
421 CertificateArn?: String;
422 /**
423 * The SSL mode to use for the SSL connection. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
424 */
425 SslMode?: DmsSslModeValue;
426 }
427 export interface CreateEndpointResponse {
428 /**
429 * The endpoint that was created.
430 */
431 Endpoint?: Endpoint;
432 }
433 export interface CreateReplicationInstanceMessage {
434 /**
435 * The replication instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myrepinstance
436 */
437 ReplicationInstanceIdentifier: String;
438 /**
439 * The amount of storage (in gigabytes) to be initially allocated for the replication instance.
440 */
441 AllocatedStorage?: IntegerOptional;
442 /**
443 * The compute and memory capacity of the replication instance as specified by the replication instance class. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
444 */
445 ReplicationInstanceClass: String;
446 /**
447 * Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
448 */
449 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
450 /**
451 * The EC2 Availability Zone that the replication instance will be created in. Default: A random, system-chosen Availability Zone in the endpoint's region. Example: us-east-1d
452 */
453 AvailabilityZone?: String;
454 /**
455 * A subnet group to associate with the replication instance.
456 */
457 ReplicationSubnetGroupIdentifier?: String;
458 /**
459 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
460 */
461 PreferredMaintenanceWindow?: String;
462 /**
463 * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
464 */
465 MultiAZ?: BooleanOptional;
466 /**
467 * The engine version number of the replication instance.
468 */
469 EngineVersion?: String;
470 /**
471 * Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. Default: true
472 */
473 AutoMinorVersionUpgrade?: BooleanOptional;
474 /**
475 * Tags to be associated with the replication instance.
476 */
477 Tags?: TagList;
478 /**
479 * The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
480 */
481 KmsKeyId?: String;
482 /**
483 * Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
484 */
485 PubliclyAccessible?: BooleanOptional;
486 }
487 export interface CreateReplicationInstanceResponse {
488 /**
489 * The replication instance that was created.
490 */
491 ReplicationInstance?: ReplicationInstance;
492 }
493 export interface CreateReplicationSubnetGroupMessage {
494 /**
495 * The name for the replication subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default". Example: mySubnetgroup
496 */
497 ReplicationSubnetGroupIdentifier: String;
498 /**
499 * The description for the subnet group.
500 */
501 ReplicationSubnetGroupDescription: String;
502 /**
503 * The EC2 subnet IDs for the subnet group.
504 */
505 SubnetIds: SubnetIdentifierList;
506 /**
507 * The tag to be assigned to the subnet group.
508 */
509 Tags?: TagList;
510 }
511 export interface CreateReplicationSubnetGroupResponse {
512 /**
513 * The replication subnet group that was created.
514 */
515 ReplicationSubnetGroup?: ReplicationSubnetGroup;
516 }
517 export interface CreateReplicationTaskMessage {
518 /**
519 * The replication task identifier. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
520 */
521 ReplicationTaskIdentifier: String;
522 /**
523 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
524 */
525 SourceEndpointArn: String;
526 /**
527 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
528 */
529 TargetEndpointArn: String;
530 /**
531 * The Amazon Resource Name (ARN) of the replication instance.
532 */
533 ReplicationInstanceArn: String;
534 /**
535 * The migration type.
536 */
537 MigrationType: MigrationTypeValue;
538 /**
539 * The path of the JSON file that contains the table mappings. Preceed the path with "file://". For example, --table-mappings file://mappingfile.json
540 */
541 TableMappings: String;
542 /**
543 * Settings for the task, such as target metadata settings.
544 */
545 ReplicationTaskSettings?: String;
546 /**
547 * The start time for the Change Data Capture (CDC) operation.
548 */
549 CdcStartTime?: TStamp;
550 /**
551 * Tags to be added to the replication instance.
552 */
553 Tags?: TagList;
554 }
555 export interface CreateReplicationTaskResponse {
556 /**
557 * The replication task that was created.
558 */
559 ReplicationTask?: ReplicationTask;
560 }
561 export interface DeleteCertificateMessage {
562 /**
563 * the Amazon Resource Name (ARN) of the deleted certificate.
564 */
565 CertificateArn: String;
566 }
567 export interface DeleteCertificateResponse {
568 /**
569 * The SSL certificate.
570 */
571 Certificate?: Certificate;
572 }
573 export interface DeleteEndpointMessage {
574 /**
575 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
576 */
577 EndpointArn: String;
578 }
579 export interface DeleteEndpointResponse {
580 /**
581 * The endpoint that was deleted.
582 */
583 Endpoint?: Endpoint;
584 }
585 export interface DeleteReplicationInstanceMessage {
586 /**
587 * The Amazon Resource Name (ARN) of the replication instance to be deleted.
588 */
589 ReplicationInstanceArn: String;
590 }
591 export interface DeleteReplicationInstanceResponse {
592 /**
593 * The replication instance that was deleted.
594 */
595 ReplicationInstance?: ReplicationInstance;
596 }
597 export interface DeleteReplicationSubnetGroupMessage {
598 /**
599 * The subnet group name of the replication instance.
600 */
601 ReplicationSubnetGroupIdentifier: String;
602 }
603 export interface DeleteReplicationSubnetGroupResponse {
604 }
605 export interface DeleteReplicationTaskMessage {
606 /**
607 * The Amazon Resource Name (ARN) of the replication task to be deleted.
608 */
609 ReplicationTaskArn: String;
610 }
611 export interface DeleteReplicationTaskResponse {
612 /**
613 * The deleted replication task.
614 */
615 ReplicationTask?: ReplicationTask;
616 }
617 export interface DescribeAccountAttributesMessage {
618 }
619 export interface DescribeAccountAttributesResponse {
620 /**
621 * Account quota information.
622 */
623 AccountQuotas?: AccountQuotaList;
624 }
625 export interface DescribeCertificatesMessage {
626 /**
627 * Filters applied to the certificate described in the form of key-value pairs.
628 */
629 Filters?: FilterList;
630 /**
631 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 10
632 */
633 MaxRecords?: IntegerOptional;
634 /**
635 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
636 */
637 Marker?: String;
638 }
639 export interface DescribeCertificatesResponse {
640 /**
641 * The pagination token.
642 */
643 Marker?: String;
644 /**
645 * The SSL certificates associated with the replication instance.
646 */
647 Certificates?: CertificateList;
648 }
649 export interface DescribeConnectionsMessage {
650 /**
651 * The filters applied to the connection. Valid filter names: endpoint-arn | replication-instance-arn
652 */
653 Filters?: FilterList;
654 /**
655 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
656 */
657 MaxRecords?: IntegerOptional;
658 /**
659 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
660 */
661 Marker?: String;
662 }
663 export interface DescribeConnectionsResponse {
664 /**
665 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
666 */
667 Marker?: String;
668 /**
669 * A description of the connections.
670 */
671 Connections?: ConnectionList;
672 }
673 export interface DescribeEndpointTypesMessage {
674 /**
675 * Filters applied to the describe action. Valid filter names: engine-name | endpoint-type
676 */
677 Filters?: FilterList;
678 /**
679 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
680 */
681 MaxRecords?: IntegerOptional;
682 /**
683 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
684 */
685 Marker?: String;
686 }
687 export interface DescribeEndpointTypesResponse {
688 /**
689 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
690 */
691 Marker?: String;
692 /**
693 * The type of endpoints that are supported.
694 */
695 SupportedEndpointTypes?: SupportedEndpointTypeList;
696 }
697 export interface DescribeEndpointsMessage {
698 /**
699 * Filters applied to the describe action. Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
700 */
701 Filters?: FilterList;
702 /**
703 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
704 */
705 MaxRecords?: IntegerOptional;
706 /**
707 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
708 */
709 Marker?: String;
710 }
711 export interface DescribeEndpointsResponse {
712 /**
713 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
714 */
715 Marker?: String;
716 /**
717 * Endpoint description.
718 */
719 Endpoints?: EndpointList;
720 }
721 export interface DescribeOrderableReplicationInstancesMessage {
722 /**
723 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
724 */
725 MaxRecords?: IntegerOptional;
726 /**
727 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
728 */
729 Marker?: String;
730 }
731 export interface DescribeOrderableReplicationInstancesResponse {
732 /**
733 * The order-able replication instances available.
734 */
735 OrderableReplicationInstances?: OrderableReplicationInstanceList;
736 /**
737 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
738 */
739 Marker?: String;
740 }
741 export interface DescribeRefreshSchemasStatusMessage {
742 /**
743 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
744 */
745 EndpointArn: String;
746 }
747 export interface DescribeRefreshSchemasStatusResponse {
748 /**
749 * The status of the schema.
750 */
751 RefreshSchemasStatus?: RefreshSchemasStatus;
752 }
753 export interface DescribeReplicationInstancesMessage {
754 /**
755 * Filters applied to the describe action. Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
756 */
757 Filters?: FilterList;
758 /**
759 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
760 */
761 MaxRecords?: IntegerOptional;
762 /**
763 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
764 */
765 Marker?: String;
766 }
767 export interface DescribeReplicationInstancesResponse {
768 /**
769 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
770 */
771 Marker?: String;
772 /**
773 * The replication instances described.
774 */
775 ReplicationInstances?: ReplicationInstanceList;
776 }
777 export interface DescribeReplicationSubnetGroupsMessage {
778 /**
779 * Filters applied to the describe action.
780 */
781 Filters?: FilterList;
782 /**
783 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
784 */
785 MaxRecords?: IntegerOptional;
786 /**
787 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
788 */
789 Marker?: String;
790 }
791 export interface DescribeReplicationSubnetGroupsResponse {
792 /**
793 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
794 */
795 Marker?: String;
796 /**
797 * A description of the replication subnet groups.
798 */
799 ReplicationSubnetGroups?: ReplicationSubnetGroups;
800 }
801 export interface DescribeReplicationTasksMessage {
802 /**
803 * Filters applied to the describe action. Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
804 */
805 Filters?: FilterList;
806 /**
807 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
808 */
809 MaxRecords?: IntegerOptional;
810 /**
811 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
812 */
813 Marker?: String;
814 }
815 export interface DescribeReplicationTasksResponse {
816 /**
817 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
818 */
819 Marker?: String;
820 /**
821 * A description of the replication tasks.
822 */
823 ReplicationTasks?: ReplicationTaskList;
824 }
825 export interface DescribeSchemasMessage {
826 /**
827 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
828 */
829 EndpointArn: String;
830 /**
831 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
832 */
833 MaxRecords?: IntegerOptional;
834 /**
835 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
836 */
837 Marker?: String;
838 }
839 export interface DescribeSchemasResponse {
840 /**
841 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
842 */
843 Marker?: String;
844 /**
845 * The described schema.
846 */
847 Schemas?: SchemaList;
848 }
849 export interface DescribeTableStatisticsMessage {
850 /**
851 * The Amazon Resource Name (ARN) of the replication task.
852 */
853 ReplicationTaskArn: String;
854 /**
855 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
856 */
857 MaxRecords?: IntegerOptional;
858 /**
859 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
860 */
861 Marker?: String;
862 }
863 export interface DescribeTableStatisticsResponse {
864 /**
865 * The Amazon Resource Name (ARN) of the replication task.
866 */
867 ReplicationTaskArn?: String;
868 /**
869 * The table statistics.
870 */
871 TableStatistics?: TableStatisticsList;
872 /**
873 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
874 */
875 Marker?: String;
876 }
877 export type DmsSslModeValue = "none"|"require"|"verify-ca"|"verify-full"|string;
878 export interface Endpoint {
879 /**
880 * The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
881 */
882 EndpointIdentifier?: String;
883 /**
884 * The type of endpoint.
885 */
886 EndpointType?: ReplicationEndpointTypeValue;
887 /**
888 * The database engine name.
889 */
890 EngineName?: String;
891 /**
892 * The user name used to connect to the endpoint.
893 */
894 Username?: String;
895 /**
896 * The name of the server at the endpoint.
897 */
898 ServerName?: String;
899 /**
900 * The port value used to access the endpoint.
901 */
902 Port?: IntegerOptional;
903 /**
904 * The name of the database at the endpoint.
905 */
906 DatabaseName?: String;
907 /**
908 * Additional connection attributes used to connect to the endpoint.
909 */
910 ExtraConnectionAttributes?: String;
911 /**
912 * The status of the endpoint.
913 */
914 Status?: String;
915 /**
916 * The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
917 */
918 KmsKeyId?: String;
919 /**
920 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
921 */
922 EndpointArn?: String;
923 /**
924 * The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
925 */
926 CertificateArn?: String;
927 /**
928 * The SSL mode used to connect to the endpoint. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
929 */
930 SslMode?: DmsSslModeValue;
931 }
932 export type EndpointList = Endpoint[];
933 export type ExceptionMessage = string;
934 export interface Filter {
935 /**
936 * The name of the filter.
937 */
938 Name: String;
939 /**
940 * The filter value.
941 */
942 Values: FilterValueList;
943 }
944 export type FilterList = Filter[];
945 export type FilterValueList = String[];
946 export interface ImportCertificateMessage {
947 /**
948 * The customer-assigned name of the certificate. Valid characters are [A-z_0-9].
949 */
950 CertificateIdentifier: String;
951 /**
952 * The contents of the .pem X.509 certificate file.
953 */
954 CertificatePem?: String;
955 }
956 export interface ImportCertificateResponse {
957 /**
958 * The certificate to be uploaded.
959 */
960 Certificate?: Certificate;
961 }
962 export type Integer = number;
963 export type IntegerOptional = number;
964 export type KeyList = String[];
965 export interface ListTagsForResourceMessage {
966 /**
967 * The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
968 */
969 ResourceArn: String;
970 }
971 export interface ListTagsForResourceResponse {
972 /**
973 * A list of tags for the resource.
974 */
975 TagList?: TagList;
976 }
977 export type Long = number;
978 export type MigrationTypeValue = "full-load"|"cdc"|"full-load-and-cdc"|string;
979 export interface ModifyEndpointMessage {
980 /**
981 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
982 */
983 EndpointArn: String;
984 /**
985 * The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
986 */
987 EndpointIdentifier?: String;
988 /**
989 * The type of endpoint.
990 */
991 EndpointType?: ReplicationEndpointTypeValue;
992 /**
993 * The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, and SQLSERVER.
994 */
995 EngineName?: String;
996 /**
997 * The user name to be used to login to the endpoint database.
998 */
999 Username?: String;
1000 /**
1001 * The password to be used to login to the endpoint database.
1002 */
1003 Password?: SecretString;
1004 /**
1005 * The name of the server where the endpoint database resides.
1006 */
1007 ServerName?: String;
1008 /**
1009 * The port used by the endpoint database.
1010 */
1011 Port?: IntegerOptional;
1012 /**
1013 * The name of the endpoint database.
1014 */
1015 DatabaseName?: String;
1016 /**
1017 * Additional attributes associated with the connection.
1018 */
1019 ExtraConnectionAttributes?: String;
1020 /**
1021 * The Amazon Resource Name (ARN) of the certificate used for SSL connection.
1022 */
1023 CertificateArn?: String;
1024 /**
1025 * The SSL mode to be used. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
1026 */
1027 SslMode?: DmsSslModeValue;
1028 }
1029 export interface ModifyEndpointResponse {
1030 /**
1031 * The modified endpoint.
1032 */
1033 Endpoint?: Endpoint;
1034 }
1035 export interface ModifyReplicationInstanceMessage {
1036 /**
1037 * The Amazon Resource Name (ARN) of the replication instance.
1038 */
1039 ReplicationInstanceArn: String;
1040 /**
1041 * The amount of storage (in gigabytes) to be allocated for the replication instance.
1042 */
1043 AllocatedStorage?: IntegerOptional;
1044 /**
1045 * Indicates whether the changes should be applied immediately or during the next maintenance window.
1046 */
1047 ApplyImmediately?: Boolean;
1048 /**
1049 * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
1050 */
1051 ReplicationInstanceClass?: String;
1052 /**
1053 * Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
1054 */
1055 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1056 /**
1057 * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes
1058 */
1059 PreferredMaintenanceWindow?: String;
1060 /**
1061 * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
1062 */
1063 MultiAZ?: BooleanOptional;
1064 /**
1065 * The engine version number of the replication instance.
1066 */
1067 EngineVersion?: String;
1068 /**
1069 * Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
1070 */
1071 AllowMajorVersionUpgrade?: Boolean;
1072 /**
1073 * Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.
1074 */
1075 AutoMinorVersionUpgrade?: BooleanOptional;
1076 /**
1077 * The replication instance identifier. This parameter is stored as a lowercase string.
1078 */
1079 ReplicationInstanceIdentifier?: String;
1080 }
1081 export interface ModifyReplicationInstanceResponse {
1082 /**
1083 * The modified replication instance.
1084 */
1085 ReplicationInstance?: ReplicationInstance;
1086 }
1087 export interface ModifyReplicationSubnetGroupMessage {
1088 /**
1089 * The name of the replication instance subnet group.
1090 */
1091 ReplicationSubnetGroupIdentifier: String;
1092 /**
1093 * The description of the replication instance subnet group.
1094 */
1095 ReplicationSubnetGroupDescription?: String;
1096 /**
1097 * A list of subnet IDs.
1098 */
1099 SubnetIds: SubnetIdentifierList;
1100 }
1101 export interface ModifyReplicationSubnetGroupResponse {
1102 /**
1103 * The modified replication subnet group.
1104 */
1105 ReplicationSubnetGroup?: ReplicationSubnetGroup;
1106 }
1107 export interface OrderableReplicationInstance {
1108 /**
1109 * The version of the replication engine.
1110 */
1111 EngineVersion?: String;
1112 /**
1113 * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
1114 */
1115 ReplicationInstanceClass?: String;
1116 /**
1117 * The type of storage used by the replication instance.
1118 */
1119 StorageType?: String;
1120 /**
1121 * The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
1122 */
1123 MinAllocatedStorage?: Integer;
1124 /**
1125 * The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
1126 */
1127 MaxAllocatedStorage?: Integer;
1128 /**
1129 * The default amount of storage (in gigabytes) that is allocated for the replication instance.
1130 */
1131 DefaultAllocatedStorage?: Integer;
1132 /**
1133 * The amount of storage (in gigabytes) that is allocated for the replication instance.
1134 */
1135 IncludedAllocatedStorage?: Integer;
1136 }
1137 export type OrderableReplicationInstanceList = OrderableReplicationInstance[];
1138 export interface RefreshSchemasMessage {
1139 /**
1140 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1141 */
1142 EndpointArn: String;
1143 /**
1144 * The Amazon Resource Name (ARN) of the replication instance.
1145 */
1146 ReplicationInstanceArn: String;
1147 }
1148 export interface RefreshSchemasResponse {
1149 /**
1150 * The status of the refreshed schema.
1151 */
1152 RefreshSchemasStatus?: RefreshSchemasStatus;
1153 }
1154 export interface RefreshSchemasStatus {
1155 /**
1156 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1157 */
1158 EndpointArn?: String;
1159 /**
1160 * The Amazon Resource Name (ARN) of the replication instance.
1161 */
1162 ReplicationInstanceArn?: String;
1163 /**
1164 * The status of the schema.
1165 */
1166 Status?: RefreshSchemasStatusTypeValue;
1167 /**
1168 * The date the schema was last refreshed.
1169 */
1170 LastRefreshDate?: TStamp;
1171 /**
1172 * The last failure message for the schema.
1173 */
1174 LastFailureMessage?: String;
1175 }
1176 export type RefreshSchemasStatusTypeValue = "successful"|"failed"|"refreshing"|string;
1177 export interface RemoveTagsFromResourceMessage {
1178 /**
1179 * >The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from.
1180 */
1181 ResourceArn: String;
1182 /**
1183 * The tag key (name) of the tag to be removed.
1184 */
1185 TagKeys: KeyList;
1186 }
1187 export interface RemoveTagsFromResourceResponse {
1188 }
1189 export type ReplicationEndpointTypeValue = "source"|"target"|string;
1190 export interface ReplicationInstance {
1191 /**
1192 * The replication instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myrepinstance
1193 */
1194 ReplicationInstanceIdentifier?: String;
1195 /**
1196 * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
1197 */
1198 ReplicationInstanceClass?: String;
1199 /**
1200 * The status of the replication instance.
1201 */
1202 ReplicationInstanceStatus?: String;
1203 /**
1204 * The amount of storage (in gigabytes) that is allocated for the replication instance.
1205 */
1206 AllocatedStorage?: Integer;
1207 /**
1208 * The time the replication instance was created.
1209 */
1210 InstanceCreateTime?: TStamp;
1211 /**
1212 * The VPC security group for the instance.
1213 */
1214 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
1215 /**
1216 * The Availability Zone for the instance.
1217 */
1218 AvailabilityZone?: String;
1219 /**
1220 * The subnet group for the replication instance.
1221 */
1222 ReplicationSubnetGroup?: ReplicationSubnetGroup;
1223 /**
1224 * The maintenance window times for the replication instance.
1225 */
1226 PreferredMaintenanceWindow?: String;
1227 /**
1228 * The pending modification values.
1229 */
1230 PendingModifiedValues?: ReplicationPendingModifiedValues;
1231 /**
1232 * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
1233 */
1234 MultiAZ?: Boolean;
1235 /**
1236 * The engine version number of the replication instance.
1237 */
1238 EngineVersion?: String;
1239 /**
1240 * Boolean value indicating if minor version upgrades will be automatically applied to the instance.
1241 */
1242 AutoMinorVersionUpgrade?: Boolean;
1243 /**
1244 * The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
1245 */
1246 KmsKeyId?: String;
1247 /**
1248 * The Amazon Resource Name (ARN) of the replication instance.
1249 */
1250 ReplicationInstanceArn?: String;
1251 /**
1252 * The public IP address of the replication instance.
1253 */
1254 ReplicationInstancePublicIpAddress?: String;
1255 /**
1256 * The private IP address of the replication instance.
1257 */
1258 ReplicationInstancePrivateIpAddress?: String;
1259 /**
1260 * The public IP address of the replication instance.
1261 */
1262 ReplicationInstancePublicIpAddresses?: ReplicationInstancePublicIpAddressList;
1263 /**
1264 * The private IP address of the replication instance.
1265 */
1266 ReplicationInstancePrivateIpAddresses?: ReplicationInstancePrivateIpAddressList;
1267 /**
1268 * Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
1269 */
1270 PubliclyAccessible?: Boolean;
1271 }
1272 export type ReplicationInstanceList = ReplicationInstance[];
1273 export type ReplicationInstancePrivateIpAddressList = String[];
1274 export type ReplicationInstancePublicIpAddressList = String[];
1275 export interface ReplicationPendingModifiedValues {
1276 /**
1277 * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
1278 */
1279 ReplicationInstanceClass?: String;
1280 /**
1281 * The amount of storage (in gigabytes) that is allocated for the replication instance.
1282 */
1283 AllocatedStorage?: IntegerOptional;
1284 /**
1285 * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
1286 */
1287 MultiAZ?: BooleanOptional;
1288 /**
1289 * The engine version number of the replication instance.
1290 */
1291 EngineVersion?: String;
1292 }
1293 export interface ReplicationSubnetGroup {
1294 /**
1295 * The identifier of the replication instance subnet group.
1296 */
1297 ReplicationSubnetGroupIdentifier?: String;
1298 /**
1299 * The description of the replication subnet group.
1300 */
1301 ReplicationSubnetGroupDescription?: String;
1302 /**
1303 * The ID of the VPC.
1304 */
1305 VpcId?: String;
1306 /**
1307 * The status of the subnet group.
1308 */
1309 SubnetGroupStatus?: String;
1310 /**
1311 * The subnets that are in the subnet group.
1312 */
1313 Subnets?: SubnetList;
1314 }
1315 export type ReplicationSubnetGroups = ReplicationSubnetGroup[];
1316 export interface ReplicationTask {
1317 /**
1318 * The replication task identifier. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
1319 */
1320 ReplicationTaskIdentifier?: String;
1321 /**
1322 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1323 */
1324 SourceEndpointArn?: String;
1325 /**
1326 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1327 */
1328 TargetEndpointArn?: String;
1329 /**
1330 * The Amazon Resource Name (ARN) of the replication instance.
1331 */
1332 ReplicationInstanceArn?: String;
1333 /**
1334 * The type of migration.
1335 */
1336 MigrationType?: MigrationTypeValue;
1337 /**
1338 * Table mappings specified in the task.
1339 */
1340 TableMappings?: String;
1341 /**
1342 * The settings for the replication task.
1343 */
1344 ReplicationTaskSettings?: String;
1345 /**
1346 * The status of the replication task.
1347 */
1348 Status?: String;
1349 /**
1350 * The last error (failure) message generated for the replication instance.
1351 */
1352 LastFailureMessage?: String;
1353 /**
1354 * The date the replication task was created.
1355 */
1356 ReplicationTaskCreationDate?: TStamp;
1357 /**
1358 * The date the replication task is scheduled to start.
1359 */
1360 ReplicationTaskStartDate?: TStamp;
1361 /**
1362 * The Amazon Resource Name (ARN) of the replication task.
1363 */
1364 ReplicationTaskArn?: String;
1365 /**
1366 * The statistics for the task, including elapsed time, tables loaded, and table errors.
1367 */
1368 ReplicationTaskStats?: ReplicationTaskStats;
1369 }
1370 export type ReplicationTaskList = ReplicationTask[];
1371 export interface ReplicationTaskStats {
1372 /**
1373 * The percent complete for the full load migration task.
1374 */
1375 FullLoadProgressPercent?: Integer;
1376 /**
1377 * The elapsed time of the task, in milliseconds.
1378 */
1379 ElapsedTimeMillis?: Long;
1380 /**
1381 * The number of tables loaded for this task.
1382 */
1383 TablesLoaded?: Integer;
1384 /**
1385 * The number of tables currently loading for this task.
1386 */
1387 TablesLoading?: Integer;
1388 /**
1389 * The number of tables queued for this task.
1390 */
1391 TablesQueued?: Integer;
1392 /**
1393 * The number of errors that have occurred during this task.
1394 */
1395 TablesErrored?: Integer;
1396 }
1397 export type SchemaList = String[];
1398 export type SecretString = string;
1399 export interface StartReplicationTaskMessage {
1400 /**
1401 * The Amazon Resource Number (ARN) of the replication task to be started.
1402 */
1403 ReplicationTaskArn: String;
1404 /**
1405 * The type of replication task.
1406 */
1407 StartReplicationTaskType: StartReplicationTaskTypeValue;
1408 /**
1409 * The start time for the Change Data Capture (CDC) operation.
1410 */
1411 CdcStartTime?: TStamp;
1412 }
1413 export interface StartReplicationTaskResponse {
1414 /**
1415 * The replication task started.
1416 */
1417 ReplicationTask?: ReplicationTask;
1418 }
1419 export type StartReplicationTaskTypeValue = "start-replication"|"resume-processing"|"reload-target"|string;
1420 export interface StopReplicationTaskMessage {
1421 /**
1422 * The Amazon Resource Number(ARN) of the replication task to be stopped.
1423 */
1424 ReplicationTaskArn: String;
1425 }
1426 export interface StopReplicationTaskResponse {
1427 /**
1428 * The replication task stopped.
1429 */
1430 ReplicationTask?: ReplicationTask;
1431 }
1432 export type String = string;
1433 export interface Subnet {
1434 /**
1435 * The subnet identifier.
1436 */
1437 SubnetIdentifier?: String;
1438 /**
1439 * The Availability Zone of the subnet.
1440 */
1441 SubnetAvailabilityZone?: AvailabilityZone;
1442 /**
1443 * The status of the subnet.
1444 */
1445 SubnetStatus?: String;
1446 }
1447 export type SubnetIdentifierList = String[];
1448 export type SubnetList = Subnet[];
1449 export interface SupportedEndpointType {
1450 /**
1451 * The database engine name.
1452 */
1453 EngineName?: String;
1454 /**
1455 * Indicates if Change Data Capture (CDC) is supported.
1456 */
1457 SupportsCDC?: Boolean;
1458 /**
1459 * The type of endpoint.
1460 */
1461 EndpointType?: ReplicationEndpointTypeValue;
1462 }
1463 export type SupportedEndpointTypeList = SupportedEndpointType[];
1464 export type TStamp = Date;
1465 export interface TableStatistics {
1466 /**
1467 * The schema name.
1468 */
1469 SchemaName?: String;
1470 /**
1471 * The name of the table.
1472 */
1473 TableName?: String;
1474 /**
1475 * The number of insert actions performed on a table.
1476 */
1477 Inserts?: Long;
1478 /**
1479 * The number of delete actions performed on a table.
1480 */
1481 Deletes?: Long;
1482 /**
1483 * The number of update actions performed on a table.
1484 */
1485 Updates?: Long;
1486 /**
1487 * The Data Definition Language (DDL) used to build and modify the structure of your tables.
1488 */
1489 Ddls?: Long;
1490 /**
1491 * The number of rows added during the Full Load operation.
1492 */
1493 FullLoadRows?: Long;
1494 /**
1495 * The last time the table was updated.
1496 */
1497 LastUpdateTime?: TStamp;
1498 /**
1499 * The state of the table.
1500 */
1501 TableState?: String;
1502 }
1503 export type TableStatisticsList = TableStatistics[];
1504 export interface Tag {
1505 /**
1506 * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
1507 */
1508 Key?: String;
1509 /**
1510 * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
1511 */
1512 Value?: String;
1513 }
1514 export type TagList = Tag[];
1515 export interface TestConnectionMessage {
1516 /**
1517 * The Amazon Resource Name (ARN) of the replication instance.
1518 */
1519 ReplicationInstanceArn: String;
1520 /**
1521 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1522 */
1523 EndpointArn: String;
1524 }
1525 export interface TestConnectionResponse {
1526 /**
1527 * The connection tested.
1528 */
1529 Connection?: Connection;
1530 }
1531 export type VpcSecurityGroupIdList = String[];
1532 export interface VpcSecurityGroupMembership {
1533 /**
1534 * The VPC security group Id.
1535 */
1536 VpcSecurityGroupId?: String;
1537 /**
1538 * The status of the VPC security group.
1539 */
1540 Status?: String;
1541 }
1542 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
1543 /**
1544 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1545 */
1546 export type apiVersion = "2016-01-01"|"latest"|string;
1547 export interface ClientApiVersions {
1548 /**
1549 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1550 */
1551 apiVersion?: apiVersion;
1552 }
1553 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1554 }
1555 export = DMS;