@aws-sdk/client-database-migration-service 3.1096.0 → 3.1098.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +1 -1
- package/dist-types/commands/CancelMetadataModelConversionCommand.d.ts +24 -0
- package/dist-types/commands/CancelMetadataModelCreationCommand.d.ts +24 -0
- package/dist-types/commands/CreateDataProviderCommand.d.ts +25 -24
- package/dist-types/commands/CreateInstanceProfileCommand.d.ts +23 -20
- package/dist-types/commands/CreateMigrationProjectCommand.d.ts +36 -36
- package/dist-types/commands/DeleteDataProviderCommand.d.ts +18 -12
- package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +16 -10
- package/dist-types/commands/DeleteMigrationProjectCommand.d.ts +25 -19
- package/dist-types/commands/DescribeConversionConfigurationCommand.d.ts +9 -5
- package/dist-types/commands/DescribeDataProvidersCommand.d.ts +20 -17
- package/dist-types/commands/DescribeExtensionPackAssociationsCommand.d.ts +35 -13
- package/dist-types/commands/DescribeInstanceProfilesCommand.d.ts +20 -14
- package/dist-types/commands/DescribeMetadataModelAssessmentsCommand.d.ts +41 -12
- package/dist-types/commands/DescribeMetadataModelChildrenCommand.d.ts +38 -0
- package/dist-types/commands/DescribeMetadataModelCommand.d.ts +29 -0
- package/dist-types/commands/DescribeMetadataModelConversionsCommand.d.ts +42 -10
- package/dist-types/commands/DescribeMetadataModelCreationsCommand.d.ts +55 -1
- package/dist-types/commands/DescribeMetadataModelExportsAsScriptCommand.d.ts +42 -10
- package/dist-types/commands/DescribeMetadataModelExportsToTargetCommand.d.ts +38 -10
- package/dist-types/commands/DescribeMetadataModelImportsCommand.d.ts +38 -10
- package/dist-types/commands/DescribeMigrationProjectsCommand.d.ts +26 -23
- package/dist-types/commands/ExportMetadataModelAssessmentCommand.d.ts +15 -10
- package/dist-types/commands/GetTargetSelectionRulesCommand.d.ts +20 -0
- package/dist-types/commands/ModifyConversionConfigurationCommand.d.ts +9 -5
- package/dist-types/commands/ModifyDataProviderCommand.d.ts +20 -18
- package/dist-types/commands/ModifyInstanceProfileCommand.d.ts +18 -18
- package/dist-types/commands/ModifyMigrationProjectCommand.d.ts +27 -36
- package/dist-types/commands/StartExtensionPackAssociationCommand.d.ts +18 -7
- package/dist-types/commands/StartMetadataModelAssessmentCommand.d.ts +22 -10
- package/dist-types/commands/StartMetadataModelConversionCommand.d.ts +56 -6
- package/dist-types/commands/StartMetadataModelCreationCommand.d.ts +53 -2
- package/dist-types/commands/StartMetadataModelExportAsScriptCommand.d.ts +22 -9
- package/dist-types/commands/StartMetadataModelExportToTargetCommand.d.ts +25 -6
- package/dist-types/commands/StartMetadataModelImportCommand.d.ts +16 -8
- package/dist-types/models/models_0.d.ts +339 -71
- package/dist-types/models/models_1.d.ts +93 -25
- package/package.json +6 -6
|
@@ -354,17 +354,17 @@ export declare namespace ErrorDetails {
|
|
|
354
354
|
}
|
|
355
355
|
}
|
|
356
356
|
/**
|
|
357
|
-
* <p>
|
|
357
|
+
* <p>The Amazon S3 location of the ZIP archive that contains the exported data definition language (DDL) scripts.</p>
|
|
358
358
|
* @public
|
|
359
359
|
*/
|
|
360
360
|
export interface ExportSqlDetails {
|
|
361
361
|
/**
|
|
362
|
-
* <p>The Amazon S3
|
|
362
|
+
* <p>The Amazon S3 URI of the object that contains the ZIP archive with exported DDL scripts.</p>
|
|
363
363
|
* @public
|
|
364
364
|
*/
|
|
365
365
|
S3ObjectKey?: string | undefined;
|
|
366
366
|
/**
|
|
367
|
-
* <p>The URL
|
|
367
|
+
* <p>The URL of the Amazon S3 object that contains the ZIP archive with exported DDL scripts.</p>
|
|
368
368
|
* @public
|
|
369
369
|
*/
|
|
370
370
|
ObjectURL?: string | undefined;
|
|
@@ -455,7 +455,33 @@ export interface Progress {
|
|
|
455
455
|
*/
|
|
456
456
|
export interface SchemaConversionRequest {
|
|
457
457
|
/**
|
|
458
|
-
* <p>The schema conversion
|
|
458
|
+
* <p>The schema conversion operation status. Possible values:</p>
|
|
459
|
+
* <ul>
|
|
460
|
+
* <li>
|
|
461
|
+
* <p>
|
|
462
|
+
* <code>RECEIVED</code> – The operation is received but not yet queued for processing.</p>
|
|
463
|
+
* </li>
|
|
464
|
+
* <li>
|
|
465
|
+
* <p>
|
|
466
|
+
* <code>IN_PROGRESS</code> – The operation is queued or actively running.</p>
|
|
467
|
+
* </li>
|
|
468
|
+
* <li>
|
|
469
|
+
* <p>
|
|
470
|
+
* <code>SUCCESS</code> – The operation completed successfully.</p>
|
|
471
|
+
* </li>
|
|
472
|
+
* <li>
|
|
473
|
+
* <p>
|
|
474
|
+
* <code>FAILED</code> – The operation did not complete.</p>
|
|
475
|
+
* </li>
|
|
476
|
+
* <li>
|
|
477
|
+
* <p>
|
|
478
|
+
* <code>CANCELING</code> – The operation is being canceled. The operation might still succeed or fail before cancellation takes effect.</p>
|
|
479
|
+
* </li>
|
|
480
|
+
* <li>
|
|
481
|
+
* <p>
|
|
482
|
+
* <code>CANCELED</code> – The operation was canceled before completion.</p>
|
|
483
|
+
* </li>
|
|
484
|
+
* </ul>
|
|
459
485
|
* @public
|
|
460
486
|
*/
|
|
461
487
|
Status?: string | undefined;
|
|
@@ -475,7 +501,10 @@ export interface SchemaConversionRequest {
|
|
|
475
501
|
*/
|
|
476
502
|
Error?: ErrorDetails | undefined;
|
|
477
503
|
/**
|
|
478
|
-
* <p>
|
|
504
|
+
* <p>The Amazon S3 location of the ZIP archive that contains the exported data definition language (DDL) scripts.</p>
|
|
505
|
+
* <note>
|
|
506
|
+
* <p>DMS populates this field only for the <code>DescribeMetadataModelExportsAsScript</code> operation.</p>
|
|
507
|
+
* </note>
|
|
479
508
|
* @public
|
|
480
509
|
*/
|
|
481
510
|
ExportSqlDetails?: ExportSqlDetails | undefined;
|
|
@@ -490,7 +519,10 @@ export interface SchemaConversionRequest {
|
|
|
490
519
|
*/
|
|
491
520
|
export interface CancelMetadataModelConversionResponse {
|
|
492
521
|
/**
|
|
493
|
-
* <p>
|
|
522
|
+
* <p>The metadata model conversion request.</p>
|
|
523
|
+
* <note>
|
|
524
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
525
|
+
* </note>
|
|
494
526
|
* @public
|
|
495
527
|
*/
|
|
496
528
|
Request?: SchemaConversionRequest | undefined;
|
|
@@ -515,7 +547,10 @@ export interface CancelMetadataModelCreationMessage {
|
|
|
515
547
|
*/
|
|
516
548
|
export interface CancelMetadataModelCreationResponse {
|
|
517
549
|
/**
|
|
518
|
-
* <p>
|
|
550
|
+
* <p>The metadata model creation request.</p>
|
|
551
|
+
* <note>
|
|
552
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
553
|
+
* </note>
|
|
519
554
|
* @public
|
|
520
555
|
*/
|
|
521
556
|
Request?: SchemaConversionRequest | undefined;
|
|
@@ -1775,9 +1810,12 @@ export interface CreateDataProviderMessage {
|
|
|
1775
1810
|
*/
|
|
1776
1811
|
Description?: string | undefined;
|
|
1777
1812
|
/**
|
|
1778
|
-
* <p>The type of database engine for the data provider
|
|
1779
|
-
* <
|
|
1780
|
-
* <code>
|
|
1813
|
+
* <p>The type of database engine for the data provider.</p>
|
|
1814
|
+
* <p>Valid values: <code>aurora</code>, <code>aurora-postgresql</code>, <code>db2</code>,
|
|
1815
|
+
* <code>db2-zos</code>, <code>docdb</code>, <code>mariadb</code>, <code>mongodb</code>,
|
|
1816
|
+
* <code>mysql</code>, <code>oracle</code>, <code>postgres</code>, <code>redshift</code>,
|
|
1817
|
+
* <code>sqlserver</code>, and <code>sybase</code>. A value of <code>aurora</code> represents
|
|
1818
|
+
* Amazon Aurora MySQL-Compatible Edition.</p>
|
|
1781
1819
|
* @public
|
|
1782
1820
|
*/
|
|
1783
1821
|
Engine: string | undefined;
|
|
@@ -1825,9 +1863,12 @@ export interface DataProvider {
|
|
|
1825
1863
|
*/
|
|
1826
1864
|
Description?: string | undefined;
|
|
1827
1865
|
/**
|
|
1828
|
-
* <p>The type of database engine for the data provider
|
|
1829
|
-
* <
|
|
1830
|
-
* <code>
|
|
1866
|
+
* <p>The type of database engine for the data provider.</p>
|
|
1867
|
+
* <p>Valid values: <code>aurora</code>, <code>aurora-postgresql</code>, <code>db2</code>,
|
|
1868
|
+
* <code>db2-zos</code>, <code>docdb</code>, <code>mariadb</code>, <code>mongodb</code>,
|
|
1869
|
+
* <code>mysql</code>, <code>oracle</code>, <code>postgres</code>, <code>redshift</code>,
|
|
1870
|
+
* <code>sqlserver</code>, and <code>sybase</code>. A value of <code>aurora</code> represents
|
|
1871
|
+
* Amazon Aurora MySQL-Compatible Edition.</p>
|
|
1831
1872
|
* @public
|
|
1832
1873
|
*/
|
|
1833
1874
|
Engine?: string | undefined;
|
|
@@ -1908,9 +1949,14 @@ export interface DocDbSettings {
|
|
|
1908
1949
|
*/
|
|
1909
1950
|
NestingLevel?: NestingLevelValue | undefined;
|
|
1910
1951
|
/**
|
|
1911
|
-
* <p>
|
|
1912
|
-
*
|
|
1913
|
-
*
|
|
1952
|
+
* <p>Specifies whether the document ID is added to the target table. Use this setting when
|
|
1953
|
+
* <code>NestingLevel</code> is set to <code>"none"</code>.
|
|
1954
|
+
* </p>
|
|
1955
|
+
* <p>Set <code>ExtractDocId</code> to <code>true</code> when using
|
|
1956
|
+
* <a href="https://www.mongodb.com/docs/manual/reference/method/Session.startTransaction/#mongodb-method-Session.startTransaction">multi-document transactions</a>
|
|
1957
|
+
* with CDC.
|
|
1958
|
+
* </p>
|
|
1959
|
+
* <p>Default value is <code>false</code>.</p>
|
|
1914
1960
|
* @public
|
|
1915
1961
|
*/
|
|
1916
1962
|
ExtractDocId?: boolean | undefined;
|
|
@@ -2693,9 +2739,14 @@ export interface MongoDbSettings {
|
|
|
2693
2739
|
*/
|
|
2694
2740
|
NestingLevel?: NestingLevelValue | undefined;
|
|
2695
2741
|
/**
|
|
2696
|
-
* <p>
|
|
2697
|
-
*
|
|
2698
|
-
*
|
|
2742
|
+
* <p>Specifies whether the document ID is added to the target table. Use this setting when
|
|
2743
|
+
* <code>NestingLevel</code> is set to <code>"none"</code>.
|
|
2744
|
+
* </p>
|
|
2745
|
+
* <p>Set <code>ExtractDocId</code> to <code>"true"</code> when using
|
|
2746
|
+
* <a href="https://www.mongodb.com/docs/manual/reference/method/Session.startTransaction/#mongodb-method-Session.startTransaction">multi-document transactions</a>
|
|
2747
|
+
* with CDC.
|
|
2748
|
+
* </p>
|
|
2749
|
+
* <p>Default value is <code>"false"</code>.</p>
|
|
2699
2750
|
* @public
|
|
2700
2751
|
*/
|
|
2701
2752
|
ExtractDocId?: string | undefined;
|
|
@@ -3198,12 +3249,12 @@ export interface OracleSettings {
|
|
|
3198
3249
|
RetryInterval?: number | undefined;
|
|
3199
3250
|
/**
|
|
3200
3251
|
* <p>For an Oracle source endpoint, the transparent data encryption (TDE) password required
|
|
3201
|
-
* by
|
|
3252
|
+
* by DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the
|
|
3202
3253
|
* <code>
|
|
3203
3254
|
* <i>TDE_Password</i>
|
|
3204
3255
|
* </code> part of the comma-separated value you
|
|
3205
3256
|
* set to the <code>Password</code> request parameter when you create the endpoint. The
|
|
3206
|
-
* <code>
|
|
3257
|
+
* <code>SecurityDbEncryption</code> setting is related to this
|
|
3207
3258
|
* <code>SecurityDbEncryptionName</code> setting. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption"> Supported encryption methods for using Oracle as a source for
|
|
3208
3259
|
* DMS </a> in the <i>Database Migration Service User Guide</i>. </p>
|
|
3209
3260
|
* @public
|
|
@@ -5494,9 +5545,14 @@ export interface CreateMigrationProjectMessage {
|
|
|
5494
5545
|
*/
|
|
5495
5546
|
InstanceProfileIdentifier: string | undefined;
|
|
5496
5547
|
/**
|
|
5497
|
-
* <p>
|
|
5498
|
-
*
|
|
5499
|
-
*
|
|
5548
|
+
* <p>A JSON string that specifies the transformation rules for the migration project.
|
|
5549
|
+
* Transformation rules let you customize how DMS Schema Conversion converts your source
|
|
5550
|
+
* database objects, including renaming, adding prefixes or suffixes, and changing data types.
|
|
5551
|
+
* For the transformation rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-transformation-rules.html">Transformation rules in DMS
|
|
5552
|
+
* Schema Conversion</a>.</p>
|
|
5553
|
+
* <note>
|
|
5554
|
+
* <p>Homogeneous data migrations do not support transformation rules.</p>
|
|
5555
|
+
* </note>
|
|
5500
5556
|
* @public
|
|
5501
5557
|
*/
|
|
5502
5558
|
TransformationRules?: string | undefined;
|
|
@@ -5583,9 +5639,14 @@ export interface MigrationProject {
|
|
|
5583
5639
|
*/
|
|
5584
5640
|
InstanceProfileName?: string | undefined;
|
|
5585
5641
|
/**
|
|
5586
|
-
* <p>The
|
|
5587
|
-
*
|
|
5588
|
-
*
|
|
5642
|
+
* <p>The transformation rules for the migration project in JSON format.
|
|
5643
|
+
* Transformation rules let you customize how DMS Schema Conversion converts your source
|
|
5644
|
+
* database objects, including renaming, adding prefixes or suffixes, and changing data types.
|
|
5645
|
+
* For the transformation rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-transformation-rules.html">Transformation rules in DMS
|
|
5646
|
+
* Schema Conversion</a>.</p>
|
|
5647
|
+
* <note>
|
|
5648
|
+
* <p>Homogeneous data migrations do not support transformation rules.</p>
|
|
5649
|
+
* </note>
|
|
5589
5650
|
* @public
|
|
5590
5651
|
*/
|
|
5591
5652
|
TransformationRules?: string | undefined;
|
|
@@ -7700,7 +7761,10 @@ export interface DescribeConversionConfigurationResponse {
|
|
|
7700
7761
|
*/
|
|
7701
7762
|
MigrationProjectIdentifier?: string | undefined;
|
|
7702
7763
|
/**
|
|
7703
|
-
* <p>
|
|
7764
|
+
* <p>A JSON string that contains the schema conversion settings for the migration project.
|
|
7765
|
+
* For the format and available settings, see
|
|
7766
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-settings.html">Specifying schema conversion
|
|
7767
|
+
* settings for migration projects</a>.</p>
|
|
7704
7768
|
* @public
|
|
7705
7769
|
*/
|
|
7706
7770
|
ConversionConfiguration?: string | undefined;
|
|
@@ -7765,8 +7829,14 @@ export interface DescribeDataMigrationsResponse {
|
|
|
7765
7829
|
*/
|
|
7766
7830
|
export interface DescribeDataProvidersMessage {
|
|
7767
7831
|
/**
|
|
7768
|
-
* <p>
|
|
7769
|
-
* <p>
|
|
7832
|
+
* <p>The filters to apply to the data providers.</p>
|
|
7833
|
+
* <p>The following filter names are supported:</p>
|
|
7834
|
+
* <ul>
|
|
7835
|
+
* <li>
|
|
7836
|
+
* <p>
|
|
7837
|
+
* <code>data-provider-identifier</code> – The data provider name or ARN.</p>
|
|
7838
|
+
* </li>
|
|
7839
|
+
* </ul>
|
|
7770
7840
|
* @public
|
|
7771
7841
|
*/
|
|
7772
7842
|
Filters?: Filter[] | undefined;
|
|
@@ -8344,12 +8414,23 @@ export interface DescribeEventSubscriptionsResponse {
|
|
|
8344
8414
|
*/
|
|
8345
8415
|
export interface DescribeExtensionPackAssociationsMessage {
|
|
8346
8416
|
/**
|
|
8347
|
-
* <p>The name or Amazon Resource Name (ARN)
|
|
8417
|
+
* <p>The migration project name or Amazon Resource Name (ARN).</p>
|
|
8348
8418
|
* @public
|
|
8349
8419
|
*/
|
|
8350
8420
|
MigrationProjectIdentifier: string | undefined;
|
|
8351
8421
|
/**
|
|
8352
|
-
* <p>
|
|
8422
|
+
* <p>The filters to apply to the extension pack installation requests.</p>
|
|
8423
|
+
* <p>The following filter names are supported:</p>
|
|
8424
|
+
* <ul>
|
|
8425
|
+
* <li>
|
|
8426
|
+
* <p>
|
|
8427
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
8428
|
+
* </li>
|
|
8429
|
+
* <li>
|
|
8430
|
+
* <p>
|
|
8431
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>.</p>
|
|
8432
|
+
* </li>
|
|
8433
|
+
* </ul>
|
|
8353
8434
|
* @public
|
|
8354
8435
|
*/
|
|
8355
8436
|
Filters?: Filter[] | undefined;
|
|
@@ -8386,7 +8467,10 @@ export interface DescribeExtensionPackAssociationsResponse {
|
|
|
8386
8467
|
*/
|
|
8387
8468
|
Marker?: string | undefined;
|
|
8388
8469
|
/**
|
|
8389
|
-
* <p>A paginated list of extension pack
|
|
8470
|
+
* <p>A paginated list of extension pack installation requests.</p>
|
|
8471
|
+
* <note>
|
|
8472
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
8473
|
+
* </note>
|
|
8390
8474
|
* @public
|
|
8391
8475
|
*/
|
|
8392
8476
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9137,8 +9221,14 @@ export interface DescribeFleetAdvisorSchemasResponse {
|
|
|
9137
9221
|
*/
|
|
9138
9222
|
export interface DescribeInstanceProfilesMessage {
|
|
9139
9223
|
/**
|
|
9140
|
-
* <p>
|
|
9141
|
-
* <p>
|
|
9224
|
+
* <p>The filters to apply to the instance profiles.</p>
|
|
9225
|
+
* <p>The following filter names are supported:</p>
|
|
9226
|
+
* <ul>
|
|
9227
|
+
* <li>
|
|
9228
|
+
* <p>
|
|
9229
|
+
* <code>instance-profile-identifier</code> – The instance profile name or ARN.</p>
|
|
9230
|
+
* </li>
|
|
9231
|
+
* </ul>
|
|
9142
9232
|
* @public
|
|
9143
9233
|
*/
|
|
9144
9234
|
Filters?: Filter[] | undefined;
|
|
@@ -9185,7 +9275,19 @@ export interface DescribeInstanceProfilesResponse {
|
|
|
9185
9275
|
*/
|
|
9186
9276
|
export interface DescribeMetadataModelMessage {
|
|
9187
9277
|
/**
|
|
9188
|
-
* <p>
|
|
9278
|
+
* <p>A JSON string that identifies the metadata model to retrieve. For the selection rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html">Selection rules in DMS Schema Conversion</a>.</p>
|
|
9279
|
+
* <p>Usage:</p>
|
|
9280
|
+
* <ul>
|
|
9281
|
+
* <li>
|
|
9282
|
+
* <p>Accepts source or target selection rules depending on the <code>Origin</code> parameter. The <code>server-name</code> in the object locator must match the corresponding data provider.</p>
|
|
9283
|
+
* </li>
|
|
9284
|
+
* <li>
|
|
9285
|
+
* <p>Supports only <code>explicit</code> rule actions.</p>
|
|
9286
|
+
* </li>
|
|
9287
|
+
* <li>
|
|
9288
|
+
* <p>Exactly one rule is allowed.</p>
|
|
9289
|
+
* </li>
|
|
9290
|
+
* </ul>
|
|
9189
9291
|
* @public
|
|
9190
9292
|
*/
|
|
9191
9293
|
SelectionRules: string | undefined;
|
|
@@ -9211,7 +9313,13 @@ export interface MetadataModelReference {
|
|
|
9211
9313
|
*/
|
|
9212
9314
|
MetadataModelName?: string | undefined;
|
|
9213
9315
|
/**
|
|
9214
|
-
* <p>
|
|
9316
|
+
* <p>A JSON string that identifies this metadata model in the metadata tree. For the selection rule format, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html">Selection rules in DMS Schema Conversion</a>.</p>
|
|
9317
|
+
* <p>Usage:</p>
|
|
9318
|
+
* <ul>
|
|
9319
|
+
* <li>
|
|
9320
|
+
* <p>You can pass this value as the <code>SelectionRules</code> parameter to any operation that accepts selection rules, such as <code>DescribeMetadataModel</code>, <code>StartMetadataModelConversion</code>, and others.</p>
|
|
9321
|
+
* </li>
|
|
9322
|
+
* </ul>
|
|
9215
9323
|
* @public
|
|
9216
9324
|
*/
|
|
9217
9325
|
SelectionRules?: string | undefined;
|
|
@@ -9246,12 +9354,23 @@ export interface DescribeMetadataModelResponse {
|
|
|
9246
9354
|
*/
|
|
9247
9355
|
export interface DescribeMetadataModelAssessmentsMessage {
|
|
9248
9356
|
/**
|
|
9249
|
-
* <p>The name or Amazon Resource Name (ARN)
|
|
9357
|
+
* <p>The migration project name or Amazon Resource Name (ARN).</p>
|
|
9250
9358
|
* @public
|
|
9251
9359
|
*/
|
|
9252
9360
|
MigrationProjectIdentifier: string | undefined;
|
|
9253
9361
|
/**
|
|
9254
|
-
* <p>
|
|
9362
|
+
* <p>The filters to apply to the metadata model assessment requests.</p>
|
|
9363
|
+
* <p>The following filter names are supported:</p>
|
|
9364
|
+
* <ul>
|
|
9365
|
+
* <li>
|
|
9366
|
+
* <p>
|
|
9367
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
9368
|
+
* </li>
|
|
9369
|
+
* <li>
|
|
9370
|
+
* <p>
|
|
9371
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>.</p>
|
|
9372
|
+
* </li>
|
|
9373
|
+
* </ul>
|
|
9255
9374
|
* @public
|
|
9256
9375
|
*/
|
|
9257
9376
|
Filters?: Filter[] | undefined;
|
|
@@ -9260,8 +9379,8 @@ export interface DescribeMetadataModelAssessmentsMessage {
|
|
|
9260
9379
|
* If this parameter is specified, the response includes only records beyond the marker, up to the
|
|
9261
9380
|
* value specified by <code>MaxRecords</code>.</p>
|
|
9262
9381
|
* <p>If <code>Marker</code> is returned by a previous response, there are more results available.
|
|
9263
|
-
*
|
|
9264
|
-
*
|
|
9382
|
+
* The value of <code>Marker</code> is a unique pagination token for each page. To retrieve the next page,
|
|
9383
|
+
* make the call again using the returned token and keeping all other arguments unchanged.</p>
|
|
9265
9384
|
* @public
|
|
9266
9385
|
*/
|
|
9267
9386
|
Marker?: string | undefined;
|
|
@@ -9288,7 +9407,10 @@ export interface DescribeMetadataModelAssessmentsResponse {
|
|
|
9288
9407
|
*/
|
|
9289
9408
|
Marker?: string | undefined;
|
|
9290
9409
|
/**
|
|
9291
|
-
* <p>A paginated list of metadata model
|
|
9410
|
+
* <p>A paginated list of metadata model assessment requests.</p>
|
|
9411
|
+
* <note>
|
|
9412
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
9413
|
+
* </note>
|
|
9292
9414
|
* @public
|
|
9293
9415
|
*/
|
|
9294
9416
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9298,7 +9420,19 @@ export interface DescribeMetadataModelAssessmentsResponse {
|
|
|
9298
9420
|
*/
|
|
9299
9421
|
export interface DescribeMetadataModelChildrenMessage {
|
|
9300
9422
|
/**
|
|
9301
|
-
* <p>
|
|
9423
|
+
* <p>A JSON string that identifies the metadata model whose children to retrieve. For the selection rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html">Selection rules in DMS Schema Conversion</a>.</p>
|
|
9424
|
+
* <p>Usage:</p>
|
|
9425
|
+
* <ul>
|
|
9426
|
+
* <li>
|
|
9427
|
+
* <p>Accepts source or target selection rules depending on the <code>Origin</code> parameter. The <code>server-name</code> in the object locator must match the corresponding data provider.</p>
|
|
9428
|
+
* </li>
|
|
9429
|
+
* <li>
|
|
9430
|
+
* <p>Supports only <code>explicit</code> rule actions.</p>
|
|
9431
|
+
* </li>
|
|
9432
|
+
* <li>
|
|
9433
|
+
* <p>Exactly one rule is allowed.</p>
|
|
9434
|
+
* </li>
|
|
9435
|
+
* </ul>
|
|
9302
9436
|
* @public
|
|
9303
9437
|
*/
|
|
9304
9438
|
SelectionRules: string | undefined;
|
|
@@ -9348,7 +9482,18 @@ export interface DescribeMetadataModelConversionsMessage {
|
|
|
9348
9482
|
*/
|
|
9349
9483
|
MigrationProjectIdentifier: string | undefined;
|
|
9350
9484
|
/**
|
|
9351
|
-
* <p>
|
|
9485
|
+
* <p>The filters to apply to the metadata model conversion requests.</p>
|
|
9486
|
+
* <p>The following filter names are supported:</p>
|
|
9487
|
+
* <ul>
|
|
9488
|
+
* <li>
|
|
9489
|
+
* <p>
|
|
9490
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
9491
|
+
* </li>
|
|
9492
|
+
* <li>
|
|
9493
|
+
* <p>
|
|
9494
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>, <code>CANCELING</code>, <code>CANCELED</code>.</p>
|
|
9495
|
+
* </li>
|
|
9496
|
+
* </ul>
|
|
9352
9497
|
* @public
|
|
9353
9498
|
*/
|
|
9354
9499
|
Filters?: Filter[] | undefined;
|
|
@@ -9385,7 +9530,10 @@ export interface DescribeMetadataModelConversionsResponse {
|
|
|
9385
9530
|
*/
|
|
9386
9531
|
Marker?: string | undefined;
|
|
9387
9532
|
/**
|
|
9388
|
-
* <p>A paginated list of metadata model
|
|
9533
|
+
* <p>A paginated list of metadata model conversion requests.</p>
|
|
9534
|
+
* <note>
|
|
9535
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
9536
|
+
* </note>
|
|
9389
9537
|
* @public
|
|
9390
9538
|
*/
|
|
9391
9539
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9395,17 +9543,35 @@ export interface DescribeMetadataModelConversionsResponse {
|
|
|
9395
9543
|
*/
|
|
9396
9544
|
export interface DescribeMetadataModelCreationsMessage {
|
|
9397
9545
|
/**
|
|
9398
|
-
* <p>
|
|
9546
|
+
* <p>The filters to apply to the metadata model creation requests.</p>
|
|
9547
|
+
* <p>The following filter names are supported:</p>
|
|
9548
|
+
* <ul>
|
|
9549
|
+
* <li>
|
|
9550
|
+
* <p>
|
|
9551
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
9552
|
+
* </li>
|
|
9553
|
+
* <li>
|
|
9554
|
+
* <p>
|
|
9555
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>, <code>CANCELING</code>, <code>CANCELED</code>.</p>
|
|
9556
|
+
* </li>
|
|
9557
|
+
* </ul>
|
|
9399
9558
|
* @public
|
|
9400
9559
|
*/
|
|
9401
9560
|
Filters?: Filter[] | undefined;
|
|
9402
9561
|
/**
|
|
9403
|
-
* <p>Specifies the unique pagination token that makes it possible to display the next page of
|
|
9562
|
+
* <p>Specifies the unique pagination token that makes it possible to display the next page of results.
|
|
9563
|
+
* If this parameter is specified, the response includes only records beyond the marker, up to the
|
|
9564
|
+
* value specified by <code>MaxRecords</code>.</p>
|
|
9565
|
+
* <p>If <code>Marker</code> is returned by a previous response, there are more results available.
|
|
9566
|
+
* The value of <code>Marker</code> is a unique pagination token for each page. To retrieve the next page,
|
|
9567
|
+
* make the call again using the returned token and keeping all other arguments unchanged.</p>
|
|
9404
9568
|
* @public
|
|
9405
9569
|
*/
|
|
9406
9570
|
Marker?: string | undefined;
|
|
9407
9571
|
/**
|
|
9408
|
-
* <p>The maximum number of
|
|
9572
|
+
* <p>The maximum number of records to include in the response. If more records exist than
|
|
9573
|
+
* the specified <code>MaxRecords</code> value, DMS includes a pagination token
|
|
9574
|
+
* in the response so that you can retrieve the remaining results.</p>
|
|
9409
9575
|
* @public
|
|
9410
9576
|
*/
|
|
9411
9577
|
MaxRecords?: number | undefined;
|
|
@@ -9420,12 +9586,20 @@ export interface DescribeMetadataModelCreationsMessage {
|
|
|
9420
9586
|
*/
|
|
9421
9587
|
export interface DescribeMetadataModelCreationsResponse {
|
|
9422
9588
|
/**
|
|
9423
|
-
* <p>Specifies the unique pagination token that makes it possible to display the next page of
|
|
9589
|
+
* <p>Specifies the unique pagination token that makes it possible to display the next page of results.
|
|
9590
|
+
* If this parameter is specified, the response includes only records beyond the marker, up to the
|
|
9591
|
+
* value specified by <code>MaxRecords</code>.</p>
|
|
9592
|
+
* <p>If <code>Marker</code> is returned by a previous response, there are more results available.
|
|
9593
|
+
* The value of <code>Marker</code> is a unique pagination token for each page. To retrieve the next page,
|
|
9594
|
+
* make the call again using the returned token and keeping all other arguments unchanged.</p>
|
|
9424
9595
|
* @public
|
|
9425
9596
|
*/
|
|
9426
9597
|
Marker?: string | undefined;
|
|
9427
9598
|
/**
|
|
9428
|
-
* <p>A list of metadata model creation requests
|
|
9599
|
+
* <p>A paginated list of metadata model creation requests.</p>
|
|
9600
|
+
* <note>
|
|
9601
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
9602
|
+
* </note>
|
|
9429
9603
|
* @public
|
|
9430
9604
|
*/
|
|
9431
9605
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9440,7 +9614,18 @@ export interface DescribeMetadataModelExportsAsScriptMessage {
|
|
|
9440
9614
|
*/
|
|
9441
9615
|
MigrationProjectIdentifier: string | undefined;
|
|
9442
9616
|
/**
|
|
9443
|
-
* <p>
|
|
9617
|
+
* <p>The filters to apply to the metadata model export requests.</p>
|
|
9618
|
+
* <p>The following filter names are supported:</p>
|
|
9619
|
+
* <ul>
|
|
9620
|
+
* <li>
|
|
9621
|
+
* <p>
|
|
9622
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
9623
|
+
* </li>
|
|
9624
|
+
* <li>
|
|
9625
|
+
* <p>
|
|
9626
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>.</p>
|
|
9627
|
+
* </li>
|
|
9628
|
+
* </ul>
|
|
9444
9629
|
* @public
|
|
9445
9630
|
*/
|
|
9446
9631
|
Filters?: Filter[] | undefined;
|
|
@@ -9477,7 +9662,7 @@ export interface DescribeMetadataModelExportsAsScriptResponse {
|
|
|
9477
9662
|
*/
|
|
9478
9663
|
Marker?: string | undefined;
|
|
9479
9664
|
/**
|
|
9480
|
-
* <p>A paginated list of metadata model
|
|
9665
|
+
* <p>A paginated list of metadata model export requests.</p>
|
|
9481
9666
|
* @public
|
|
9482
9667
|
*/
|
|
9483
9668
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9492,7 +9677,18 @@ export interface DescribeMetadataModelExportsToTargetMessage {
|
|
|
9492
9677
|
*/
|
|
9493
9678
|
MigrationProjectIdentifier: string | undefined;
|
|
9494
9679
|
/**
|
|
9495
|
-
* <p>
|
|
9680
|
+
* <p>The filters to apply to the metadata model export requests.</p>
|
|
9681
|
+
* <p>The following filter names are supported:</p>
|
|
9682
|
+
* <ul>
|
|
9683
|
+
* <li>
|
|
9684
|
+
* <p>
|
|
9685
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
9686
|
+
* </li>
|
|
9687
|
+
* <li>
|
|
9688
|
+
* <p>
|
|
9689
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>.</p>
|
|
9690
|
+
* </li>
|
|
9691
|
+
* </ul>
|
|
9496
9692
|
* @public
|
|
9497
9693
|
*/
|
|
9498
9694
|
Filters?: Filter[] | undefined;
|
|
@@ -9529,7 +9725,10 @@ export interface DescribeMetadataModelExportsToTargetResponse {
|
|
|
9529
9725
|
*/
|
|
9530
9726
|
Marker?: string | undefined;
|
|
9531
9727
|
/**
|
|
9532
|
-
* <p>A paginated list of metadata model
|
|
9728
|
+
* <p>A paginated list of metadata model export requests.</p>
|
|
9729
|
+
* <note>
|
|
9730
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
9731
|
+
* </note>
|
|
9533
9732
|
* @public
|
|
9534
9733
|
*/
|
|
9535
9734
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9544,7 +9743,18 @@ export interface DescribeMetadataModelImportsMessage {
|
|
|
9544
9743
|
*/
|
|
9545
9744
|
MigrationProjectIdentifier: string | undefined;
|
|
9546
9745
|
/**
|
|
9547
|
-
* <p>
|
|
9746
|
+
* <p>The filters to apply to the metadata model import requests.</p>
|
|
9747
|
+
* <p>The following filter names are supported:</p>
|
|
9748
|
+
* <ul>
|
|
9749
|
+
* <li>
|
|
9750
|
+
* <p>
|
|
9751
|
+
* <code>request-id</code> – The request identifier.</p>
|
|
9752
|
+
* </li>
|
|
9753
|
+
* <li>
|
|
9754
|
+
* <p>
|
|
9755
|
+
* <code>status</code> – The request status. Valid values: <code>RECEIVED</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>.</p>
|
|
9756
|
+
* </li>
|
|
9757
|
+
* </ul>
|
|
9548
9758
|
* @public
|
|
9549
9759
|
*/
|
|
9550
9760
|
Filters?: Filter[] | undefined;
|
|
@@ -9559,7 +9769,9 @@ export interface DescribeMetadataModelImportsMessage {
|
|
|
9559
9769
|
*/
|
|
9560
9770
|
Marker?: string | undefined;
|
|
9561
9771
|
/**
|
|
9562
|
-
* <p>
|
|
9772
|
+
* <p>The maximum number of records to include in the response. If more records exist than
|
|
9773
|
+
* the specified <code>MaxRecords</code> value, DMS includes a pagination token
|
|
9774
|
+
* in the response so that you can retrieve the remaining results.</p>
|
|
9563
9775
|
* @public
|
|
9564
9776
|
*/
|
|
9565
9777
|
MaxRecords?: number | undefined;
|
|
@@ -9579,7 +9791,10 @@ export interface DescribeMetadataModelImportsResponse {
|
|
|
9579
9791
|
*/
|
|
9580
9792
|
Marker?: string | undefined;
|
|
9581
9793
|
/**
|
|
9582
|
-
* <p>A paginated list of metadata model
|
|
9794
|
+
* <p>A paginated list of metadata model import requests.</p>
|
|
9795
|
+
* <note>
|
|
9796
|
+
* <p>DMS never populates the <code>ExportSqlDetails</code> field for this operation.</p>
|
|
9797
|
+
* </note>
|
|
9583
9798
|
* @public
|
|
9584
9799
|
*/
|
|
9585
9800
|
Requests?: SchemaConversionRequest[] | undefined;
|
|
@@ -9589,17 +9804,28 @@ export interface DescribeMetadataModelImportsResponse {
|
|
|
9589
9804
|
*/
|
|
9590
9805
|
export interface DescribeMigrationProjectsMessage {
|
|
9591
9806
|
/**
|
|
9592
|
-
* <p>
|
|
9593
|
-
* <p>
|
|
9807
|
+
* <p>The filters to apply to the migration projects.</p>
|
|
9808
|
+
* <p>The following filter names are supported:</p>
|
|
9594
9809
|
* <ul>
|
|
9595
9810
|
* <li>
|
|
9596
|
-
* <p>
|
|
9811
|
+
* <p>
|
|
9812
|
+
* <code>migration-project-identifier</code> – The migration project name or ARN.</p>
|
|
9597
9813
|
* </li>
|
|
9598
9814
|
* <li>
|
|
9599
|
-
* <p>
|
|
9815
|
+
* <p>
|
|
9816
|
+
* <code>instance-profile-identifier</code> – The instance profile name or ARN.</p>
|
|
9600
9817
|
* </li>
|
|
9601
9818
|
* <li>
|
|
9602
|
-
* <p>
|
|
9819
|
+
* <p>
|
|
9820
|
+
* <code>data-provider-identifier</code> – The source or target data provider name or ARN.</p>
|
|
9821
|
+
* </li>
|
|
9822
|
+
* <li>
|
|
9823
|
+
* <p>
|
|
9824
|
+
* <code>source-data-provider-identifier</code> – The source data provider name or ARN.</p>
|
|
9825
|
+
* </li>
|
|
9826
|
+
* <li>
|
|
9827
|
+
* <p>
|
|
9828
|
+
* <code>target-data-provider-identifier</code> – The target data provider name or ARN.</p>
|
|
9603
9829
|
* </li>
|
|
9604
9830
|
* </ul>
|
|
9605
9831
|
* @public
|
|
@@ -11580,7 +11806,16 @@ export interface ExportMetadataModelAssessmentMessage {
|
|
|
11580
11806
|
*/
|
|
11581
11807
|
MigrationProjectIdentifier: string | undefined;
|
|
11582
11808
|
/**
|
|
11583
|
-
* <p>A
|
|
11809
|
+
* <p>A JSON string that identifies the metadata models to export a conversion assessment report for. For the selection rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html">Selection rules in DMS Schema Conversion</a>.</p>
|
|
11810
|
+
* <p>Usage:</p>
|
|
11811
|
+
* <ul>
|
|
11812
|
+
* <li>
|
|
11813
|
+
* <p>Accepts only source selection rules, where <code>server-name</code> in the object locator matches the source data provider.</p>
|
|
11814
|
+
* </li>
|
|
11815
|
+
* <li>
|
|
11816
|
+
* <p>Supports only <code>explicit</code> rule actions.</p>
|
|
11817
|
+
* </li>
|
|
11818
|
+
* </ul>
|
|
11584
11819
|
* @public
|
|
11585
11820
|
*/
|
|
11586
11821
|
SelectionRules: string | undefined;
|
|
@@ -11636,7 +11871,22 @@ export interface GetTargetSelectionRulesMessage {
|
|
|
11636
11871
|
*/
|
|
11637
11872
|
MigrationProjectIdentifier: string | undefined;
|
|
11638
11873
|
/**
|
|
11639
|
-
* <p>
|
|
11874
|
+
* <p>A JSON string that contains the source selection rules to convert into their target counterparts. For the selection rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html">Selection rules in DMS Schema Conversion</a>.</p>
|
|
11875
|
+
* <p>Usage:</p>
|
|
11876
|
+
* <ul>
|
|
11877
|
+
* <li>
|
|
11878
|
+
* <p>Accepts only source selection rules, where <code>server-name</code> in the object locator matches the source data provider.</p>
|
|
11879
|
+
* </li>
|
|
11880
|
+
* <li>
|
|
11881
|
+
* <p>Supports only <code>explicit</code> rule actions.</p>
|
|
11882
|
+
* </li>
|
|
11883
|
+
* <li>
|
|
11884
|
+
* <p>Does not support <code>category-name</code> in the object locator.</p>
|
|
11885
|
+
* </li>
|
|
11886
|
+
* <li>
|
|
11887
|
+
* <p>Up to 10 rules are allowed.</p>
|
|
11888
|
+
* </li>
|
|
11889
|
+
* </ul>
|
|
11640
11890
|
* @public
|
|
11641
11891
|
*/
|
|
11642
11892
|
SelectionRules: string | undefined;
|
|
@@ -11743,7 +11993,17 @@ export interface ModifyConversionConfigurationMessage {
|
|
|
11743
11993
|
*/
|
|
11744
11994
|
MigrationProjectIdentifier: string | undefined;
|
|
11745
11995
|
/**
|
|
11746
|
-
* <p>
|
|
11996
|
+
* <p>A JSON string that contains the schema conversion settings to update.
|
|
11997
|
+
* For the format and available settings, see
|
|
11998
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-settings.html">Specifying schema conversion
|
|
11999
|
+
* settings for migration projects</a>.</p>
|
|
12000
|
+
* <p>Usage:</p>
|
|
12001
|
+
* <ul>
|
|
12002
|
+
* <li>
|
|
12003
|
+
* <p>Include only the sections and keys to change. The operation merges supplied
|
|
12004
|
+
* values with the existing configuration.</p>
|
|
12005
|
+
* </li>
|
|
12006
|
+
* </ul>
|
|
11747
12007
|
* @public
|
|
11748
12008
|
*/
|
|
11749
12009
|
ConversionConfiguration: string | undefined;
|
|
@@ -11842,9 +12102,12 @@ export interface ModifyDataProviderMessage {
|
|
|
11842
12102
|
*/
|
|
11843
12103
|
Description?: string | undefined;
|
|
11844
12104
|
/**
|
|
11845
|
-
* <p>The type of database engine for the data provider
|
|
11846
|
-
* <
|
|
11847
|
-
* <code>
|
|
12105
|
+
* <p>The type of database engine for the data provider.</p>
|
|
12106
|
+
* <p>Valid values: <code>aurora</code>, <code>aurora-postgresql</code>, <code>db2</code>,
|
|
12107
|
+
* <code>db2-zos</code>, <code>docdb</code>, <code>mariadb</code>, <code>mongodb</code>,
|
|
12108
|
+
* <code>mysql</code>, <code>oracle</code>, <code>postgres</code>, <code>redshift</code>,
|
|
12109
|
+
* <code>sqlserver</code>, and <code>sybase</code>. A value of <code>aurora</code> represents
|
|
12110
|
+
* Amazon Aurora MySQL-Compatible Edition.</p>
|
|
11848
12111
|
* @public
|
|
11849
12112
|
*/
|
|
11850
12113
|
Engine?: string | undefined;
|
|
@@ -12325,9 +12588,14 @@ export interface ModifyMigrationProjectMessage {
|
|
|
12325
12588
|
*/
|
|
12326
12589
|
InstanceProfileIdentifier?: string | undefined;
|
|
12327
12590
|
/**
|
|
12328
|
-
* <p>
|
|
12329
|
-
*
|
|
12330
|
-
*
|
|
12591
|
+
* <p>A JSON string that specifies the transformation rules for the migration project.
|
|
12592
|
+
* Transformation rules let you customize how DMS Schema Conversion converts your source
|
|
12593
|
+
* database objects, including renaming, adding prefixes or suffixes, and changing data types.
|
|
12594
|
+
* For the transformation rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-transformation-rules.html">Transformation rules in DMS
|
|
12595
|
+
* Schema Conversion</a>.</p>
|
|
12596
|
+
* <note>
|
|
12597
|
+
* <p>Homogeneous data migrations do not support transformation rules.</p>
|
|
12598
|
+
* </note>
|
|
12331
12599
|
* @public
|
|
12332
12600
|
*/
|
|
12333
12601
|
TransformationRules?: string | undefined;
|