@aws-sdk/client-database-migration-service 3.1097.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.
Files changed (38) hide show
  1. package/dist-cjs/index.js +1 -1
  2. package/dist-types/commands/CancelMetadataModelConversionCommand.d.ts +24 -0
  3. package/dist-types/commands/CancelMetadataModelCreationCommand.d.ts +24 -0
  4. package/dist-types/commands/CreateDataProviderCommand.d.ts +25 -24
  5. package/dist-types/commands/CreateInstanceProfileCommand.d.ts +23 -20
  6. package/dist-types/commands/CreateMigrationProjectCommand.d.ts +36 -36
  7. package/dist-types/commands/DeleteDataProviderCommand.d.ts +18 -12
  8. package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +16 -10
  9. package/dist-types/commands/DeleteMigrationProjectCommand.d.ts +25 -19
  10. package/dist-types/commands/DescribeConversionConfigurationCommand.d.ts +9 -5
  11. package/dist-types/commands/DescribeDataProvidersCommand.d.ts +20 -17
  12. package/dist-types/commands/DescribeExtensionPackAssociationsCommand.d.ts +35 -13
  13. package/dist-types/commands/DescribeInstanceProfilesCommand.d.ts +20 -14
  14. package/dist-types/commands/DescribeMetadataModelAssessmentsCommand.d.ts +41 -12
  15. package/dist-types/commands/DescribeMetadataModelChildrenCommand.d.ts +38 -0
  16. package/dist-types/commands/DescribeMetadataModelCommand.d.ts +29 -0
  17. package/dist-types/commands/DescribeMetadataModelConversionsCommand.d.ts +42 -10
  18. package/dist-types/commands/DescribeMetadataModelCreationsCommand.d.ts +55 -1
  19. package/dist-types/commands/DescribeMetadataModelExportsAsScriptCommand.d.ts +42 -10
  20. package/dist-types/commands/DescribeMetadataModelExportsToTargetCommand.d.ts +38 -10
  21. package/dist-types/commands/DescribeMetadataModelImportsCommand.d.ts +38 -10
  22. package/dist-types/commands/DescribeMigrationProjectsCommand.d.ts +26 -23
  23. package/dist-types/commands/ExportMetadataModelAssessmentCommand.d.ts +15 -10
  24. package/dist-types/commands/GetTargetSelectionRulesCommand.d.ts +20 -0
  25. package/dist-types/commands/ModifyConversionConfigurationCommand.d.ts +9 -5
  26. package/dist-types/commands/ModifyDataProviderCommand.d.ts +20 -18
  27. package/dist-types/commands/ModifyInstanceProfileCommand.d.ts +18 -18
  28. package/dist-types/commands/ModifyMigrationProjectCommand.d.ts +27 -36
  29. package/dist-types/commands/StartExtensionPackAssociationCommand.d.ts +18 -7
  30. package/dist-types/commands/StartMetadataModelAssessmentCommand.d.ts +22 -10
  31. package/dist-types/commands/StartMetadataModelConversionCommand.d.ts +56 -6
  32. package/dist-types/commands/StartMetadataModelCreationCommand.d.ts +53 -2
  33. package/dist-types/commands/StartMetadataModelExportAsScriptCommand.d.ts +22 -9
  34. package/dist-types/commands/StartMetadataModelExportToTargetCommand.d.ts +25 -6
  35. package/dist-types/commands/StartMetadataModelImportCommand.d.ts +16 -8
  36. package/dist-types/models/models_0.d.ts +339 -71
  37. package/dist-types/models/models_1.d.ts +93 -25
  38. package/package.json +6 -6
package/dist-cjs/index.js CHANGED
@@ -69,7 +69,7 @@ const commonParams = {
69
69
  UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
70
70
  };
71
71
 
72
- var version = "3.1096.0";
72
+ var version = "3.1097.0";
73
73
  var packageInfo = {
74
74
  version: version};
75
75
 
