UNPKG

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