UNPKG

141 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class DMS extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: DMS.Types.ClientConfiguration)
14 config: Config & DMS.Types.ClientConfiguration;
15 /**
16 * Adds metadata tags to an AWS 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.
17 */
18 addTagsToResource(params: DMS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
19 /**
20 * Adds metadata tags to an AWS 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.
21 */
22 addTagsToResource(callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
23 /**
24 * Applies a pending maintenance action to a resource (for example, to a replication instance).
25 */
26 applyPendingMaintenanceAction(params: DMS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: DMS.Types.ApplyPendingMaintenanceActionResponse) => void): Request<DMS.Types.ApplyPendingMaintenanceActionResponse, AWSError>;
27 /**
28 * Applies a pending maintenance action to a resource (for example, to a replication instance).
29 */
30 applyPendingMaintenanceAction(callback?: (err: AWSError, data: DMS.Types.ApplyPendingMaintenanceActionResponse) => void): Request<DMS.Types.ApplyPendingMaintenanceActionResponse, AWSError>;
31 /**
32 * Creates an endpoint using the provided settings.
33 */
34 createEndpoint(params: DMS.Types.CreateEndpointMessage, callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
35 /**
36 * Creates an endpoint using the provided settings.
37 */
38 createEndpoint(callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
39 /**
40 * Creates an AWS DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account. For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
41 */
42 createEventSubscription(params: DMS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request<DMS.Types.CreateEventSubscriptionResponse, AWSError>;
43 /**
44 * Creates an AWS DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account. For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
45 */
46 createEventSubscription(callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request<DMS.Types.CreateEventSubscriptionResponse, AWSError>;
47 /**
48 * Creates the replication instance using the specified parameters.
49 */
50 createReplicationInstance(params: DMS.Types.CreateReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
51 /**
52 * Creates the replication instance using the specified parameters.
53 */
54 createReplicationInstance(callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
55 /**
56 * Creates a replication subnet group given a list of the subnet IDs in a VPC.
57 */
58 createReplicationSubnetGroup(params: DMS.Types.CreateReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request<DMS.Types.CreateReplicationSubnetGroupResponse, AWSError>;
59 /**
60 * Creates a replication subnet group given a list of the subnet IDs in a VPC.
61 */
62 createReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request<DMS.Types.CreateReplicationSubnetGroupResponse, AWSError>;
63 /**
64 * Creates a replication task using the specified parameters.
65 */
66 createReplicationTask(params: DMS.Types.CreateReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request<DMS.Types.CreateReplicationTaskResponse, AWSError>;
67 /**
68 * Creates a replication task using the specified parameters.
69 */
70 createReplicationTask(callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request<DMS.Types.CreateReplicationTaskResponse, AWSError>;
71 /**
72 * Deletes the specified certificate.
73 */
74 deleteCertificate(params: DMS.Types.DeleteCertificateMessage, callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request<DMS.Types.DeleteCertificateResponse, AWSError>;
75 /**
76 * Deletes the specified certificate.
77 */
78 deleteCertificate(callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request<DMS.Types.DeleteCertificateResponse, AWSError>;
79 /**
80 * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
81 */
82 deleteEndpoint(params: DMS.Types.DeleteEndpointMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
83 /**
84 * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
85 */
86 deleteEndpoint(callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
87 /**
88 * Deletes an AWS DMS event subscription.
89 */
90 deleteEventSubscription(params: DMS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request<DMS.Types.DeleteEventSubscriptionResponse, AWSError>;
91 /**
92 * Deletes an AWS DMS event subscription.
93 */
94 deleteEventSubscription(callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request<DMS.Types.DeleteEventSubscriptionResponse, AWSError>;
95 /**
96 * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
97 */
98 deleteReplicationInstance(params: DMS.Types.DeleteReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request<DMS.Types.DeleteReplicationInstanceResponse, AWSError>;
99 /**
100 * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
101 */
102 deleteReplicationInstance(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request<DMS.Types.DeleteReplicationInstanceResponse, AWSError>;
103 /**
104 * Deletes a subnet group.
105 */
106 deleteReplicationSubnetGroup(params: DMS.Types.DeleteReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request<DMS.Types.DeleteReplicationSubnetGroupResponse, AWSError>;
107 /**
108 * Deletes a subnet group.
109 */
110 deleteReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request<DMS.Types.DeleteReplicationSubnetGroupResponse, AWSError>;
111 /**
112 * Deletes the specified replication task.
113 */
114 deleteReplicationTask(params: DMS.Types.DeleteReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
115 /**
116 * Deletes the specified replication task.
117 */
118 deleteReplicationTask(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
119 /**
120 * 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.
121 */
122 describeAccountAttributes(params: DMS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
123 /**
124 * 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.
125 */
126 describeAccountAttributes(callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
127 /**
128 * Provides a description of the certificate.
129 */
130 describeCertificates(params: DMS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request<DMS.Types.DescribeCertificatesResponse, AWSError>;
131 /**
132 * Provides a description of the certificate.
133 */
134 describeCertificates(callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request<DMS.Types.DescribeCertificatesResponse, AWSError>;
135 /**
136 * 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.
137 */
138 describeConnections(params: DMS.Types.DescribeConnectionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
139 /**
140 * 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.
141 */
142 describeConnections(callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
143 /**
144 * Returns information about the type of endpoints available.
145 */
146 describeEndpointTypes(params: DMS.Types.DescribeEndpointTypesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request<DMS.Types.DescribeEndpointTypesResponse, AWSError>;
147 /**
148 * Returns information about the type of endpoints available.
149 */
150 describeEndpointTypes(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request<DMS.Types.DescribeEndpointTypesResponse, AWSError>;
151 /**
152 * Returns information about the endpoints for your account in the current region.
153 */
154 describeEndpoints(params: DMS.Types.DescribeEndpointsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
155 /**
156 * Returns information about the endpoints for your account in the current region.
157 */
158 describeEndpoints(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
159 /**
160 * Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
161 */
162 describeEventCategories(params: DMS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request<DMS.Types.DescribeEventCategoriesResponse, AWSError>;
163 /**
164 * Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
165 */
166 describeEventCategories(callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request<DMS.Types.DescribeEventCategoriesResponse, AWSError>;
167 /**
168 * Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription.
169 */
170 describeEventSubscriptions(params: DMS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request<DMS.Types.DescribeEventSubscriptionsResponse, AWSError>;
171 /**
172 * Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription.
173 */
174 describeEventSubscriptions(callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request<DMS.Types.DescribeEventSubscriptionsResponse, AWSError>;
175 /**
176 * Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
177 */
178 describeEvents(params: DMS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request<DMS.Types.DescribeEventsResponse, AWSError>;
179 /**
180 * Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
181 */
182 describeEvents(callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request<DMS.Types.DescribeEventsResponse, AWSError>;
183 /**
184 * Returns information about the replication instance types that can be created in the specified region.
185 */
186 describeOrderableReplicationInstances(params: DMS.Types.DescribeOrderableReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request<DMS.Types.DescribeOrderableReplicationInstancesResponse, AWSError>;
187 /**
188 * Returns information about the replication instance types that can be created in the specified region.
189 */
190 describeOrderableReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request<DMS.Types.DescribeOrderableReplicationInstancesResponse, AWSError>;
191 /**
192 * For internal use only
193 */
194 describePendingMaintenanceActions(params: DMS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribePendingMaintenanceActionsResponse) => void): Request<DMS.Types.DescribePendingMaintenanceActionsResponse, AWSError>;
195 /**
196 * For internal use only
197 */
198 describePendingMaintenanceActions(callback?: (err: AWSError, data: DMS.Types.DescribePendingMaintenanceActionsResponse) => void): Request<DMS.Types.DescribePendingMaintenanceActionsResponse, AWSError>;
199 /**
200 * Returns the status of the RefreshSchemas operation.
201 */
202 describeRefreshSchemasStatus(params: DMS.Types.DescribeRefreshSchemasStatusMessage, callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request<DMS.Types.DescribeRefreshSchemasStatusResponse, AWSError>;
203 /**
204 * Returns the status of the RefreshSchemas operation.
205 */
206 describeRefreshSchemasStatus(callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request<DMS.Types.DescribeRefreshSchemasStatusResponse, AWSError>;
207 /**
208 * Returns information about the task logs for the specified task.
209 */
210 describeReplicationInstanceTaskLogs(params: DMS.Types.DescribeReplicationInstanceTaskLogsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstanceTaskLogsResponse) => void): Request<DMS.Types.DescribeReplicationInstanceTaskLogsResponse, AWSError>;
211 /**
212 * Returns information about the task logs for the specified task.
213 */
214 describeReplicationInstanceTaskLogs(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstanceTaskLogsResponse) => void): Request<DMS.Types.DescribeReplicationInstanceTaskLogsResponse, AWSError>;
215 /**
216 * Returns information about replication instances for your account in the current region.
217 */
218 describeReplicationInstances(params: DMS.Types.DescribeReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
219 /**
220 * Returns information about replication instances for your account in the current region.
221 */
222 describeReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
223 /**
224 * Returns information about the replication subnet groups.
225 */
226 describeReplicationSubnetGroups(params: DMS.Types.DescribeReplicationSubnetGroupsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
227 /**
228 * Returns information about the replication subnet groups.
229 */
230 describeReplicationSubnetGroups(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
231 /**
232 * Returns the task assessment results from Amazon S3. This action always returns the latest results.
233 */
234 describeReplicationTaskAssessmentResults(params: DMS.Types.DescribeReplicationTaskAssessmentResultsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentResultsResponse, AWSError>;
235 /**
236 * Returns the task assessment results from Amazon S3. This action always returns the latest results.
237 */
238 describeReplicationTaskAssessmentResults(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentResultsResponse, AWSError>;
239 /**
240 * Returns information about replication tasks for your account in the current region.
241 */
242 describeReplicationTasks(params: DMS.Types.DescribeReplicationTasksMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
243 /**
244 * Returns information about replication tasks for your account in the current region.
245 */
246 describeReplicationTasks(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
247 /**
248 * Returns information about the schema for the specified endpoint.
249 */
250 describeSchemas(params: DMS.Types.DescribeSchemasMessage, callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
251 /**
252 * Returns information about the schema for the specified endpoint.
253 */
254 describeSchemas(callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
255 /**
256 * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
257 */
258 describeTableStatistics(params: DMS.Types.DescribeTableStatisticsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
259 /**
260 * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
261 */
262 describeTableStatistics(callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
263 /**
264 * Uploads the specified certificate.
265 */
266 importCertificate(params: DMS.Types.ImportCertificateMessage, callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
267 /**
268 * Uploads the specified certificate.
269 */
270 importCertificate(callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
271 /**
272 * Lists all tags for an AWS DMS resource.
273 */
274 listTagsForResource(params: DMS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
275 /**
276 * Lists all tags for an AWS DMS resource.
277 */
278 listTagsForResource(callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
279 /**
280 * Modifies the specified endpoint.
281 */
282 modifyEndpoint(params: DMS.Types.ModifyEndpointMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
283 /**
284 * Modifies the specified endpoint.
285 */
286 modifyEndpoint(callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
287 /**
288 * Modifies an existing AWS DMS event notification subscription.
289 */
290 modifyEventSubscription(params: DMS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request<DMS.Types.ModifyEventSubscriptionResponse, AWSError>;
291 /**
292 * Modifies an existing AWS DMS event notification subscription.
293 */
294 modifyEventSubscription(callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request<DMS.Types.ModifyEventSubscriptionResponse, AWSError>;
295 /**
296 * 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.
297 */
298 modifyReplicationInstance(params: DMS.Types.ModifyReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request<DMS.Types.ModifyReplicationInstanceResponse, AWSError>;
299 /**
300 * 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.
301 */
302 modifyReplicationInstance(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request<DMS.Types.ModifyReplicationInstanceResponse, AWSError>;
303 /**
304 * Modifies the settings for the specified replication subnet group.
305 */
306 modifyReplicationSubnetGroup(params: DMS.Types.ModifyReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
307 /**
308 * Modifies the settings for the specified replication subnet group.
309 */
310 modifyReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
311 /**
312 * Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
313 */
314 modifyReplicationTask(params: DMS.Types.ModifyReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request<DMS.Types.ModifyReplicationTaskResponse, AWSError>;
315 /**
316 * Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
317 */
318 modifyReplicationTask(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request<DMS.Types.ModifyReplicationTaskResponse, AWSError>;
319 /**
320 * Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
321 */
322 rebootReplicationInstance(params: DMS.Types.RebootReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.RebootReplicationInstanceResponse) => void): Request<DMS.Types.RebootReplicationInstanceResponse, AWSError>;
323 /**
324 * Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
325 */
326 rebootReplicationInstance(callback?: (err: AWSError, data: DMS.Types.RebootReplicationInstanceResponse) => void): Request<DMS.Types.RebootReplicationInstanceResponse, AWSError>;
327 /**
328 * 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.
329 */
330 refreshSchemas(params: DMS.Types.RefreshSchemasMessage, callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request<DMS.Types.RefreshSchemasResponse, AWSError>;
331 /**
332 * 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.
333 */
334 refreshSchemas(callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request<DMS.Types.RefreshSchemasResponse, AWSError>;
335 /**
336 * Reloads the target database table with the source data.
337 */
338 reloadTables(params: DMS.Types.ReloadTablesMessage, callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request<DMS.Types.ReloadTablesResponse, AWSError>;
339 /**
340 * Reloads the target database table with the source data.
341 */
342 reloadTables(callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request<DMS.Types.ReloadTablesResponse, AWSError>;
343 /**
344 * Removes metadata tags from a DMS resource.
345 */
346 removeTagsFromResource(params: DMS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
347 /**
348 * Removes metadata tags from a DMS resource.
349 */
350 removeTagsFromResource(callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
351 /**
352 * Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
353 */
354 startReplicationTask(params: DMS.Types.StartReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
355 /**
356 * Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
357 */
358 startReplicationTask(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
359 /**
360 * Starts the replication task assessment for unsupported data types in the source database.
361 */
362 startReplicationTaskAssessment(params: DMS.Types.StartReplicationTaskAssessmentMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentResponse) => void): Request<DMS.Types.StartReplicationTaskAssessmentResponse, AWSError>;
363 /**
364 * Starts the replication task assessment for unsupported data types in the source database.
365 */
366 startReplicationTaskAssessment(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentResponse) => void): Request<DMS.Types.StartReplicationTaskAssessmentResponse, AWSError>;
367 /**
368 * Stops the replication task.
369 */
370 stopReplicationTask(params: DMS.Types.StopReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request<DMS.Types.StopReplicationTaskResponse, AWSError>;
371 /**
372 * Stops the replication task.
373 */
374 stopReplicationTask(callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request<DMS.Types.StopReplicationTaskResponse, AWSError>;
375 /**
376 * Tests the connection between the replication instance and the endpoint.
377 */
378 testConnection(params: DMS.Types.TestConnectionMessage, callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request<DMS.Types.TestConnectionResponse, AWSError>;
379 /**
380 * Tests the connection between the replication instance and the endpoint.
381 */
382 testConnection(callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request<DMS.Types.TestConnectionResponse, AWSError>;
383 /**
384 * Waits for the testConnectionSucceeds state by periodically calling the underlying DMS.describeConnectionsoperation every 5 seconds (at most 60 times). Wait until testing connection succeeds.
385 */
386 waitFor(state: "testConnectionSucceeds", params: DMS.Types.DescribeConnectionsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
387 /**
388 * Waits for the testConnectionSucceeds state by periodically calling the underlying DMS.describeConnectionsoperation every 5 seconds (at most 60 times). Wait until testing connection succeeds.
389 */
390 waitFor(state: "testConnectionSucceeds", callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
391 /**
392 * Waits for the endpointDeleted state by periodically calling the underlying DMS.describeEndpointsoperation every 5 seconds (at most 60 times). Wait until testing endpoint is deleted.
393 */
394 waitFor(state: "endpointDeleted", params: DMS.Types.DescribeEndpointsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
395 /**
396 * Waits for the endpointDeleted state by periodically calling the underlying DMS.describeEndpointsoperation every 5 seconds (at most 60 times). Wait until testing endpoint is deleted.
397 */
398 waitFor(state: "endpointDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
399 /**
400 * Waits for the replicationInstanceAvailable state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 60 seconds (at most 60 times). Wait until DMS replication instance is available.
401 */
402 waitFor(state: "replicationInstanceAvailable", params: DMS.Types.DescribeReplicationInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
403 /**
404 * Waits for the replicationInstanceAvailable state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 60 seconds (at most 60 times). Wait until DMS replication instance is available.
405 */
406 waitFor(state: "replicationInstanceAvailable", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
407 /**
408 * Waits for the replicationInstanceDeleted state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 15 seconds (at most 60 times). Wait until DMS replication instance is deleted.
409 */
410 waitFor(state: "replicationInstanceDeleted", params: DMS.Types.DescribeReplicationInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
411 /**
412 * Waits for the replicationInstanceDeleted state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 15 seconds (at most 60 times). Wait until DMS replication instance is deleted.
413 */
414 waitFor(state: "replicationInstanceDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
415 /**
416 * Waits for the replicationTaskReady state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is ready.
417 */
418 waitFor(state: "replicationTaskReady", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
419 /**
420 * Waits for the replicationTaskReady state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is ready.
421 */
422 waitFor(state: "replicationTaskReady", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
423 /**
424 * Waits for the replicationTaskStopped state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is stopped.
425 */
426 waitFor(state: "replicationTaskStopped", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
427 /**
428 * Waits for the replicationTaskStopped state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is stopped.
429 */
430 waitFor(state: "replicationTaskStopped", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
431 /**
432 * Waits for the replicationTaskRunning state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is running.
433 */
434 waitFor(state: "replicationTaskRunning", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
435 /**
436 * Waits for the replicationTaskRunning state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is running.
437 */
438 waitFor(state: "replicationTaskRunning", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
439 /**
440 * Waits for the replicationTaskDeleted state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is deleted.
441 */
442 waitFor(state: "replicationTaskDeleted", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
443 /**
444 * Waits for the replicationTaskDeleted state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is deleted.
445 */
446 waitFor(state: "replicationTaskDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
447}
448declare namespace DMS {
449 export interface AccountQuota {
450 /**
451 * The name of the AWS DMS quota for this AWS account.
452 */
453 AccountQuotaName?: String;
454 /**
455 * The amount currently used toward the quota maximum.
456 */
457 Used?: Long;
458 /**
459 * The maximum allowed value for the quota.
460 */
461 Max?: Long;
462 }
463 export type AccountQuotaList = AccountQuota[];
464 export interface AddTagsToResourceMessage {
465 /**
466 * 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.
467 */
468 ResourceArn: String;
469 /**
470 * The tag to be assigned to the DMS resource.
471 */
472 Tags: TagList;
473 }
474 export interface AddTagsToResourceResponse {
475 }
476 export interface ApplyPendingMaintenanceActionMessage {
477 /**
478 * The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to.
479 */
480 ReplicationInstanceArn: String;
481 /**
482 * The pending maintenance action to apply to this resource.
483 */
484 ApplyAction: String;
485 /**
486 * A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests.
487 */
488 OptInType: String;
489 }
490 export interface ApplyPendingMaintenanceActionResponse {
491 /**
492 * The AWS DMS resource that the pending maintenance action will be applied to.
493 */
494 ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
495 }
496 export type AuthMechanismValue = "default"|"mongodb_cr"|"scram_sha_1"|string;
497 export type AuthTypeValue = "no"|"password"|string;
498 export interface AvailabilityZone {
499 /**
500 * The name of the availability zone.
501 */
502 Name?: String;
503 }
504 export type AvailabilityZonesList = String[];
505 export type Boolean = boolean;
506 export type BooleanOptional = boolean;
507 export interface Certificate {
508 /**
509 * The customer-assigned name of the certificate. Valid characters are A-z and 0-9.
510 */
511 CertificateIdentifier?: String;
512 /**
513 * The date that the certificate was created.
514 */
515 CertificateCreationDate?: TStamp;
516 /**
517 * The contents of the .pem X.509 certificate file for the certificate.
518 */
519 CertificatePem?: String;
520 /**
521 * The location of the imported Oracle Wallet certificate for use with SSL.
522 */
523 CertificateWallet?: CertificateWallet;
524 /**
525 * The Amazon Resource Name (ARN) for the certificate.
526 */
527 CertificateArn?: String;
528 /**
529 * The owner of the certificate.
530 */
531 CertificateOwner?: String;
532 /**
533 * The beginning date that the certificate is valid.
534 */
535 ValidFromDate?: TStamp;
536 /**
537 * The final date that the certificate is valid.
538 */
539 ValidToDate?: TStamp;
540 /**
541 * The signing algorithm for the certificate.
542 */
543 SigningAlgorithm?: String;
544 /**
545 * The key length of the cryptographic algorithm being used.
546 */
547 KeyLength?: IntegerOptional;
548 }
549 export type CertificateList = Certificate[];
550 export type CertificateWallet = Buffer|Uint8Array|Blob|string;
551 export type CompressionTypeValue = "none"|"gzip"|string;
552 export interface Connection {
553 /**
554 * The Amazon Resource Name (ARN) of the replication instance.
555 */
556 ReplicationInstanceArn?: String;
557 /**
558 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
559 */
560 EndpointArn?: String;
561 /**
562 * The connection status.
563 */
564 Status?: String;
565 /**
566 * The error message when the connection last failed.
567 */
568 LastFailureMessage?: String;
569 /**
570 * 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.
571 */
572 EndpointIdentifier?: String;
573 /**
574 * The replication instance identifier. This parameter is stored as a lowercase string.
575 */
576 ReplicationInstanceIdentifier?: String;
577 }
578 export type ConnectionList = Connection[];
579 export interface CreateEndpointMessage {
580 /**
581 * 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.
582 */
583 EndpointIdentifier: String;
584 /**
585 * The type of endpoint.
586 */
587 EndpointType: ReplicationEndpointTypeValue;
588 /**
589 * The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
590 */
591 EngineName: String;
592 /**
593 * The user name to be used to log in to the endpoint database.
594 */
595 Username?: String;
596 /**
597 * The password to be used to log in to the endpoint database.
598 */
599 Password?: SecretString;
600 /**
601 * The name of the server where the endpoint database resides.
602 */
603 ServerName?: String;
604 /**
605 * The port used by the endpoint database.
606 */
607 Port?: IntegerOptional;
608 /**
609 * The name of the endpoint database.
610 */
611 DatabaseName?: String;
612 /**
613 * Additional attributes associated with the connection.
614 */
615 ExtraConnectionAttributes?: String;
616 /**
617 * The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
618 */
619 KmsKeyId?: String;
620 /**
621 * Tags to be added to the endpoint.
622 */
623 Tags?: TagList;
624 /**
625 * The Amazon Resource Name (ARN) for the certificate.
626 */
627 CertificateArn?: String;
628 /**
629 * The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
630 */
631 SslMode?: DmsSslModeValue;
632 /**
633 * The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
634 */
635 ServiceAccessRoleArn?: String;
636 /**
637 * The external table definition.
638 */
639 ExternalTableDefinition?: String;
640 /**
641 * Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
642 */
643 DynamoDbSettings?: DynamoDbSettings;
644 /**
645 * Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
646 */
647 S3Settings?: S3Settings;
648 /**
649 * The settings in JSON format for the DMS transfer type of source endpoint. Possible attributes include the following: serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. bucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value. Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
650 */
651 DmsTransferSettings?: DmsTransferSettings;
652 /**
653 * Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
654 */
655 MongoDbSettings?: MongoDbSettings;
656 /**
657 * Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
658 */
659 KinesisSettings?: KinesisSettings;
660 /**
661 * Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.
662 */
663 ElasticsearchSettings?: ElasticsearchSettings;
664 RedshiftSettings?: RedshiftSettings;
665 }
666 export interface CreateEndpointResponse {
667 /**
668 * The endpoint that was created.
669 */
670 Endpoint?: Endpoint;
671 }
672 export interface CreateEventSubscriptionMessage {
673 /**
674 * The name of the AWS DMS event notification subscription. Constraints: The name must be less than 255 characters.
675 */
676 SubscriptionName: String;
677 /**
678 * The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
679 */
680 SnsTopicArn: String;
681 /**
682 * The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned. Valid values: replication-instance | migration-task
683 */
684 SourceType?: String;
685 /**
686 * A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.
687 */
688 EventCategories?: EventCategoriesList;
689 /**
690 * The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
691 */
692 SourceIds?: SourceIdsList;
693 /**
694 * A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
695 */
696 Enabled?: BooleanOptional;
697 /**
698 * A tag to be attached to the event subscription.
699 */
700 Tags?: TagList;
701 }
702 export interface CreateEventSubscriptionResponse {
703 /**
704 * The event subscription that was created.
705 */
706 EventSubscription?: EventSubscription;
707 }
708 export interface CreateReplicationInstanceMessage {
709 /**
710 * 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
711 */
712 ReplicationInstanceIdentifier: String;
713 /**
714 * The amount of storage (in gigabytes) to be initially allocated for the replication instance.
715 */
716 AllocatedStorage?: IntegerOptional;
717 /**
718 * 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
719 */
720 ReplicationInstanceClass: String;
721 /**
722 * 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.
723 */
724 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
725 /**
726 * 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
727 */
728 AvailabilityZone?: String;
729 /**
730 * A subnet group to associate with the replication instance.
731 */
732 ReplicationSubnetGroupIdentifier?: String;
733 /**
734 * 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.
735 */
736 PreferredMaintenanceWindow?: String;
737 /**
738 * 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.
739 */
740 MultiAZ?: BooleanOptional;
741 /**
742 * The engine version number of the replication instance.
743 */
744 EngineVersion?: String;
745 /**
746 * Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. Default: true
747 */
748 AutoMinorVersionUpgrade?: BooleanOptional;
749 /**
750 * Tags to be associated with the replication instance.
751 */
752 Tags?: TagList;
753 /**
754 * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
755 */
756 KmsKeyId?: String;
757 /**
758 * 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.
759 */
760 PubliclyAccessible?: BooleanOptional;
761 /**
762 * A list of DNS name servers supported for the replication instance.
763 */
764 DnsNameServers?: String;
765 }
766 export interface CreateReplicationInstanceResponse {
767 /**
768 * The replication instance that was created.
769 */
770 ReplicationInstance?: ReplicationInstance;
771 }
772 export interface CreateReplicationSubnetGroupMessage {
773 /**
774 * 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
775 */
776 ReplicationSubnetGroupIdentifier: String;
777 /**
778 * The description for the subnet group.
779 */
780 ReplicationSubnetGroupDescription: String;
781 /**
782 * The EC2 subnet IDs for the subnet group.
783 */
784 SubnetIds: SubnetIdentifierList;
785 /**
786 * The tag to be assigned to the subnet group.
787 */
788 Tags?: TagList;
789 }
790 export interface CreateReplicationSubnetGroupResponse {
791 /**
792 * The replication subnet group that was created.
793 */
794 ReplicationSubnetGroup?: ReplicationSubnetGroup;
795 }
796 export interface CreateReplicationTaskMessage {
797 /**
798 * The replication task identifier. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
799 */
800 ReplicationTaskIdentifier: String;
801 /**
802 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
803 */
804 SourceEndpointArn: String;
805 /**
806 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
807 */
808 TargetEndpointArn: String;
809 /**
810 * The Amazon Resource Name (ARN) of the replication instance.
811 */
812 ReplicationInstanceArn: String;
813 /**
814 * The migration type.
815 */
816 MigrationType: MigrationTypeValue;
817 /**
818 * When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file://". When working with the DMS API, provide the JSON as the parameter value. For example, --table-mappings file://mappingfile.json
819 */
820 TableMappings: String;
821 /**
822 * Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.
823 */
824 ReplicationTaskSettings?: String;
825 /**
826 * Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
827 */
828 CdcStartTime?: TStamp;
829 /**
830 * Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
831 */
832 CdcStartPosition?: String;
833 /**
834 * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
835 */
836 CdcStopPosition?: String;
837 /**
838 * Tags to be added to the replication instance.
839 */
840 Tags?: TagList;
841 }
842 export interface CreateReplicationTaskResponse {
843 /**
844 * The replication task that was created.
845 */
846 ReplicationTask?: ReplicationTask;
847 }
848 export type DataFormatValue = "csv"|"parquet"|string;
849 export interface DeleteCertificateMessage {
850 /**
851 * The Amazon Resource Name (ARN) of the deleted certificate.
852 */
853 CertificateArn: String;
854 }
855 export interface DeleteCertificateResponse {
856 /**
857 * The Secure Sockets Layer (SSL) certificate.
858 */
859 Certificate?: Certificate;
860 }
861 export interface DeleteEndpointMessage {
862 /**
863 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
864 */
865 EndpointArn: String;
866 }
867 export interface DeleteEndpointResponse {
868 /**
869 * The endpoint that was deleted.
870 */
871 Endpoint?: Endpoint;
872 }
873 export interface DeleteEventSubscriptionMessage {
874 /**
875 * The name of the DMS event notification subscription to be deleted.
876 */
877 SubscriptionName: String;
878 }
879 export interface DeleteEventSubscriptionResponse {
880 /**
881 * The event subscription that was deleted.
882 */
883 EventSubscription?: EventSubscription;
884 }
885 export interface DeleteReplicationInstanceMessage {
886 /**
887 * The Amazon Resource Name (ARN) of the replication instance to be deleted.
888 */
889 ReplicationInstanceArn: String;
890 }
891 export interface DeleteReplicationInstanceResponse {
892 /**
893 * The replication instance that was deleted.
894 */
895 ReplicationInstance?: ReplicationInstance;
896 }
897 export interface DeleteReplicationSubnetGroupMessage {
898 /**
899 * The subnet group name of the replication instance.
900 */
901 ReplicationSubnetGroupIdentifier: String;
902 }
903 export interface DeleteReplicationSubnetGroupResponse {
904 }
905 export interface DeleteReplicationTaskMessage {
906 /**
907 * The Amazon Resource Name (ARN) of the replication task to be deleted.
908 */
909 ReplicationTaskArn: String;
910 }
911 export interface DeleteReplicationTaskResponse {
912 /**
913 * The deleted replication task.
914 */
915 ReplicationTask?: ReplicationTask;
916 }
917 export interface DescribeAccountAttributesMessage {
918 }
919 export interface DescribeAccountAttributesResponse {
920 /**
921 * Account quota information.
922 */
923 AccountQuotas?: AccountQuotaList;
924 }
925 export interface DescribeCertificatesMessage {
926 /**
927 * Filters applied to the certificate described in the form of key-value pairs.
928 */
929 Filters?: FilterList;
930 /**
931 * 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
932 */
933 MaxRecords?: IntegerOptional;
934 /**
935 * 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.
936 */
937 Marker?: String;
938 }
939 export interface DescribeCertificatesResponse {
940 /**
941 * The pagination token.
942 */
943 Marker?: String;
944 /**
945 * The Secure Sockets Layer (SSL) certificates associated with the replication instance.
946 */
947 Certificates?: CertificateList;
948 }
949 export interface DescribeConnectionsMessage {
950 /**
951 * The filters applied to the connection. Valid filter names: endpoint-arn | replication-instance-arn
952 */
953 Filters?: FilterList;
954 /**
955 * 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.
956 */
957 MaxRecords?: IntegerOptional;
958 /**
959 * 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.
960 */
961 Marker?: String;
962 }
963 export interface DescribeConnectionsResponse {
964 /**
965 * 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.
966 */
967 Marker?: String;
968 /**
969 * A description of the connections.
970 */
971 Connections?: ConnectionList;
972 }
973 export interface DescribeEndpointTypesMessage {
974 /**
975 * Filters applied to the describe action. Valid filter names: engine-name | endpoint-type
976 */
977 Filters?: FilterList;
978 /**
979 * 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.
980 */
981 MaxRecords?: IntegerOptional;
982 /**
983 * 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.
984 */
985 Marker?: String;
986 }
987 export interface DescribeEndpointTypesResponse {
988 /**
989 * 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.
990 */
991 Marker?: String;
992 /**
993 * The type of endpoints that are supported.
994 */
995 SupportedEndpointTypes?: SupportedEndpointTypeList;
996 }
997 export interface DescribeEndpointsMessage {
998 /**
999 * Filters applied to the describe action. Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
1000 */
1001 Filters?: FilterList;
1002 /**
1003 * 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.
1004 */
1005 MaxRecords?: IntegerOptional;
1006 /**
1007 * 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.
1008 */
1009 Marker?: String;
1010 }
1011 export interface DescribeEndpointsResponse {
1012 /**
1013 * 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.
1014 */
1015 Marker?: String;
1016 /**
1017 * Endpoint description.
1018 */
1019 Endpoints?: EndpointList;
1020 }
1021 export interface DescribeEventCategoriesMessage {
1022 /**
1023 * The type of AWS DMS resource that generates events. Valid values: replication-instance | migration-task
1024 */
1025 SourceType?: String;
1026 /**
1027 * Filters applied to the action.
1028 */
1029 Filters?: FilterList;
1030 }
1031 export interface DescribeEventCategoriesResponse {
1032 /**
1033 * A list of event categories.
1034 */
1035 EventCategoryGroupList?: EventCategoryGroupList;
1036 }
1037 export interface DescribeEventSubscriptionsMessage {
1038 /**
1039 * The name of the AWS DMS event subscription to be described.
1040 */
1041 SubscriptionName?: String;
1042 /**
1043 * Filters applied to the action.
1044 */
1045 Filters?: FilterList;
1046 /**
1047 * 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.
1048 */
1049 MaxRecords?: IntegerOptional;
1050 /**
1051 * 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.
1052 */
1053 Marker?: String;
1054 }
1055 export interface DescribeEventSubscriptionsResponse {
1056 /**
1057 * 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.
1058 */
1059 Marker?: String;
1060 /**
1061 * A list of event subscriptions.
1062 */
1063 EventSubscriptionsList?: EventSubscriptionsList;
1064 }
1065 export interface DescribeEventsMessage {
1066 /**
1067 * The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.
1068 */
1069 SourceIdentifier?: String;
1070 /**
1071 * The type of AWS DMS resource that generates events. Valid values: replication-instance | migration-task
1072 */
1073 SourceType?: SourceType;
1074 /**
1075 * The start time for the events to be listed.
1076 */
1077 StartTime?: TStamp;
1078 /**
1079 * The end time for the events to be listed.
1080 */
1081 EndTime?: TStamp;
1082 /**
1083 * The duration of the events to be listed.
1084 */
1085 Duration?: IntegerOptional;
1086 /**
1087 * A list of event categories for a source type that you want to subscribe to.
1088 */
1089 EventCategories?: EventCategoriesList;
1090 /**
1091 * Filters applied to the action.
1092 */
1093 Filters?: FilterList;
1094 /**
1095 * 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.
1096 */
1097 MaxRecords?: IntegerOptional;
1098 /**
1099 * 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.
1100 */
1101 Marker?: String;
1102 }
1103 export interface DescribeEventsResponse {
1104 /**
1105 * 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.
1106 */
1107 Marker?: String;
1108 /**
1109 * The events described.
1110 */
1111 Events?: EventList;
1112 }
1113 export interface DescribeOrderableReplicationInstancesMessage {
1114 /**
1115 * 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.
1116 */
1117 MaxRecords?: IntegerOptional;
1118 /**
1119 * 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.
1120 */
1121 Marker?: String;
1122 }
1123 export interface DescribeOrderableReplicationInstancesResponse {
1124 /**
1125 * The order-able replication instances available.
1126 */
1127 OrderableReplicationInstances?: OrderableReplicationInstanceList;
1128 /**
1129 * 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.
1130 */
1131 Marker?: String;
1132 }
1133 export interface DescribePendingMaintenanceActionsMessage {
1134 /**
1135 * The ARN of the replication instance.
1136 */
1137 ReplicationInstanceArn?: String;
1138 /**
1139 *
1140 */
1141 Filters?: FilterList;
1142 /**
1143 * 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.
1144 */
1145 Marker?: String;
1146 /**
1147 * 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.
1148 */
1149 MaxRecords?: IntegerOptional;
1150 }
1151 export interface DescribePendingMaintenanceActionsResponse {
1152 /**
1153 * The pending maintenance action.
1154 */
1155 PendingMaintenanceActions?: PendingMaintenanceActions;
1156 /**
1157 * 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.
1158 */
1159 Marker?: String;
1160 }
1161 export interface DescribeRefreshSchemasStatusMessage {
1162 /**
1163 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1164 */
1165 EndpointArn: String;
1166 }
1167 export interface DescribeRefreshSchemasStatusResponse {
1168 /**
1169 * The status of the schema.
1170 */
1171 RefreshSchemasStatus?: RefreshSchemasStatus;
1172 }
1173 export interface DescribeReplicationInstanceTaskLogsMessage {
1174 /**
1175 * The Amazon Resource Name (ARN) of the replication instance.
1176 */
1177 ReplicationInstanceArn: String;
1178 /**
1179 * 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.
1180 */
1181 MaxRecords?: IntegerOptional;
1182 /**
1183 * 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.
1184 */
1185 Marker?: String;
1186 }
1187 export interface DescribeReplicationInstanceTaskLogsResponse {
1188 /**
1189 * The Amazon Resource Name (ARN) of the replication instance.
1190 */
1191 ReplicationInstanceArn?: String;
1192 /**
1193 * An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).
1194 */
1195 ReplicationInstanceTaskLogs?: ReplicationInstanceTaskLogsList;
1196 /**
1197 * 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.
1198 */
1199 Marker?: String;
1200 }
1201 export interface DescribeReplicationInstancesMessage {
1202 /**
1203 * Filters applied to the describe action. Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
1204 */
1205 Filters?: FilterList;
1206 /**
1207 * 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.
1208 */
1209 MaxRecords?: IntegerOptional;
1210 /**
1211 * 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.
1212 */
1213 Marker?: String;
1214 }
1215 export interface DescribeReplicationInstancesResponse {
1216 /**
1217 * 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.
1218 */
1219 Marker?: String;
1220 /**
1221 * The replication instances described.
1222 */
1223 ReplicationInstances?: ReplicationInstanceList;
1224 }
1225 export interface DescribeReplicationSubnetGroupsMessage {
1226 /**
1227 * Filters applied to the describe action.
1228 */
1229 Filters?: FilterList;
1230 /**
1231 * 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.
1232 */
1233 MaxRecords?: IntegerOptional;
1234 /**
1235 * 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.
1236 */
1237 Marker?: String;
1238 }
1239 export interface DescribeReplicationSubnetGroupsResponse {
1240 /**
1241 * 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.
1242 */
1243 Marker?: String;
1244 /**
1245 * A description of the replication subnet groups.
1246 */
1247 ReplicationSubnetGroups?: ReplicationSubnetGroups;
1248 }
1249 export interface DescribeReplicationTaskAssessmentResultsMessage {
1250 /**
1251 * - The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters.
1252 */
1253 ReplicationTaskArn?: String;
1254 /**
1255 * 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.
1256 */
1257 MaxRecords?: IntegerOptional;
1258 /**
1259 * 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.
1260 */
1261 Marker?: String;
1262 }
1263 export interface DescribeReplicationTaskAssessmentResultsResponse {
1264 /**
1265 * 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.
1266 */
1267 Marker?: String;
1268 /**
1269 * - The Amazon S3 bucket where the task assessment report is located.
1270 */
1271 BucketName?: String;
1272 /**
1273 * The task assessment report.
1274 */
1275 ReplicationTaskAssessmentResults?: ReplicationTaskAssessmentResultList;
1276 }
1277 export interface DescribeReplicationTasksMessage {
1278 /**
1279 * Filters applied to the describe action. Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
1280 */
1281 Filters?: FilterList;
1282 /**
1283 * 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.
1284 */
1285 MaxRecords?: IntegerOptional;
1286 /**
1287 * 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.
1288 */
1289 Marker?: String;
1290 /**
1291 * Set this flag to avoid returning setting information. Use this to reduce overhead when settings are too large. Choose TRUE to use this flag, otherwise choose FALSE (default).
1292 */
1293 WithoutSettings?: BooleanOptional;
1294 }
1295 export interface DescribeReplicationTasksResponse {
1296 /**
1297 * 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.
1298 */
1299 Marker?: String;
1300 /**
1301 * A description of the replication tasks.
1302 */
1303 ReplicationTasks?: ReplicationTaskList;
1304 }
1305 export interface DescribeSchemasMessage {
1306 /**
1307 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1308 */
1309 EndpointArn: String;
1310 /**
1311 * 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.
1312 */
1313 MaxRecords?: IntegerOptional;
1314 /**
1315 * 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.
1316 */
1317 Marker?: String;
1318 }
1319 export interface DescribeSchemasResponse {
1320 /**
1321 * 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.
1322 */
1323 Marker?: String;
1324 /**
1325 * The described schema.
1326 */
1327 Schemas?: SchemaList;
1328 }
1329 export interface DescribeTableStatisticsMessage {
1330 /**
1331 * The Amazon Resource Name (ARN) of the replication task.
1332 */
1333 ReplicationTaskArn: String;
1334 /**
1335 * 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 500.
1336 */
1337 MaxRecords?: IntegerOptional;
1338 /**
1339 * 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.
1340 */
1341 Marker?: String;
1342 /**
1343 * Filters applied to the describe table statistics action. Valid filter names: schema-name | table-name | table-state A combination of filters creates an AND condition where each record matches all specified filters.
1344 */
1345 Filters?: FilterList;
1346 }
1347 export interface DescribeTableStatisticsResponse {
1348 /**
1349 * The Amazon Resource Name (ARN) of the replication task.
1350 */
1351 ReplicationTaskArn?: String;
1352 /**
1353 * The table statistics.
1354 */
1355 TableStatistics?: TableStatisticsList;
1356 /**
1357 * 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.
1358 */
1359 Marker?: String;
1360 }
1361 export type DmsSslModeValue = "none"|"require"|"verify-ca"|"verify-full"|string;
1362 export interface DmsTransferSettings {
1363 /**
1364 * The IAM role that has permission to access the Amazon S3 bucket.
1365 */
1366 ServiceAccessRoleArn?: String;
1367 /**
1368 * The name of the S3 bucket to use.
1369 */
1370 BucketName?: String;
1371 }
1372 export interface DynamoDbSettings {
1373 /**
1374 * The Amazon Resource Name (ARN) used by the service access IAM role.
1375 */
1376 ServiceAccessRoleArn: String;
1377 }
1378 export interface ElasticsearchSettings {
1379 /**
1380 * The Amazon Resource Name (ARN) used by service to access the IAM role.
1381 */
1382 ServiceAccessRoleArn: String;
1383 /**
1384 * The endpoint for the ElasticSearch cluster.
1385 */
1386 EndpointUri: String;
1387 /**
1388 * The maximum percentage of records that can fail to be written before a full load operation stops.
1389 */
1390 FullLoadErrorPercentage?: IntegerOptional;
1391 /**
1392 * The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.
1393 */
1394 ErrorRetryDuration?: IntegerOptional;
1395 }
1396 export type EncodingTypeValue = "plain"|"plain-dictionary"|"rle-dictionary"|string;
1397 export type EncryptionModeValue = "sse-s3"|"sse-kms"|string;
1398 export interface Endpoint {
1399 /**
1400 * 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.
1401 */
1402 EndpointIdentifier?: String;
1403 /**
1404 * The type of endpoint.
1405 */
1406 EndpointType?: ReplicationEndpointTypeValue;
1407 /**
1408 * The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
1409 */
1410 EngineName?: String;
1411 /**
1412 * The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
1413 */
1414 EngineDisplayName?: String;
1415 /**
1416 * The user name used to connect to the endpoint.
1417 */
1418 Username?: String;
1419 /**
1420 * The name of the server at the endpoint.
1421 */
1422 ServerName?: String;
1423 /**
1424 * The port value used to access the endpoint.
1425 */
1426 Port?: IntegerOptional;
1427 /**
1428 * The name of the database at the endpoint.
1429 */
1430 DatabaseName?: String;
1431 /**
1432 * Additional connection attributes used to connect to the endpoint.
1433 */
1434 ExtraConnectionAttributes?: String;
1435 /**
1436 * The status of the endpoint.
1437 */
1438 Status?: String;
1439 /**
1440 * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
1441 */
1442 KmsKeyId?: String;
1443 /**
1444 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1445 */
1446 EndpointArn?: String;
1447 /**
1448 * The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
1449 */
1450 CertificateArn?: String;
1451 /**
1452 * 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.
1453 */
1454 SslMode?: DmsSslModeValue;
1455 /**
1456 * The Amazon Resource Name (ARN) used by the service access IAM role.
1457 */
1458 ServiceAccessRoleArn?: String;
1459 /**
1460 * The external table definition.
1461 */
1462 ExternalTableDefinition?: String;
1463 /**
1464 * Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
1465 */
1466 ExternalId?: String;
1467 /**
1468 * The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
1469 */
1470 DynamoDbSettings?: DynamoDbSettings;
1471 /**
1472 * The settings for the S3 target endpoint. For more information, see the S3Settings structure.
1473 */
1474 S3Settings?: S3Settings;
1475 /**
1476 * The settings in JSON format for the DMS transfer type of source endpoint. Possible attributes include the following: serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. bucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value. Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
1477 */
1478 DmsTransferSettings?: DmsTransferSettings;
1479 /**
1480 * The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
1481 */
1482 MongoDbSettings?: MongoDbSettings;
1483 /**
1484 * The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.
1485 */
1486 KinesisSettings?: KinesisSettings;
1487 /**
1488 * The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
1489 */
1490 ElasticsearchSettings?: ElasticsearchSettings;
1491 /**
1492 * Settings for the Amazon Redshift endpoint
1493 */
1494 RedshiftSettings?: RedshiftSettings;
1495 }
1496 export type EndpointList = Endpoint[];
1497 export interface Event {
1498 /**
1499 * The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. Constraints:replication instance, endpoint, migration task
1500 */
1501 SourceIdentifier?: String;
1502 /**
1503 * The type of AWS DMS resource that generates events. Valid values: replication-instance | endpoint | migration-task
1504 */
1505 SourceType?: SourceType;
1506 /**
1507 * The event message.
1508 */
1509 Message?: String;
1510 /**
1511 * The event categories available for the specified source type.
1512 */
1513 EventCategories?: EventCategoriesList;
1514 /**
1515 * The date of the event.
1516 */
1517 Date?: TStamp;
1518 }
1519 export type EventCategoriesList = String[];
1520 export interface EventCategoryGroup {
1521 /**
1522 * The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | migration-task
1523 */
1524 SourceType?: String;
1525 /**
1526 * A list of event categories for a SourceType that you want to subscribe to.
1527 */
1528 EventCategories?: EventCategoriesList;
1529 }
1530 export type EventCategoryGroupList = EventCategoryGroup[];
1531 export type EventList = Event[];
1532 export interface EventSubscription {
1533 /**
1534 * The AWS customer account associated with the AWS DMS event notification subscription.
1535 */
1536 CustomerAwsId?: String;
1537 /**
1538 * The AWS DMS event notification subscription Id.
1539 */
1540 CustSubscriptionId?: String;
1541 /**
1542 * The topic ARN of the AWS DMS event notification subscription.
1543 */
1544 SnsTopicArn?: String;
1545 /**
1546 * The status of the AWS DMS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
1547 */
1548 Status?: String;
1549 /**
1550 * The time the RDS event notification subscription was created.
1551 */
1552 SubscriptionCreationTime?: String;
1553 /**
1554 * The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | migration-task
1555 */
1556 SourceType?: String;
1557 /**
1558 * A list of source Ids for the event subscription.
1559 */
1560 SourceIdsList?: SourceIdsList;
1561 /**
1562 * A lists of event categories.
1563 */
1564 EventCategoriesList?: EventCategoriesList;
1565 /**
1566 * Boolean value that indicates if the event subscription is enabled.
1567 */
1568 Enabled?: Boolean;
1569 }
1570 export type EventSubscriptionsList = EventSubscription[];
1571 export interface Filter {
1572 /**
1573 * The name of the filter.
1574 */
1575 Name: String;
1576 /**
1577 * The filter value.
1578 */
1579 Values: FilterValueList;
1580 }
1581 export type FilterList = Filter[];
1582 export type FilterValueList = String[];
1583 export interface ImportCertificateMessage {
1584 /**
1585 * The customer-assigned name of the certificate. Valid characters are A-z and 0-9.
1586 */
1587 CertificateIdentifier: String;
1588 /**
1589 * The contents of the .pem X.509 certificate file for the certificate.
1590 */
1591 CertificatePem?: String;
1592 /**
1593 * The location of the imported Oracle Wallet certificate for use with SSL.
1594 */
1595 CertificateWallet?: CertificateWallet;
1596 /**
1597 * The tags associated with the certificate.
1598 */
1599 Tags?: TagList;
1600 }
1601 export interface ImportCertificateResponse {
1602 /**
1603 * The certificate to be uploaded.
1604 */
1605 Certificate?: Certificate;
1606 }
1607 export type Integer = number;
1608 export type IntegerOptional = number;
1609 export type KeyList = String[];
1610 export interface KinesisSettings {
1611 /**
1612 * The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
1613 */
1614 StreamArn?: String;
1615 /**
1616 * The output format for the records created on the endpoint. The message format is JSON.
1617 */
1618 MessageFormat?: MessageFormatValue;
1619 /**
1620 * The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
1621 */
1622 ServiceAccessRoleArn?: String;
1623 }
1624 export interface ListTagsForResourceMessage {
1625 /**
1626 * The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
1627 */
1628 ResourceArn: String;
1629 }
1630 export interface ListTagsForResourceResponse {
1631 /**
1632 * A list of tags for the resource.
1633 */
1634 TagList?: TagList;
1635 }
1636 export type Long = number;
1637 export type MessageFormatValue = "json"|string;
1638 export type MigrationTypeValue = "full-load"|"cdc"|"full-load-and-cdc"|string;
1639 export interface ModifyEndpointMessage {
1640 /**
1641 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
1642 */
1643 EndpointArn: String;
1644 /**
1645 * 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.
1646 */
1647 EndpointIdentifier?: String;
1648 /**
1649 * The type of endpoint.
1650 */
1651 EndpointType?: ReplicationEndpointTypeValue;
1652 /**
1653 * The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
1654 */
1655 EngineName?: String;
1656 /**
1657 * The user name to be used to login to the endpoint database.
1658 */
1659 Username?: String;
1660 /**
1661 * The password to be used to login to the endpoint database.
1662 */
1663 Password?: SecretString;
1664 /**
1665 * The name of the server where the endpoint database resides.
1666 */
1667 ServerName?: String;
1668 /**
1669 * The port used by the endpoint database.
1670 */
1671 Port?: IntegerOptional;
1672 /**
1673 * The name of the endpoint database.
1674 */
1675 DatabaseName?: String;
1676 /**
1677 * Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
1678 */
1679 ExtraConnectionAttributes?: String;
1680 /**
1681 * The Amazon Resource Name (ARN) of the certificate used for SSL connection.
1682 */
1683 CertificateArn?: String;
1684 /**
1685 * 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.
1686 */
1687 SslMode?: DmsSslModeValue;
1688 /**
1689 * The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
1690 */
1691 ServiceAccessRoleArn?: String;
1692 /**
1693 * The external table definition.
1694 */
1695 ExternalTableDefinition?: String;
1696 /**
1697 * Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
1698 */
1699 DynamoDbSettings?: DynamoDbSettings;
1700 /**
1701 * Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
1702 */
1703 S3Settings?: S3Settings;
1704 /**
1705 * The settings in JSON format for the DMS transfer type of source endpoint. Attributes include the following: serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. BucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string JSON syntax: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
1706 */
1707 DmsTransferSettings?: DmsTransferSettings;
1708 /**
1709 * Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
1710 */
1711 MongoDbSettings?: MongoDbSettings;
1712 /**
1713 * Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
1714 */
1715 KinesisSettings?: KinesisSettings;
1716 /**
1717 * Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.
1718 */
1719 ElasticsearchSettings?: ElasticsearchSettings;
1720 RedshiftSettings?: RedshiftSettings;
1721 }
1722 export interface ModifyEndpointResponse {
1723 /**
1724 * The modified endpoint.
1725 */
1726 Endpoint?: Endpoint;
1727 }
1728 export interface ModifyEventSubscriptionMessage {
1729 /**
1730 * The name of the AWS DMS event notification subscription to be modified.
1731 */
1732 SubscriptionName: String;
1733 /**
1734 * The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
1735 */
1736 SnsTopicArn?: String;
1737 /**
1738 * The type of AWS DMS resource that generates the events you want to subscribe to. Valid values: replication-instance | migration-task
1739 */
1740 SourceType?: String;
1741 /**
1742 * A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.
1743 */
1744 EventCategories?: EventCategoriesList;
1745 /**
1746 * A Boolean value; set to true to activate the subscription.
1747 */
1748 Enabled?: BooleanOptional;
1749 }
1750 export interface ModifyEventSubscriptionResponse {
1751 /**
1752 * The modified event subscription.
1753 */
1754 EventSubscription?: EventSubscription;
1755 }
1756 export interface ModifyReplicationInstanceMessage {
1757 /**
1758 * The Amazon Resource Name (ARN) of the replication instance.
1759 */
1760 ReplicationInstanceArn: String;
1761 /**
1762 * The amount of storage (in gigabytes) to be allocated for the replication instance.
1763 */
1764 AllocatedStorage?: IntegerOptional;
1765 /**
1766 * Indicates whether the changes should be applied immediately or during the next maintenance window.
1767 */
1768 ApplyImmediately?: Boolean;
1769 /**
1770 * 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
1771 */
1772 ReplicationInstanceClass?: String;
1773 /**
1774 * 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.
1775 */
1776 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1777 /**
1778 * 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
1779 */
1780 PreferredMaintenanceWindow?: String;
1781 /**
1782 * 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.
1783 */
1784 MultiAZ?: BooleanOptional;
1785 /**
1786 * The engine version number of the replication instance.
1787 */
1788 EngineVersion?: String;
1789 /**
1790 * 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.
1791 */
1792 AllowMajorVersionUpgrade?: Boolean;
1793 /**
1794 * 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.
1795 */
1796 AutoMinorVersionUpgrade?: BooleanOptional;
1797 /**
1798 * The replication instance identifier. This parameter is stored as a lowercase string.
1799 */
1800 ReplicationInstanceIdentifier?: String;
1801 }
1802 export interface ModifyReplicationInstanceResponse {
1803 /**
1804 * The modified replication instance.
1805 */
1806 ReplicationInstance?: ReplicationInstance;
1807 }
1808 export interface ModifyReplicationSubnetGroupMessage {
1809 /**
1810 * The name of the replication instance subnet group.
1811 */
1812 ReplicationSubnetGroupIdentifier: String;
1813 /**
1814 * The description of the replication instance subnet group.
1815 */
1816 ReplicationSubnetGroupDescription?: String;
1817 /**
1818 * A list of subnet IDs.
1819 */
1820 SubnetIds: SubnetIdentifierList;
1821 }
1822 export interface ModifyReplicationSubnetGroupResponse {
1823 /**
1824 * The modified replication subnet group.
1825 */
1826 ReplicationSubnetGroup?: ReplicationSubnetGroup;
1827 }
1828 export interface ModifyReplicationTaskMessage {
1829 /**
1830 * The Amazon Resource Name (ARN) of the replication task.
1831 */
1832 ReplicationTaskArn: String;
1833 /**
1834 * The replication task identifier. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
1835 */
1836 ReplicationTaskIdentifier?: String;
1837 /**
1838 * The migration type. Valid values: full-load | cdc | full-load-and-cdc
1839 */
1840 MigrationType?: MigrationTypeValue;
1841 /**
1842 * When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file://". When working with the DMS API, provide the JSON as the parameter value. For example, --table-mappings file://mappingfile.json
1843 */
1844 TableMappings?: String;
1845 /**
1846 * JSON file that contains settings for the task, such as target metadata settings.
1847 */
1848 ReplicationTaskSettings?: String;
1849 /**
1850 * Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
1851 */
1852 CdcStartTime?: TStamp;
1853 /**
1854 * Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
1855 */
1856 CdcStartPosition?: String;
1857 /**
1858 * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
1859 */
1860 CdcStopPosition?: String;
1861 }
1862 export interface ModifyReplicationTaskResponse {
1863 /**
1864 * The replication task that was modified.
1865 */
1866 ReplicationTask?: ReplicationTask;
1867 }
1868 export interface MongoDbSettings {
1869 /**
1870 * The user name you use to access the MongoDB source endpoint.
1871 */
1872 Username?: String;
1873 /**
1874 * The password for the user account you use to access the MongoDB source endpoint.
1875 */
1876 Password?: SecretString;
1877 /**
1878 * The name of the server on the MongoDB source endpoint.
1879 */
1880 ServerName?: String;
1881 /**
1882 * The port value for the MongoDB source endpoint.
1883 */
1884 Port?: IntegerOptional;
1885 /**
1886 * The database name on the MongoDB source endpoint.
1887 */
1888 DatabaseName?: String;
1889 /**
1890 * The authentication type you use to access the MongoDB source endpoint. Valid values: NO, PASSWORD When NO is selected, user name and password parameters are not used and can be empty.
1891 */
1892 AuthType?: AuthTypeValue;
1893 /**
1894 * The authentication mechanism you use to access the MongoDB source endpoint. Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
1895 */
1896 AuthMechanism?: AuthMechanismValue;
1897 /**
1898 * Specifies either document or table mode. Valid values: NONE, ONE Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
1899 */
1900 NestingLevel?: NestingLevelValue;
1901 /**
1902 * Specifies the document ID. Use this attribute when NestingLevel is set to NONE. Default value is false.
1903 */
1904 ExtractDocId?: String;
1905 /**
1906 * Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE. Must be a positive value greater than 0. Default value is 1000.
1907 */
1908 DocsToInvestigate?: String;
1909 /**
1910 * The MongoDB database name. This attribute is not used when authType=NO. The default is admin.
1911 */
1912 AuthSource?: String;
1913 /**
1914 * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
1915 */
1916 KmsKeyId?: String;
1917 }
1918 export type NestingLevelValue = "none"|"one"|string;
1919 export interface OrderableReplicationInstance {
1920 /**
1921 * The version of the replication engine.
1922 */
1923 EngineVersion?: String;
1924 /**
1925 * 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
1926 */
1927 ReplicationInstanceClass?: String;
1928 /**
1929 * The type of storage used by the replication instance.
1930 */
1931 StorageType?: String;
1932 /**
1933 * The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
1934 */
1935 MinAllocatedStorage?: Integer;
1936 /**
1937 * The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
1938 */
1939 MaxAllocatedStorage?: Integer;
1940 /**
1941 * The default amount of storage (in gigabytes) that is allocated for the replication instance.
1942 */
1943 DefaultAllocatedStorage?: Integer;
1944 /**
1945 * The amount of storage (in gigabytes) that is allocated for the replication instance.
1946 */
1947 IncludedAllocatedStorage?: Integer;
1948 /**
1949 * List of availability zones for this replication instance.
1950 */
1951 AvailabilityZones?: AvailabilityZonesList;
1952 }
1953 export type OrderableReplicationInstanceList = OrderableReplicationInstance[];
1954 export type ParquetVersionValue = "parquet-1-0"|"parquet-2-0"|string;
1955 export interface PendingMaintenanceAction {
1956 /**
1957 * The type of pending maintenance action that is available for the resource.
1958 */
1959 Action?: String;
1960 /**
1961 * The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.
1962 */
1963 AutoAppliedAfterDate?: TStamp;
1964 /**
1965 * The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
1966 */
1967 ForcedApplyDate?: TStamp;
1968 /**
1969 * Indicates the type of opt-in request that has been received for the resource.
1970 */
1971 OptInStatus?: String;
1972 /**
1973 * The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
1974 */
1975 CurrentApplyDate?: TStamp;
1976 /**
1977 * A description providing more detail about the maintenance action.
1978 */
1979 Description?: String;
1980 }
1981 export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
1982 export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
1983 export interface RebootReplicationInstanceMessage {
1984 /**
1985 * The Amazon Resource Name (ARN) of the replication instance.
1986 */
1987 ReplicationInstanceArn: String;
1988 /**
1989 * If this parameter is true, the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify true.)
1990 */
1991 ForceFailover?: BooleanOptional;
1992 }
1993 export interface RebootReplicationInstanceResponse {
1994 /**
1995 * The replication instance that is being rebooted.
1996 */
1997 ReplicationInstance?: ReplicationInstance;
1998 }
1999 export interface RedshiftSettings {
2000 /**
2001 * Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default). This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
2002 */
2003 AcceptAnyDate?: BooleanOptional;
2004 /**
2005 * Code to run after connecting. This should be the code, not a filename.
2006 */
2007 AfterConnectScript?: String;
2008 /**
2009 * The location where the CSV files are stored before being uploaded to the S3 bucket.
2010 */
2011 BucketFolder?: String;
2012 /**
2013 * The name of the S3 bucket you want to use
2014 */
2015 BucketName?: String;
2016 /**
2017 * Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
2018 */
2019 ConnectionTimeout?: IntegerOptional;
2020 /**
2021 * The name of the Amazon Redshift data warehouse (service) you are working with.
2022 */
2023 DatabaseName?: String;
2024 /**
2025 * The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string. If your date and time values use formats different from each other, set this to auto.
2026 */
2027 DateFormat?: String;
2028 /**
2029 * Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
2030 */
2031 EmptyAsNull?: BooleanOptional;
2032 /**
2033 * The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
2034 */
2035 EncryptionMode?: EncryptionModeValue;
2036 /**
2037 * Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
2038 */
2039 FileTransferUploadStreams?: IntegerOptional;
2040 /**
2041 * Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
2042 */
2043 LoadTimeout?: IntegerOptional;
2044 /**
2045 * Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
2046 */
2047 MaxFileSize?: IntegerOptional;
2048 /**
2049 * The password for the user named in the username property.
2050 */
2051 Password?: SecretString;
2052 /**
2053 * The port number for Amazon Redshift. The default value is 5439.
2054 */
2055 Port?: IntegerOptional;
2056 /**
2057 * Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
2058 */
2059 RemoveQuotes?: BooleanOptional;
2060 /**
2061 * A list of chars you want to replace. Use with ReplaceChars.
2062 */
2063 ReplaceInvalidChars?: String;
2064 /**
2065 * Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
2066 */
2067 ReplaceChars?: String;
2068 /**
2069 * The name of the Amazon Redshift cluster you are using.
2070 */
2071 ServerName?: String;
2072 /**
2073 * The ARN of the role that has access to the Redshift service.
2074 */
2075 ServiceAccessRoleArn?: String;
2076 /**
2077 * If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
2078 */
2079 ServerSideEncryptionKmsKeyId?: String;
2080 /**
2081 * The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string. If your date and time values use formats different from each other, set this to auto.
2082 */
2083 TimeFormat?: String;
2084 /**
2085 * Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
2086 */
2087 TrimBlanks?: BooleanOptional;
2088 /**
2089 * Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
2090 */
2091 TruncateColumns?: BooleanOptional;
2092 /**
2093 * An Amazon Redshift user name for a registered user.
2094 */
2095 Username?: String;
2096 /**
2097 * The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
2098 */
2099 WriteBufferSize?: IntegerOptional;
2100 }
2101 export interface RefreshSchemasMessage {
2102 /**
2103 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
2104 */
2105 EndpointArn: String;
2106 /**
2107 * The Amazon Resource Name (ARN) of the replication instance.
2108 */
2109 ReplicationInstanceArn: String;
2110 }
2111 export interface RefreshSchemasResponse {
2112 /**
2113 * The status of the refreshed schema.
2114 */
2115 RefreshSchemasStatus?: RefreshSchemasStatus;
2116 }
2117 export interface RefreshSchemasStatus {
2118 /**
2119 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
2120 */
2121 EndpointArn?: String;
2122 /**
2123 * The Amazon Resource Name (ARN) of the replication instance.
2124 */
2125 ReplicationInstanceArn?: String;
2126 /**
2127 * The status of the schema.
2128 */
2129 Status?: RefreshSchemasStatusTypeValue;
2130 /**
2131 * The date the schema was last refreshed.
2132 */
2133 LastRefreshDate?: TStamp;
2134 /**
2135 * The last failure message for the schema.
2136 */
2137 LastFailureMessage?: String;
2138 }
2139 export type RefreshSchemasStatusTypeValue = "successful"|"failed"|"refreshing"|string;
2140 export type ReloadOptionValue = "data-reload"|"validate-only"|string;
2141 export interface ReloadTablesMessage {
2142 /**
2143 * The Amazon Resource Name (ARN) of the replication task.
2144 */
2145 ReplicationTaskArn: String;
2146 /**
2147 * The name and schema of the table to be reloaded.
2148 */
2149 TablesToReload: TableListToReload;
2150 /**
2151 * Options for reload. Specify data-reload to reload the data and re-validate it if validation is enabled. Specify validate-only to re-validate the table. This option applies only when validation is enabled for the task. Valid values: data-reload, validate-only Default value is data-reload.
2152 */
2153 ReloadOption?: ReloadOptionValue;
2154 }
2155 export interface ReloadTablesResponse {
2156 /**
2157 * The Amazon Resource Name (ARN) of the replication task.
2158 */
2159 ReplicationTaskArn?: String;
2160 }
2161 export interface RemoveTagsFromResourceMessage {
2162 /**
2163 * &gt;The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from.
2164 */
2165 ResourceArn: String;
2166 /**
2167 * The tag key (name) of the tag to be removed.
2168 */
2169 TagKeys: KeyList;
2170 }
2171 export interface RemoveTagsFromResourceResponse {
2172 }
2173 export type ReplicationEndpointTypeValue = "source"|"target"|string;
2174 export interface ReplicationInstance {
2175 /**
2176 * 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
2177 */
2178 ReplicationInstanceIdentifier?: String;
2179 /**
2180 * 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
2181 */
2182 ReplicationInstanceClass?: String;
2183 /**
2184 * The status of the replication instance.
2185 */
2186 ReplicationInstanceStatus?: String;
2187 /**
2188 * The amount of storage (in gigabytes) that is allocated for the replication instance.
2189 */
2190 AllocatedStorage?: Integer;
2191 /**
2192 * The time the replication instance was created.
2193 */
2194 InstanceCreateTime?: TStamp;
2195 /**
2196 * The VPC security group for the instance.
2197 */
2198 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
2199 /**
2200 * The Availability Zone for the instance.
2201 */
2202 AvailabilityZone?: String;
2203 /**
2204 * The subnet group for the replication instance.
2205 */
2206 ReplicationSubnetGroup?: ReplicationSubnetGroup;
2207 /**
2208 * The maintenance window times for the replication instance.
2209 */
2210 PreferredMaintenanceWindow?: String;
2211 /**
2212 * The pending modification values.
2213 */
2214 PendingModifiedValues?: ReplicationPendingModifiedValues;
2215 /**
2216 * 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.
2217 */
2218 MultiAZ?: Boolean;
2219 /**
2220 * The engine version number of the replication instance.
2221 */
2222 EngineVersion?: String;
2223 /**
2224 * Boolean value indicating if minor version upgrades will be automatically applied to the instance.
2225 */
2226 AutoMinorVersionUpgrade?: Boolean;
2227 /**
2228 * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
2229 */
2230 KmsKeyId?: String;
2231 /**
2232 * The Amazon Resource Name (ARN) of the replication instance.
2233 */
2234 ReplicationInstanceArn?: String;
2235 /**
2236 * The public IP address of the replication instance.
2237 */
2238 ReplicationInstancePublicIpAddress?: String;
2239 /**
2240 * The private IP address of the replication instance.
2241 */
2242 ReplicationInstancePrivateIpAddress?: String;
2243 /**
2244 * The public IP address of the replication instance.
2245 */
2246 ReplicationInstancePublicIpAddresses?: ReplicationInstancePublicIpAddressList;
2247 /**
2248 * The private IP address of the replication instance.
2249 */
2250 ReplicationInstancePrivateIpAddresses?: ReplicationInstancePrivateIpAddressList;
2251 /**
2252 * 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.
2253 */
2254 PubliclyAccessible?: Boolean;
2255 /**
2256 * The availability zone of the standby replication instance in a Multi-AZ deployment.
2257 */
2258 SecondaryAvailabilityZone?: String;
2259 /**
2260 * The expiration date of the free replication instance that is part of the Free DMS program.
2261 */
2262 FreeUntil?: TStamp;
2263 /**
2264 * The DNS name servers for the replication instance.
2265 */
2266 DnsNameServers?: String;
2267 }
2268 export type ReplicationInstanceList = ReplicationInstance[];
2269 export type ReplicationInstancePrivateIpAddressList = String[];
2270 export type ReplicationInstancePublicIpAddressList = String[];
2271 export interface ReplicationInstanceTaskLog {
2272 /**
2273 * The name of the replication task.
2274 */
2275 ReplicationTaskName?: String;
2276 /**
2277 * The Amazon Resource Name (ARN) of the replication task.
2278 */
2279 ReplicationTaskArn?: String;
2280 /**
2281 * The size, in bytes, of the replication task log.
2282 */
2283 ReplicationInstanceTaskLogSize?: Long;
2284 }
2285 export type ReplicationInstanceTaskLogsList = ReplicationInstanceTaskLog[];
2286 export interface ReplicationPendingModifiedValues {
2287 /**
2288 * 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
2289 */
2290 ReplicationInstanceClass?: String;
2291 /**
2292 * The amount of storage (in gigabytes) that is allocated for the replication instance.
2293 */
2294 AllocatedStorage?: IntegerOptional;
2295 /**
2296 * 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.
2297 */
2298 MultiAZ?: BooleanOptional;
2299 /**
2300 * The engine version number of the replication instance.
2301 */
2302 EngineVersion?: String;
2303 }
2304 export interface ReplicationSubnetGroup {
2305 /**
2306 * The identifier of the replication instance subnet group.
2307 */
2308 ReplicationSubnetGroupIdentifier?: String;
2309 /**
2310 * The description of the replication subnet group.
2311 */
2312 ReplicationSubnetGroupDescription?: String;
2313 /**
2314 * The ID of the VPC.
2315 */
2316 VpcId?: String;
2317 /**
2318 * The status of the subnet group.
2319 */
2320 SubnetGroupStatus?: String;
2321 /**
2322 * The subnets that are in the subnet group.
2323 */
2324 Subnets?: SubnetList;
2325 }
2326 export type ReplicationSubnetGroups = ReplicationSubnetGroup[];
2327 export interface ReplicationTask {
2328 /**
2329 * The user-assigned replication task identifier or name. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
2330 */
2331 ReplicationTaskIdentifier?: String;
2332 /**
2333 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
2334 */
2335 SourceEndpointArn?: String;
2336 /**
2337 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
2338 */
2339 TargetEndpointArn?: String;
2340 /**
2341 * The Amazon Resource Name (ARN) of the replication instance.
2342 */
2343 ReplicationInstanceArn?: String;
2344 /**
2345 * The type of migration.
2346 */
2347 MigrationType?: MigrationTypeValue;
2348 /**
2349 * Table mappings specified in the task.
2350 */
2351 TableMappings?: String;
2352 /**
2353 * The settings for the replication task.
2354 */
2355 ReplicationTaskSettings?: String;
2356 /**
2357 * The status of the replication task.
2358 */
2359 Status?: String;
2360 /**
2361 * The last error (failure) message generated for the replication instance.
2362 */
2363 LastFailureMessage?: String;
2364 /**
2365 * The reason the replication task was stopped.
2366 */
2367 StopReason?: String;
2368 /**
2369 * The date the replication task was created.
2370 */
2371 ReplicationTaskCreationDate?: TStamp;
2372 /**
2373 * The date the replication task is scheduled to start.
2374 */
2375 ReplicationTaskStartDate?: TStamp;
2376 /**
2377 * Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
2378 */
2379 CdcStartPosition?: String;
2380 /**
2381 * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
2382 */
2383 CdcStopPosition?: String;
2384 /**
2385 * Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
2386 */
2387 RecoveryCheckpoint?: String;
2388 /**
2389 * The Amazon Resource Name (ARN) of the replication task.
2390 */
2391 ReplicationTaskArn?: String;
2392 /**
2393 * The statistics for the task, including elapsed time, tables loaded, and table errors.
2394 */
2395 ReplicationTaskStats?: ReplicationTaskStats;
2396 }
2397 export interface ReplicationTaskAssessmentResult {
2398 /**
2399 * The replication task identifier of the task on which the task assessment was run.
2400 */
2401 ReplicationTaskIdentifier?: String;
2402 /**
2403 * The Amazon Resource Name (ARN) of the replication task.
2404 */
2405 ReplicationTaskArn?: String;
2406 /**
2407 * The date the task assessment was completed.
2408 */
2409 ReplicationTaskLastAssessmentDate?: TStamp;
2410 /**
2411 * The status of the task assessment.
2412 */
2413 AssessmentStatus?: String;
2414 /**
2415 * The file containing the results of the task assessment.
2416 */
2417 AssessmentResultsFile?: String;
2418 /**
2419 * The task assessment results in JSON format.
2420 */
2421 AssessmentResults?: String;
2422 /**
2423 * The URL of the S3 object containing the task assessment results.
2424 */
2425 S3ObjectUrl?: String;
2426 }
2427 export type ReplicationTaskAssessmentResultList = ReplicationTaskAssessmentResult[];
2428 export type ReplicationTaskList = ReplicationTask[];
2429 export interface ReplicationTaskStats {
2430 /**
2431 * The percent complete for the full load migration task.
2432 */
2433 FullLoadProgressPercent?: Integer;
2434 /**
2435 * The elapsed time of the task, in milliseconds.
2436 */
2437 ElapsedTimeMillis?: Long;
2438 /**
2439 * The number of tables loaded for this task.
2440 */
2441 TablesLoaded?: Integer;
2442 /**
2443 * The number of tables currently loading for this task.
2444 */
2445 TablesLoading?: Integer;
2446 /**
2447 * The number of tables queued for this task.
2448 */
2449 TablesQueued?: Integer;
2450 /**
2451 * The number of errors that have occurred during this task.
2452 */
2453 TablesErrored?: Integer;
2454 }
2455 export interface ResourcePendingMaintenanceActions {
2456 /**
2457 * The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) in the DMS documentation.
2458 */
2459 ResourceIdentifier?: String;
2460 /**
2461 * Detailed information about the pending maintenance action.
2462 */
2463 PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails;
2464 }
2465 export interface S3Settings {
2466 /**
2467 * The Amazon Resource Name (ARN) used by the service access IAM role.
2468 */
2469 ServiceAccessRoleArn?: String;
2470 /**
2471 * The external table definition.
2472 */
2473 ExternalTableDefinition?: String;
2474 /**
2475 * The delimiter used to separate rows in the source files. The default is a carriage return (\n).
2476 */
2477 CsvRowDelimiter?: String;
2478 /**
2479 * The delimiter used to separate columns in the source files. The default is a comma.
2480 */
2481 CsvDelimiter?: String;
2482 /**
2483 * An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path &lt;bucketFolder&gt;/&lt;schema_name&gt;/&lt;table_name&gt;/. If this parameter is not specified, then the path used is &lt;schema_name&gt;/&lt;table_name&gt;/.
2484 */
2485 BucketFolder?: String;
2486 /**
2487 * The name of the S3 bucket.
2488 */
2489 BucketName?: String;
2490 /**
2491 * An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.
2492 */
2493 CompressionType?: CompressionTypeValue;
2494 /**
2495 * The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions: s3:CreateBucket s3:ListBucket s3:DeleteBucket s3:GetBucketLocation s3:GetObject s3:PutObject s3:DeleteObject s3:GetObjectVersion s3:GetBucketPolicy s3:PutBucketPolicy s3:DeleteBucketPolicy
2496 */
2497 EncryptionMode?: EncryptionModeValue;
2498 /**
2499 * If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key. Here is a CLI example: aws dms create-endpoint --endpoint-identifier &lt;value&gt; --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=&lt;value&gt;,BucketFolder=&lt;value&gt;,BucketName=&lt;value&gt;,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=&lt;value&gt;
2500 */
2501 ServerSideEncryptionKmsKeyId?: String;
2502 /**
2503 * The format of the data which you want to use for output. You can choose one of the following: CSV : This is a row-based format with comma-separated values. PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.
2504 */
2505 DataFormat?: DataFormatValue;
2506 /**
2507 * The type of encoding you are using: RLE_DICTIONARY (default), PLAIN, or PLAIN_DICTIONARY. RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. PLAIN does not use encoding at all. Values are stored as they are. PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
2508 */
2509 EncodingType?: EncodingTypeValue;
2510 /**
2511 * The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN. Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.
2512 */
2513 DictPageSizeLimit?: IntegerOptional;
2514 /**
2515 * The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only. If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).
2516 */
2517 RowGroupLength?: IntegerOptional;
2518 /**
2519 * The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.
2520 */
2521 DataPageSize?: IntegerOptional;
2522 /**
2523 * The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0.
2524 */
2525 ParquetVersion?: ParquetVersionValue;
2526 /**
2527 * Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL, DISTINCT, MAX, and MIN values. Defaults to TRUE. For PARQUET format only.
2528 */
2529 EnableStatistics?: BooleanOptional;
2530 /**
2531 * Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERTs are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE.
2532 */
2533 CdcInsertsOnly?: BooleanOptional;
2534 }
2535 export type SchemaList = String[];
2536 export type SecretString = string;
2537 export type SourceIdsList = String[];
2538 export type SourceType = "replication-instance"|string;
2539 export interface StartReplicationTaskAssessmentMessage {
2540 /**
2541 * The Amazon Resource Name (ARN) of the replication task.
2542 */
2543 ReplicationTaskArn: String;
2544 }
2545 export interface StartReplicationTaskAssessmentResponse {
2546 /**
2547 * The assessed replication task.
2548 */
2549 ReplicationTask?: ReplicationTask;
2550 }
2551 export interface StartReplicationTaskMessage {
2552 /**
2553 * The Amazon Resource Name (ARN) of the replication task to be started.
2554 */
2555 ReplicationTaskArn: String;
2556 /**
2557 * The type of replication task.
2558 */
2559 StartReplicationTaskType: StartReplicationTaskTypeValue;
2560 /**
2561 * Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
2562 */
2563 CdcStartTime?: TStamp;
2564 /**
2565 * Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
2566 */
2567 CdcStartPosition?: String;
2568 /**
2569 * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
2570 */
2571 CdcStopPosition?: String;
2572 }
2573 export interface StartReplicationTaskResponse {
2574 /**
2575 * The replication task started.
2576 */
2577 ReplicationTask?: ReplicationTask;
2578 }
2579 export type StartReplicationTaskTypeValue = "start-replication"|"resume-processing"|"reload-target"|string;
2580 export interface StopReplicationTaskMessage {
2581 /**
2582 * The Amazon Resource Name(ARN) of the replication task to be stopped.
2583 */
2584 ReplicationTaskArn: String;
2585 }
2586 export interface StopReplicationTaskResponse {
2587 /**
2588 * The replication task stopped.
2589 */
2590 ReplicationTask?: ReplicationTask;
2591 }
2592 export type String = string;
2593 export interface Subnet {
2594 /**
2595 * The subnet identifier.
2596 */
2597 SubnetIdentifier?: String;
2598 /**
2599 * The Availability Zone of the subnet.
2600 */
2601 SubnetAvailabilityZone?: AvailabilityZone;
2602 /**
2603 * The status of the subnet.
2604 */
2605 SubnetStatus?: String;
2606 }
2607 export type SubnetIdentifierList = String[];
2608 export type SubnetList = Subnet[];
2609 export interface SupportedEndpointType {
2610 /**
2611 * The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
2612 */
2613 EngineName?: String;
2614 /**
2615 * Indicates if Change Data Capture (CDC) is supported.
2616 */
2617 SupportsCDC?: Boolean;
2618 /**
2619 * The type of endpoint.
2620 */
2621 EndpointType?: ReplicationEndpointTypeValue;
2622 /**
2623 * The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
2624 */
2625 EngineDisplayName?: String;
2626 }
2627 export type SupportedEndpointTypeList = SupportedEndpointType[];
2628 export type TStamp = Date;
2629 export type TableListToReload = TableToReload[];
2630 export interface TableStatistics {
2631 /**
2632 * The schema name.
2633 */
2634 SchemaName?: String;
2635 /**
2636 * The name of the table.
2637 */
2638 TableName?: String;
2639 /**
2640 * The number of insert actions performed on a table.
2641 */
2642 Inserts?: Long;
2643 /**
2644 * The number of delete actions performed on a table.
2645 */
2646 Deletes?: Long;
2647 /**
2648 * The number of update actions performed on a table.
2649 */
2650 Updates?: Long;
2651 /**
2652 * The Data Definition Language (DDL) used to build and modify the structure of your tables.
2653 */
2654 Ddls?: Long;
2655 /**
2656 * The number of rows added during the Full Load operation.
2657 */
2658 FullLoadRows?: Long;
2659 /**
2660 * The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).
2661 */
2662 FullLoadCondtnlChkFailedRows?: Long;
2663 /**
2664 * The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).
2665 */
2666 FullLoadErrorRows?: Long;
2667 /**
2668 * The last time the table was updated.
2669 */
2670 LastUpdateTime?: TStamp;
2671 /**
2672 * The state of the tables described. Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
2673 */
2674 TableState?: String;
2675 /**
2676 * The number of records that have yet to be validated.
2677 */
2678 ValidationPendingRecords?: Long;
2679 /**
2680 * The number of records that failed validation.
2681 */
2682 ValidationFailedRecords?: Long;
2683 /**
2684 * The number of records that could not be validated.
2685 */
2686 ValidationSuspendedRecords?: Long;
2687 /**
2688 * The validation state of the table. The parameter can have the following values Not enabled—Validation is not enabled for the table in the migration task. Pending records—Some records in the table are waiting for validation. Mismatched records—Some records in the table do not match between the source and target. Suspended records—Some records in the table could not be validated. No primary key—The table could not be validated because it had no primary key. Table error—The table was not validated because it was in an error state and some data was not migrated. Validated—All rows in the table were validated. If the table is updated, the status can change from Validated. Error—The table could not be validated because of an unexpected error.
2689 */
2690 ValidationState?: String;
2691 /**
2692 * Additional details about the state of validation.
2693 */
2694 ValidationStateDetails?: String;
2695 }
2696 export type TableStatisticsList = TableStatistics[];
2697 export interface TableToReload {
2698 /**
2699 * The schema name of the table to be reloaded.
2700 */
2701 SchemaName?: String;
2702 /**
2703 * The table name of the table to be reloaded.
2704 */
2705 TableName?: String;
2706 }
2707 export interface Tag {
2708 /**
2709 * 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}_.:/=+\\-]*)$").
2710 */
2711 Key?: String;
2712 /**
2713 * 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}_.:/=+\\-]*)$").
2714 */
2715 Value?: String;
2716 }
2717 export type TagList = Tag[];
2718 export interface TestConnectionMessage {
2719 /**
2720 * The Amazon Resource Name (ARN) of the replication instance.
2721 */
2722 ReplicationInstanceArn: String;
2723 /**
2724 * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
2725 */
2726 EndpointArn: String;
2727 }
2728 export interface TestConnectionResponse {
2729 /**
2730 * The connection tested.
2731 */
2732 Connection?: Connection;
2733 }
2734 export type VpcSecurityGroupIdList = String[];
2735 export interface VpcSecurityGroupMembership {
2736 /**
2737 * The VPC security group Id.
2738 */
2739 VpcSecurityGroupId?: String;
2740 /**
2741 * The status of the VPC security group.
2742 */
2743 Status?: String;
2744 }
2745 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
2746 /**
2747 * 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.
2748 */
2749 export type apiVersion = "2016-01-01"|"latest"|string;
2750 export interface ClientApiVersions {
2751 /**
2752 * 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.
2753 */
2754 apiVersion?: apiVersion;
2755 }
2756 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2757 /**
2758 * Contains interfaces for use with the DMS client.
2759 */
2760 export import Types = DMS;
2761}
2762export = DMS;