@@ -25,6 +25,10 @@ declare const CancelMetadataModelConversionCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Cancels a single metadata model conversion operation that was started with <code>StartMetadataModelConversion</code>.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:CancelMetadataModelConversion</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -88,6 +92,26 @@ declare const CancelMetadataModelConversionCommand_base: {
88
92
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
89
93
  *
90
94
  *
95
+ * @example Cancel a metadata model conversion
96
+ * ```javascript
97
+ * // The following example cancels a metadata model conversion operation.
98
+ * const input = {
99
+ * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
100
+ * RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
101
+ * };
102
+ * const command = new CancelMetadataModelConversionCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response is
105
+ * {
106
+ * Request: {
107
+ * MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
108
+ * RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
109
+ * Status: "CANCELING"
110
+ * }
111
+ * }
112
+ * *\/
113
+ * ```
114
+ *
91
115
  * @public
92
116
  */
93
117
  export declare class CancelMetadataModelConversionCommand extends CancelMetadataModelConversionCommand_base {
@@ -25,6 +25,10 @@ declare const CancelMetadataModelCreationCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Cancels a single metadata model creation operation that was started with <code>StartMetadataModelCreation</code>.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:CancelMetadataModelCreation</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -88,6 +92,26 @@ declare const CancelMetadataModelCreationCommand_base: {
88
92
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
89
93
  *
90
94
  *
95
+ * @example Cancel a metadata model creation
96
+ * ```javascript
97
+ * // The following example cancels a metadata model creation operation.
98
+ * const input = {
99
+ * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
100
+ * RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
101
+ * };
102
+ * const command = new CancelMetadataModelCreationCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response is
105
+ * {
106
+ * Request: {
107
+ * MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
108
+ * RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
109
+ * Status: "CANCELING"
110
+ * }
111
+ * }
112
+ * *\/
113
+ * ```
114
+ *
91
115
  * @public
92
116
  */
93
117
  export declare class CancelMetadataModelCreationCommand extends CancelMetadataModelCreationCommand_base {
@@ -26,6 +26,10 @@ declare const CreateDataProviderCommand_base: {
26
26
  /**
27
27
  * <p>Creates a data provider using the provided settings. A data provider stores a data store
28
28
  * type and location information about your database. </p>
29
+ * <p>
30
+ * <b>Required permissions:</b>
31
+ * <code>dms:CreateDataProvider</code>. For more information, see
32
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
29
33
  * @example
30
34
  * Use a bare-bones client and the command you need to make an API call.
31
35
  * ```javascript
@@ -289,43 +293,40 @@ declare const CreateDataProviderCommand_base: {
289
293
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
290
294
  *
291
295
  *
292
- * @example Create Data Provider
296
+ * @example Create a Microsoft SQL Server data provider
293
297
  * ```javascript
294
- * // Creates the data provider with the specified parameters.
298
+ * // The following example creates a Microsoft SQL Server data provider.
295
299
  * const input = {
296
- * DataProviderName: "sqlServer-dev",
297
- * Description: "description",
300
+ * DataProviderName: "example-data-provider",
301
+ * Description: "Example data provider for documentation",
298
302
  * Engine: "sqlserver",
299
303
  * Settings: {
300
304
  * MicrosoftSqlServerSettings: {
301
- * DatabaseName: "DatabaseName",
302
- * Port: 11112,
303
- * ServerName: "ServerName2",
304
- * SslMode: "none"
305
+ * CertificateArn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
306
+ * DatabaseName: "ExampleDatabase",
307
+ * Port: 1433,
308
+ * ServerName: "example-source-server.us-east-1.rds.amazonaws.com",
309
+ * SslMode: "verify-full"
305
310
  * }
306
- * },
307
- * Tags: [
308
- * {
309
- * Key: "access",
310
- * Value: "authorizedusers"
311
- * }
312
- * ]
311
+ * }
313
312
  * };
314
313
  * const command = new CreateDataProviderCommand(input);
315
314
  * const response = await client.send(command);
316
315
  * /* response is
317
316
  * {
318
317
  * DataProvider: {
319
- * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-dataprovider",
320
- * DataProviderCreationTime: "2023-05-12T10:50:41.988561Z",
321
- * DataProviderName: "my-target-dataprovider",
322
- * Engine: "postgres",
318
+ * DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
319
+ * DataProviderCreationTime: "2026-01-09T12:30:00.000000Z",
320
+ * DataProviderName: "example-data-provider",
321
+ * Description: "Example data provider for documentation",
322
+ * Engine: "sqlserver",
323
323
  * Settings: {
324
- * PostgreSqlSettings: {
325
- * DatabaseName: "target",
326
- * Port: 5432,
327
- * ServerName: "postrgesql.a1b2c3d4e5f6.us-east-1.rds.amazonaws.com",
328
- * SslMode: "none"
324
+ * MicrosoftSqlServerSettings: {
325
+ * CertificateArn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
326
+ * DatabaseName: "ExampleDatabase",
327
+ * Port: 1433,
328
+ * ServerName: "example-source-server.us-east-1.rds.amazonaws.com",
329
+ * SslMode: "verify-full"
329
330
  * }
330
331
  * }
331
332
  * }
@@ -25,6 +25,10 @@ declare const CreateInstanceProfileCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Creates the instance profile using the specified parameters.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:CreateInstanceProfile</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -112,21 +116,18 @@ declare const CreateInstanceProfileCommand_base: {
112
116
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
113
117
  *
114
118
  *
115
- * @example Create Instance Profile
119
+ * @example Create an instance profile
116
120
  * ```javascript
117
- * // Creates the instance profile using the specified parameters.
121
+ * // The following example creates an instance profile.
118
122
  * const input = {
119
- * Description: "Description",
120
- * InstanceProfileName: "my-instance-profile",
121
- * KmsKeyArn: "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
122
- * NetworkType: "DUAL",
123
- * PubliclyAccessible: true,
124
- * SubnetGroupIdentifier: "my-subnet-group",
125
- * Tags: [
126
- * {
127
- * Key: "access",
128
- * Value: "authorizedusers"
129
- * }
123
+ * Description: "Example instance profile for documentation",
124
+ * InstanceProfileName: "example-instance-profile",
125
+ * KmsKeyArn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
126
+ * NetworkType: "IPV4",
127
+ * PubliclyAccessible: false,
128
+ * SubnetGroupIdentifier: "example-replication-subnet-group",
129
+ * VpcSecurityGroups: [
130
+ * "sg-0123456789abcdef0"
130
131
  * ]
131
132
  * };
132
133
  * const command = new CreateInstanceProfileCommand(input);
@@ -134,14 +135,16 @@ declare const CreateInstanceProfileCommand_base: {
134
135
  * /* response is
135
136
  * {
136
137
  * InstanceProfile: {
137
- * InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
138
- * InstanceProfileCreationTime: "2022-12-16T09:44:43.543246Z",
139
- * InstanceProfileName: "my-instance-profile",
140
- * KmsKeyArn: "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
141
- * PubliclyAccessible: true,
142
- * SubnetGroupIdentifier: "public-subnets",
138
+ * Description: "Example instance profile for documentation",
139
+ * InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
140
+ * InstanceProfileCreationTime: "2026-01-09T12:30:00.000000Z",
141
+ * InstanceProfileName: "example-instance-profile",
142
+ * KmsKeyArn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
143
+ * NetworkType: "IPV4",
144
+ * PubliclyAccessible: false,
145
+ * SubnetGroupIdentifier: "example-replication-subnet-group",
143
146
  * VpcSecurityGroups: [
144
- * "sg-0123456"
147
+ * "sg-0123456789abcdef0"
145
148
  * ]
146
149
  * }
147
150
  * }
@@ -27,6 +27,10 @@ declare const CreateMigrationProjectCommand_base: {
27
27
  * <p>Creates the migration project using the specified parameters.</p>
28
28
  * <p>You can run this action only after you create an instance profile and data providers
29
29
  * using <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateInstanceProfile.html">CreateInstanceProfile</a> and <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateDataProvider.html">CreateDataProvider</a>.</p>
30
+ * <p>
31
+ * <b>Required permissions:</b>
32
+ * <code>dms:CreateMigrationProject</code>. For more information, see
33
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
30
34
  * @example
31
35
  * Use a bare-bones client and the command you need to make an API call.
32
36
  * ```javascript
@@ -135,69 +139,65 @@ declare const CreateMigrationProjectCommand_base: {
135
139
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
136
140
  *
137
141
  *
138
- * @example Create Migration Project
142
+ * @example Create a migration project
139
143
  * ```javascript
140
- * // Creates the migration project with the specified parameters.
144
+ * // The following example creates a migration project.
141
145
  * const input = {
142
- * Description: "description",
143
- * InstanceProfileIdentifier: "ip-au-17",
144
- * MigrationProjectName: "my-migration-project",
146
+ * Description: "Example migration project for documentation",
147
+ * InstanceProfileIdentifier: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
148
+ * MigrationProjectName: "example-migration-project",
145
149
  * SchemaConversionApplicationAttributes: {
146
- * S3BucketPath: "arn:aws:s3:::mylogin-bucket",
147
- * S3BucketRoleArn: "arn:aws:iam::012345678901:role/Admin"
150
+ * S3BucketPath: "s3://amzn-s3-demo-bucket",
151
+ * S3BucketRoleArn: "arn:aws:iam::111122223333:role/example-s3-access-role"
148
152
  * },
149
153
  * SourceDataProviderDescriptors: [
150
154
  * {
151
- * DataProviderIdentifier: "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
152
- * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/myuser-admin-access",
153
- * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/example1/ALL.SOURCE.ORACLE_12-A1B2C3"
154
- * }
155
- * ],
156
- * Tags: [
157
- * {
158
- * Key: "access",
159
- * Value: "authorizedusers"
155
+ * DataProviderIdentifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
156
+ * SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
157
+ * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3"
160
158
  * }
161
159
  * ],
162
160
  * TargetDataProviderDescriptors: [
163
161
  * {
164
- * DataProviderIdentifier: "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
165
- * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/myuser-admin-access",
166
- * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/example1/TARGET.postgresql-A1B2C3"
162
+ * DataProviderIdentifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
163
+ * SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
164
+ * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3"
167
165
  * }
168
166
  * ],
169
- * TransformationRules: `{"key0":"value0","key1":"value1","key2":"value2"}`
167
+ * TransformationRules: `{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}`
170
168
  * };
171
169
  * const command = new CreateMigrationProjectCommand(input);
172
170
  * const response = await client.send(command);
173
171
  * /* response is
174
172
  * {
175
173
  * MigrationProject: {
176
- * InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
177
- * InstanceProfileName: "my-instance-profile",
178
- * MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
179
- * MigrationProjectCreationTime: "2023-04-19T11:45:15.805253Z",
180
- * MigrationProjectName: "my-migration-project",
174
+ * Description: "Example migration project for documentation",
175
+ * InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
176
+ * InstanceProfileName: "example-instance-profile",
177
+ * MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
178
+ * MigrationProjectCreationTime: "2026-01-09T12:30:00.000000Z",
179
+ * MigrationProjectName: "example-migration-project",
181
180
  * SchemaConversionApplicationAttributes: {
182
- * S3BucketPath: "my-s3-bucket/my_folder",
183
- * S3BucketRoleArn: "arn:aws:iam::012345678901:role/my-s3role"
181
+ * S3BucketPath: "s3://amzn-s3-demo-bucket",
182
+ * S3BucketRoleArn: "arn:aws:iam::111122223333:role/example-s3-access-role"
184
183
  * },
185
184
  * SourceDataProviderDescriptors: [
186
185
  * {
187
- * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
188
- * DataProviderName: "source-oracle-12",
189
- * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/my-access-role",
190
- * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/ALL.SOURCE.ORACLE_12-0123456"
186
+ * DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
187
+ * DataProviderName: "example-data-provider",
188
+ * SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
189
+ * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3"
191
190
  * }
192
191
  * ],
193
192
  * TargetDataProviderDescriptors: [
194
193
  * {
195
- * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
196
- * DataProviderName: "target-dataprovider-3",
197
- * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/dmytbon-admin-access",
198
- * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/TARGET.postgresql-0123456"
194
+ * DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
195
+ * DataProviderName: "example-data-provider",
196
+ * SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
197
+ * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3"
199
198
  * }
200
- * ]
199
+ * ],
200
+ * TransformationRules: `{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}`
201
201
  * }
202
202
  * }
203
203
  * *\/
@@ -25,6 +25,10 @@ declare const DeleteDataProviderCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Deletes the specified data provider.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:DeleteDataProvider</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * <note>
29
33
  * <p>All migration projects associated with the data provider must be deleted or modified
30
34
  * before you can delete the data provider.</p>
@@ -180,27 +184,29 @@ declare const DeleteDataProviderCommand_base: {
180
184
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
181
185
  *
182
186
  *
183
- * @example Delete Data Provider
187
+ * @example Delete a data provider
184
188
  * ```javascript
185
- * // Deletes the specified data provider.
189
+ * // The following example deletes a data provider identified by its ARN.
186
190
  * const input = {
187
- * DataProviderIdentifier: "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
191
+ * DataProviderIdentifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
188
192
  * };
189
193
  * const command = new DeleteDataProviderCommand(input);
190
194
  * const response = await client.send(command);
191
195
  * /* response is
192
196
  * {
193
197
  * DataProvider: {
194
- * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider",
195
- * DataProviderCreationTime: "2023-05-12T10:50:41.988561Z",
196
- * DataProviderName: "my-target-data-provider",
197
- * Engine: "postgres",
198
+ * DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
199
+ * DataProviderCreationTime: "2026-01-09T12:30:00.000000Z",
200
+ * DataProviderName: "example-data-provider",
201
+ * Description: "Example data provider for documentation",
202
+ * Engine: "sqlserver",
198
203
  * Settings: {
199
- * PostgreSqlSettings: {
200
- * DatabaseName: "target",
201
- * Port: 5432,
202
- * ServerName: "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com",
203
- * SslMode: "none"
204
+ * MicrosoftSqlServerSettings: {
205
+ * CertificateArn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
206
+ * DatabaseName: "ExampleDatabase",
207
+ * Port: 1433,
208
+ * ServerName: "example-source-server.us-east-1.rds.amazonaws.com",
209
+ * SslMode: "verify-full"
204
210
  * }
205
211
  * }
206
212
  * }
@@ -25,6 +25,10 @@ declare const DeleteInstanceProfileCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Deletes the specified instance profile.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:DeleteInstanceProfile</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * <note>
29
33
  * <p>All migration projects associated with the instance profile must be deleted or
30
34
  * modified before you can delete the instance profile.</p>
@@ -84,25 +88,27 @@ declare const DeleteInstanceProfileCommand_base: {
84
88
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
85
89
  *
86
90
  *
87
- * @example Delete Instance Profile
91
+ * @example Delete an instance profile
88
92
  * ```javascript
89
- * // Deletes the specified instance profile.
93
+ * // The following example deletes an instance profile identified by its ARN.
90
94
  * const input = {
91
- * InstanceProfileIdentifier: "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
95
+ * InstanceProfileIdentifier: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS"
92
96
  * };
93
97
  * const command = new DeleteInstanceProfileCommand(input);
94
98
  * const response = await client.send(command);
95
99
  * /* response is
96
100
  * {
97
101
  * InstanceProfile: {
98
- * InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
99
- * InstanceProfileCreationTime: "2022-12-16T09:44:43.543246Z",
100
- * InstanceProfileName: "my-instance-profile",
101
- * KmsKeyArn: "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
102
- * PubliclyAccessible: true,
103
- * SubnetGroupIdentifier: "public-subnets",
102
+ * Description: "Example instance profile for documentation",
103
+ * InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
104
+ * InstanceProfileCreationTime: "2026-01-09T12:30:00.000000Z",
105
+ * InstanceProfileName: "example-instance-profile",
106
+ * KmsKeyArn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
107
+ * NetworkType: "IPV4",
108
+ * PubliclyAccessible: false,
109
+ * SubnetGroupIdentifier: "example-replication-subnet-group",
104
110
  * VpcSecurityGroups: [
105
- * "sg-0123456"
111
+ * "sg-0123456789abcdef0"
106
112
  * ]
107
113
  * }
108
114
  * }
@@ -25,6 +25,10 @@ declare const DeleteMigrationProjectCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Deletes the specified migration project.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:DeleteMigrationProject</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * <note>
29
33
  * <p>The migration project must be closed before you can delete it.</p>
30
34
  * </note>
@@ -98,42 +102,44 @@ declare const DeleteMigrationProjectCommand_base: {
98
102
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
99
103
  *
100
104
  *
101
- * @example Delete Migration Project
105
+ * @example Delete a migration project
102
106
  * ```javascript
103
- * // Deletes the specified migration project.
107
+ * // The following example deletes a migration project identified by its ARN.
104
108
  * const input = {
105
- * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
109
+ * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
106
110
  * };
107
111
  * const command = new DeleteMigrationProjectCommand(input);
108
112
  * const response = await client.send(command);
109
113
  * /* response is
110
114
  * {
111
115
  * MigrationProject: {
112
- * InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
113
- * InstanceProfileName: "my-instance-profile",
114
- * MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
115
- * MigrationProjectCreationTime: "2023-04-19T11:45:15.805253Z",
116
- * MigrationProjectName: "my-migration-project",
116
+ * Description: "Example migration project for documentation",
117
+ * InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
118
+ * InstanceProfileName: "example-instance-profile",
119
+ * MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
120
+ * MigrationProjectCreationTime: "2026-01-09T12:30:00.000000Z",
121
+ * MigrationProjectName: "example-migration-project",
117
122
  * SchemaConversionApplicationAttributes: {
118
- * S3BucketPath: "my-s3-bucket/my_folder",
119
- * S3BucketRoleArn: "arn:aws:iam::012345678901:role/my-s3role"
123
+ * S3BucketPath: "s3://amzn-s3-demo-bucket",
124
+ * S3BucketRoleArn: "arn:aws:iam::111122223333:role/example-s3-access-role"
120
125
  * },
121
126
  * SourceDataProviderDescriptors: [
122
127
  * {
123
- * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
124
- * DataProviderName: "all-source-oracle-12",
125
- * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/my-access-role",
126
- * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/ALL.SOURCE.ORACLE_12-0123456"
128
+ * DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
129
+ * DataProviderName: "example-data-provider",
130
+ * SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
131
+ * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3"
127
132
  * }
128
133
  * ],
129
134
  * TargetDataProviderDescriptors: [
130
135
  * {
131
- * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
132
- * DataProviderName: "sde-obilyns-dataprovider-3",
133
- * SecretsManagerAccessRoleArn: "arn:aws:iam::437223687239:role/dmytbon-admin-access",
134
- * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/TARGET.postgresql-0123456"
136
+ * DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
137
+ * DataProviderName: "example-data-provider",
138
+ * SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
139
+ * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3"
135
140
  * }
136
- * ]
141
+ * ],
142
+ * TransformationRules: `{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}`
137
143
  * }
138
144
  * }
139
145
  * *\/
@@ -25,6 +25,10 @@ declare const DescribeConversionConfigurationCommand_base: {
25
25
  };
26
26
  /**
27
27
  * <p>Returns configuration parameters for a schema conversion project.</p>
28
+ * <p>
29
+ * <b>Required permissions:</b>
30
+ * <code>dms:DescribeConversionConfiguration</code>. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -58,18 +62,18 @@ declare const DescribeConversionConfigurationCommand_base: {
58
62
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
59
63
  *
60
64
  *
61
- * @example Describe Conversion Configuration
65
+ * @example Retrieving conversion configuration for a migration project
62
66
  * ```javascript
63
- * // Returns configuration parameters for a schema conversion project.
67
+ * // The following example retrieves the conversion configuration for a migration project.
64
68
  * const input = {
65
- * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
69
+ * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
66
70
  * };
67
71
  * const command = new DescribeConversionConfigurationCommand(input);
68
72
  * const response = await client.send(command);
69
73
  * /* response is
70
74
  * {
71
- * ConversionConfiguration: `{"Common project settings":{"ShowSeverityLevelInSql":"CRITICAL"},"ORACLE_TO_POSTGRESQL" : {"ToTimeZone":false,"LastDayBuiltinFunctionOracle":false, "NextDayBuiltinFunctionOracle":false,"ConvertProceduresToFunction":false,"NvlBuiltinFunctionOracle":false,"DbmsAssertBuiltinFunctionOracle":false}}`,
72
- * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
75
+ * ConversionConfiguration: `{"Common project settings":{"ShowSeverityLevelInSql":"CRITICAL","EnableGenAiConversion":false},"MSSQL_TO_AURORA_POSTGRESQL":{"ConvertProceduresToFunction":true,"UniqueIndexGeneration":true,"CaseSensitivityNames":false},"Conversion version":{"MSSQL_TO_AURORA_POSTGRESQL_target_engine_version":"15"}}`,
76
+ * MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
73
77
  * }
74
78
  * *\/
75
79
  * ```