@aws-sdk/client-database-migration-service 3.418.0 → 3.421.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 (29) hide show
  1. package/README.md +7 -7
  2. package/dist-types/commands/CreateDataProviderCommand.d.ts +45 -0
  3. package/dist-types/commands/CreateInstanceProfileCommand.d.ts +38 -0
  4. package/dist-types/commands/CreateMigrationProjectCommand.d.ts +69 -0
  5. package/dist-types/commands/DeleteDataProviderCommand.d.ts +29 -0
  6. package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +27 -0
  7. package/dist-types/commands/DeleteMigrationProjectCommand.d.ts +42 -0
  8. package/dist-types/commands/DescribeConversionConfigurationCommand.d.ts +17 -0
  9. package/dist-types/commands/DescribeDataProvidersCommand.d.ts +41 -0
  10. package/dist-types/commands/DescribeExtensionPackAssociationsCommand.d.ts +33 -0
  11. package/dist-types/commands/DescribeInstanceProfilesCommand.d.ts +36 -0
  12. package/dist-types/commands/DescribeMetadataModelAssessmentsCommand.d.ts +33 -0
  13. package/dist-types/commands/DescribeMetadataModelConversionsCommand.d.ts +33 -0
  14. package/dist-types/commands/DescribeMetadataModelExportsAsScriptCommand.d.ts +33 -0
  15. package/dist-types/commands/DescribeMetadataModelExportsToTargetCommand.d.ts +33 -0
  16. package/dist-types/commands/DescribeMetadataModelImportsCommand.d.ts +33 -0
  17. package/dist-types/commands/DescribeMigrationProjectsCommand.d.ts +54 -0
  18. package/dist-types/commands/ExportMetadataModelAssessmentCommand.d.ts +28 -0
  19. package/dist-types/commands/ModifyConversionConfigurationCommand.d.ts +17 -0
  20. package/dist-types/commands/ModifyDataProviderCommand.d.ts +40 -0
  21. package/dist-types/commands/ModifyInstanceProfileCommand.d.ts +35 -0
  22. package/dist-types/commands/ModifyMigrationProjectCommand.d.ts +63 -0
  23. package/dist-types/commands/StartExtensionPackAssociationCommand.d.ts +16 -0
  24. package/dist-types/commands/StartMetadataModelAssessmentCommand.d.ts +18 -0
  25. package/dist-types/commands/StartMetadataModelConversionCommand.d.ts +17 -0
  26. package/dist-types/commands/StartMetadataModelExportAsScriptCommand.d.ts +19 -0
  27. package/dist-types/commands/StartMetadataModelExportToTargetCommand.d.ts +18 -0
  28. package/dist-types/commands/StartMetadataModelImportCommand.d.ts +19 -0
  29. package/package.json +3 -3
package/README.md CHANGED
@@ -33,19 +33,19 @@ using your favorite package manager:
33
33
 
34
34
  The AWS SDK is modulized by clients and commands.
35
35
  To send a request, you only need to import the `DatabaseMigrationServiceClient` and
36
- the commands you need, for example `AddTagsToResourceCommand`:
36
+ the commands you need, for example `ListTagsForResourceCommand`:
37
37
 
38
38
  ```js
39
39
  // ES5 example
40
40
  const {
41
41
  DatabaseMigrationServiceClient,
42
- AddTagsToResourceCommand,
42
+ ListTagsForResourceCommand,
43
43
  } = require("@aws-sdk/client-database-migration-service");
44
44
  ```
45
45
 
46
46
  ```ts
47
47
  // ES6+ example
48
- import { DatabaseMigrationServiceClient, AddTagsToResourceCommand } from "@aws-sdk/client-database-migration-service";
48
+ import { DatabaseMigrationServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-database-migration-service";
49
49
  ```
50
50
 
51
51
  ### Usage
@@ -64,7 +64,7 @@ const client = new DatabaseMigrationServiceClient({ region: "REGION" });
64
64
  const params = {
65
65
  /** input parameters */
66
66
  };
67
- const command = new AddTagsToResourceCommand(params);
67
+ const command = new ListTagsForResourceCommand(params);
68
68
  ```
69
69
 
70
70
  #### Async/await
@@ -143,7 +143,7 @@ const client = new AWS.DatabaseMigrationService({ region: "REGION" });
143
143
 
144
144
  // async/await.
145
145
  try {
146
- const data = await client.addTagsToResource(params);
146
+ const data = await client.listTagsForResource(params);
147
147
  // process data.
148
148
  } catch (error) {
149
149
  // error handling.
@@ -151,7 +151,7 @@ try {
151
151
 
152
152
  // Promises.
153
153
  client
154
- .addTagsToResource(params)
154
+ .listTagsForResource(params)
155
155
  .then((data) => {
156
156
  // process data.
157
157
  })
@@ -160,7 +160,7 @@ client
160
160
  });
161
161
 
162
162
  // callbacks.
163
- client.addTagsToResource(params, (err, data) => {
163
+ client.listTagsForResource(params, (err, data) => {
164
164
  // process err and data.
165
165
  });
166
166
  ```
@@ -200,6 +200,51 @@ export interface CreateDataProviderCommandOutput extends CreateDataProviderRespo
200
200
  * @throws {@link DatabaseMigrationServiceServiceException}
201
201
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
202
202
  *
203
+ * @example Create Data Provider
204
+ * ```javascript
205
+ * // Creates the data provider with the specified parameters.
206
+ * const input = {
207
+ * "DataProviderName": "sqlServer-dev",
208
+ * "Description": "description",
209
+ * "Engine": "sqlserver",
210
+ * "Settings": {
211
+ * "MicrosoftSqlServerSettings": {
212
+ * "DatabaseName": "DatabaseName",
213
+ * "Port": 11112,
214
+ * "ServerName": "ServerName2",
215
+ * "SslMode": "none"
216
+ * }
217
+ * },
218
+ * "Tags": [
219
+ * {
220
+ * "Key": "access",
221
+ * "Value": "authorizedusers"
222
+ * }
223
+ * ]
224
+ * };
225
+ * const command = new CreateDataProviderCommand(input);
226
+ * const response = await client.send(command);
227
+ * /* response ==
228
+ * {
229
+ * "DataProvider": {
230
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-dataprovider",
231
+ * "DataProviderCreationTime": "2023-05-12T10:50:41.988561Z",
232
+ * "DataProviderName": "my-target-dataprovider",
233
+ * "Engine": "postgres",
234
+ * "Settings": {
235
+ * "PostgreSqlSettings": {
236
+ * "DatabaseName": "target",
237
+ * "Port": 5432,
238
+ * "ServerName": "postrgesql.a1b2c3d4e5f6.us-east-1.rds.amazonaws.com",
239
+ * "SslMode": "none"
240
+ * }
241
+ * }
242
+ * }
243
+ * }
244
+ * *\/
245
+ * // example id: create-data-provider-1689726511871
246
+ * ```
247
+ *
203
248
  */
204
249
  export declare class CreateDataProviderCommand extends $Command<CreateDataProviderCommandInput, CreateDataProviderCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
205
250
  readonly input: CreateDataProviderCommandInput;
@@ -105,6 +105,44 @@ export interface CreateInstanceProfileCommandOutput extends CreateInstanceProfil
105
105
  * @throws {@link DatabaseMigrationServiceServiceException}
106
106
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
107
107
  *
108
+ * @example Create Instance Profile
109
+ * ```javascript
110
+ * // Creates the instance profile using the specified parameters.
111
+ * const input = {
112
+ * "Description": "Description",
113
+ * "InstanceProfileName": "my-instance-profile",
114
+ * "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
115
+ * "NetworkType": "DUAL",
116
+ * "PubliclyAccessible": true,
117
+ * "SubnetGroupIdentifier": "my-subnet-group",
118
+ * "Tags": [
119
+ * {
120
+ * "Key": "access",
121
+ * "Value": "authorizedusers"
122
+ * }
123
+ * ]
124
+ * };
125
+ * const command = new CreateInstanceProfileCommand(input);
126
+ * const response = await client.send(command);
127
+ * /* response ==
128
+ * {
129
+ * "InstanceProfile": {
130
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
131
+ * "InstanceProfileCreationTime": "2022-12-16T09:44:43.543246Z",
132
+ * "InstanceProfileName": "my-instance-profile",
133
+ * "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
134
+ * "PubliclyAccessible": true,
135
+ * "SubnetGroupIdentifier": "public-subnets",
136
+ * "VpcIdentifier": "vpc-0a1b2c3d4e5f6g7h8",
137
+ * "VpcSecurityGroups": [
138
+ * "sg-0123456"
139
+ * ]
140
+ * }
141
+ * }
142
+ * *\/
143
+ * // example id: create-instance-profile-1689716070633
144
+ * ```
145
+ *
108
146
  */
109
147
  export declare class CreateInstanceProfileCommand extends $Command<CreateInstanceProfileCommandInput, CreateInstanceProfileCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
110
148
  readonly input: CreateInstanceProfileCommandInput;
@@ -128,6 +128,75 @@ export interface CreateMigrationProjectCommandOutput extends CreateMigrationProj
128
128
  * @throws {@link DatabaseMigrationServiceServiceException}
129
129
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
130
130
  *
131
+ * @example Create Migration Project
132
+ * ```javascript
133
+ * // Creates the migration project with the specified parameters.
134
+ * const input = {
135
+ * "Description": "description",
136
+ * "InstanceProfileIdentifier": "ip-au-17",
137
+ * "MigrationProjectName": "my-migration-project",
138
+ * "SchemaConversionApplicationAttributes": {
139
+ * "S3BucketPath": "arn:aws:s3:::mylogin-bucket",
140
+ * "S3BucketRoleArn": "arn:aws:iam::012345678901:role/Admin"
141
+ * },
142
+ * "SourceDataProviderDescriptors": [
143
+ * {
144
+ * "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
145
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access",
146
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/example1/ALL.SOURCE.ORACLE_12-A1B2C3"
147
+ * }
148
+ * ],
149
+ * "Tags": [
150
+ * {
151
+ * "Key": "access",
152
+ * "Value": "authorizedusers"
153
+ * }
154
+ * ],
155
+ * "TargetDataProviderDescriptors": [
156
+ * {
157
+ * "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
158
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access",
159
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/example1/TARGET.postgresql-A1B2C3"
160
+ * }
161
+ * ],
162
+ * "TransformationRules": "{\"key0\":\"value0\",\"key1\":\"value1\",\"key2\":\"value2\"}"
163
+ * };
164
+ * const command = new CreateMigrationProjectCommand(input);
165
+ * const response = await client.send(command);
166
+ * /* response ==
167
+ * {
168
+ * "MigrationProject": {
169
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
170
+ * "InstanceProfileName": "my-instance-profile",
171
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
172
+ * "MigrationProjectCreationTime": "2023-04-19T11:45:15.805253Z",
173
+ * "MigrationProjectName": "my-migration-project",
174
+ * "SchemaConversionApplicationAttributes": {
175
+ * "S3BucketPath": "my-s3-bucket/my_folder",
176
+ * "S3BucketRoleArn": "arn:aws:iam::012345678901:role/my-s3role"
177
+ * },
178
+ * "SourceDataProviderDescriptors": [
179
+ * {
180
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
181
+ * "DataProviderName": "source-oracle-12",
182
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role",
183
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/ALL.SOURCE.ORACLE_12-0123456"
184
+ * }
185
+ * ],
186
+ * "TargetDataProviderDescriptors": [
187
+ * {
188
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
189
+ * "DataProviderName": "target-dataprovider-3",
190
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/dmytbon-admin-access",
191
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/TARGET.postgresql-0123456"
192
+ * }
193
+ * ]
194
+ * }
195
+ * }
196
+ * *\/
197
+ * // example id: create-migration-project-1689716672685
198
+ * ```
199
+ *
131
200
  */
132
201
  export declare class CreateMigrationProjectCommand extends $Command<CreateMigrationProjectCommandInput, CreateMigrationProjectCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
133
202
  readonly input: CreateMigrationProjectCommandInput;
@@ -132,6 +132,35 @@ export interface DeleteDataProviderCommandOutput extends DeleteDataProviderRespo
132
132
  * @throws {@link DatabaseMigrationServiceServiceException}
133
133
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
134
134
  *
135
+ * @example Delete Data Provider
136
+ * ```javascript
137
+ * // Deletes the specified data provider.
138
+ * const input = {
139
+ * "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
140
+ * };
141
+ * const command = new DeleteDataProviderCommand(input);
142
+ * const response = await client.send(command);
143
+ * /* response ==
144
+ * {
145
+ * "DataProvider": {
146
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider",
147
+ * "DataProviderCreationTime": "2023-05-12T10:50:41.988561Z",
148
+ * "DataProviderName": "my-target-data-provider",
149
+ * "Engine": "postgres",
150
+ * "Settings": {
151
+ * "PostgreSqlSettings": {
152
+ * "DatabaseName": "target",
153
+ * "Port": 5432,
154
+ * "ServerName": "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com",
155
+ * "SslMode": "none"
156
+ * }
157
+ * }
158
+ * }
159
+ * }
160
+ * *\/
161
+ * // example id: delete-data-provider-1689724476356
162
+ * ```
163
+ *
135
164
  */
136
165
  export declare class DeleteDataProviderCommand extends $Command<DeleteDataProviderCommandInput, DeleteDataProviderCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
137
166
  readonly input: DeleteDataProviderCommandInput;
@@ -77,6 +77,33 @@ export interface DeleteInstanceProfileCommandOutput extends DeleteInstanceProfil
77
77
  * @throws {@link DatabaseMigrationServiceServiceException}
78
78
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
79
79
  *
80
+ * @example Delete Instance Profile
81
+ * ```javascript
82
+ * // Deletes the specified instance profile.
83
+ * const input = {
84
+ * "InstanceProfileIdentifier": "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
85
+ * };
86
+ * const command = new DeleteInstanceProfileCommand(input);
87
+ * const response = await client.send(command);
88
+ * /* response ==
89
+ * {
90
+ * "InstanceProfile": {
91
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
92
+ * "InstanceProfileCreationTime": "2022-12-16T09:44:43.543246Z",
93
+ * "InstanceProfileName": "my-instance-profile",
94
+ * "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
95
+ * "PubliclyAccessible": true,
96
+ * "SubnetGroupIdentifier": "public-subnets",
97
+ * "VpcIdentifier": "vpc-0a1b2c3d4e5f6g7h8",
98
+ * "VpcSecurityGroups": [
99
+ * "sg-0123456"
100
+ * ]
101
+ * }
102
+ * }
103
+ * *\/
104
+ * // example id: delete-instance-profile-1689716924105
105
+ * ```
106
+ *
80
107
  */
81
108
  export declare class DeleteInstanceProfileCommand extends $Command<DeleteInstanceProfileCommandInput, DeleteInstanceProfileCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
82
109
  readonly input: DeleteInstanceProfileCommandInput;
@@ -91,6 +91,48 @@ export interface DeleteMigrationProjectCommandOutput extends DeleteMigrationProj
91
91
  * @throws {@link DatabaseMigrationServiceServiceException}
92
92
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
93
93
  *
94
+ * @example Delete Migration Project
95
+ * ```javascript
96
+ * // Deletes the specified migration project.
97
+ * const input = {
98
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
99
+ * };
100
+ * const command = new DeleteMigrationProjectCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response ==
103
+ * {
104
+ * "MigrationProject": {
105
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "InstanceProfileName": "my-instance-profile",
107
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
108
+ * "MigrationProjectCreationTime": "2023-04-19T11:45:15.805253Z",
109
+ * "MigrationProjectName": "my-migration-project",
110
+ * "SchemaConversionApplicationAttributes": {
111
+ * "S3BucketPath": "my-s3-bucket/my_folder",
112
+ * "S3BucketRoleArn": "arn:aws:iam::012345678901:role/my-s3role"
113
+ * },
114
+ * "SourceDataProviderDescriptors": [
115
+ * {
116
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
117
+ * "DataProviderName": "all-source-oracle-12",
118
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role",
119
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/ALL.SOURCE.ORACLE_12-0123456"
120
+ * }
121
+ * ],
122
+ * "TargetDataProviderDescriptors": [
123
+ * {
124
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
125
+ * "DataProviderName": "sde-obilyns-dataprovider-3",
126
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::437223687239:role/dmytbon-admin-access",
127
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/TARGET.postgresql-0123456"
128
+ * }
129
+ * ]
130
+ * }
131
+ * }
132
+ * *\/
133
+ * // example id: delete-migration-project-1689717217454
134
+ * ```
135
+ *
94
136
  */
95
137
  export declare class DeleteMigrationProjectCommand extends $Command<DeleteMigrationProjectCommandInput, DeleteMigrationProjectCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
96
138
  readonly input: DeleteMigrationProjectCommandInput;
@@ -54,6 +54,23 @@ export interface DescribeConversionConfigurationCommandOutput extends DescribeCo
54
54
  * @throws {@link DatabaseMigrationServiceServiceException}
55
55
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
56
56
  *
57
+ * @example Describe Conversion Configuration
58
+ * ```javascript
59
+ * // Returns configuration parameters for a schema conversion project.
60
+ * const input = {
61
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
62
+ * };
63
+ * const command = new DescribeConversionConfigurationCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"ORACLE_TO_POSTGRESQL\" : {\"ToTimeZone\":false,\"LastDayBuiltinFunctionOracle\":false, \"NextDayBuiltinFunctionOracle\":false,\"ConvertProceduresToFunction\":false,\"NvlBuiltinFunctionOracle\":false,\"DbmsAssertBuiltinFunctionOracle\":false}}",
68
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
69
+ * }
70
+ * *\/
71
+ * // example id: describe-conversion-configuration-1689717690907
72
+ * ```
73
+ *
57
74
  */
58
75
  export declare class DescribeConversionConfigurationCommand extends $Command<DescribeConversionConfigurationCommandInput, DescribeConversionConfigurationCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
59
76
  readonly input: DescribeConversionConfigurationCommandInput;
@@ -137,6 +137,47 @@ export interface DescribeDataProvidersCommandOutput extends DescribeDataProvider
137
137
  * @throws {@link DatabaseMigrationServiceServiceException}
138
138
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
139
139
  *
140
+ * @example Describe Data Providers
141
+ * ```javascript
142
+ * //
143
+ * const input = {
144
+ * "Filters": [
145
+ * {
146
+ * "Name": "data-provider-identifier",
147
+ * "Values": [
148
+ * "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
149
+ * ]
150
+ * }
151
+ * ],
152
+ * "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
153
+ * "MaxRecords": 20
154
+ * };
155
+ * const command = new DescribeDataProvidersCommand(input);
156
+ * const response = await client.send(command);
157
+ * /* response ==
158
+ * {
159
+ * "DataProviders": [
160
+ * {
161
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider",
162
+ * "DataProviderCreationTime": "2023-05-12T10:50:41.988561Z",
163
+ * "DataProviderName": "my-target-data-provider",
164
+ * "Engine": "postgres",
165
+ * "Settings": {
166
+ * "PostgreSqlSettings": {
167
+ * "DatabaseName": "target",
168
+ * "Port": 5432,
169
+ * "ServerName": "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com",
170
+ * "SslMode": "none"
171
+ * }
172
+ * }
173
+ * }
174
+ * ],
175
+ * "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
176
+ * }
177
+ * *\/
178
+ * // example id: describe-data-providers-1689725897156
179
+ * ```
180
+ *
140
181
  */
141
182
  export declare class DescribeDataProvidersCommand extends $Command<DescribeDataProvidersCommandInput, DescribeDataProvidersCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
142
183
  readonly input: DescribeDataProvidersCommandInput;
@@ -79,6 +79,39 @@ export interface DescribeExtensionPackAssociationsCommandOutput extends Describe
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Describe Extension Pack Associations
83
+ * ```javascript
84
+ * // Returns a paginated list of extension pack associations for the specified migration project.
85
+ * const input = {
86
+ * "Filters": [
87
+ * {
88
+ * "Name": "instance-profile-identifier",
89
+ * "Values": [
90
+ * "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
91
+ * ]
92
+ * }
93
+ * ],
94
+ * "Marker": "0123456789abcdefghijklmnopqrs",
95
+ * "MaxRecords": 20,
96
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
97
+ * };
98
+ * const command = new DescribeExtensionPackAssociationsCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "Marker": "0123456789abcdefghijklmnopqrs",
103
+ * "Requests": [
104
+ * {
105
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef",
107
+ * "Status": "SUCCESS"
108
+ * }
109
+ * ]
110
+ * }
111
+ * *\/
112
+ * // example id: describe-extension-pack-associations-1689718322580
113
+ * ```
114
+ *
82
115
  */
83
116
  export declare class DescribeExtensionPackAssociationsCommand extends $Command<DescribeExtensionPackAssociationsCommandInput, DescribeExtensionPackAssociationsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
117
  readonly input: DescribeExtensionPackAssociationsCommandInput;
@@ -82,6 +82,42 @@ export interface DescribeInstanceProfilesCommandOutput extends DescribeInstanceP
82
82
  * @throws {@link DatabaseMigrationServiceServiceException}
83
83
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
84
84
  *
85
+ * @example Describe Instance Profiles
86
+ * ```javascript
87
+ * // Returns a paginated list of instance profiles for your account in the current region.
88
+ * const input = {
89
+ * "Filters": [
90
+ * {
91
+ * "Name": "instance-profile-identifier",
92
+ * "Values": [
93
+ * "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
94
+ * ]
95
+ * }
96
+ * ],
97
+ * "Marker": "0123456789abcdefghijklmnopqrs",
98
+ * "MaxRecords": 20
99
+ * };
100
+ * const command = new DescribeInstanceProfilesCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response ==
103
+ * {
104
+ * "InstanceProfiles": [
105
+ * {
106
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
107
+ * "InstanceProfileCreationTime": "2022-12-16T09:44:43.543246Z",
108
+ * "InstanceProfileName": "my-instance-profile",
109
+ * "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
110
+ * "PubliclyAccessible": true,
111
+ * "SubnetGroupIdentifier": "public-subnets",
112
+ * "VpcIdentifier": "vpc-0a1b2c3d4e5f6g7h8"
113
+ * }
114
+ * ],
115
+ * "Marker": "0123456789abcdefghijklmnopqrs"
116
+ * }
117
+ * *\/
118
+ * // example id: describe-instance-profiles-1689718406840
119
+ * ```
120
+ *
85
121
  */
86
122
  export declare class DescribeInstanceProfilesCommand extends $Command<DescribeInstanceProfilesCommandInput, DescribeInstanceProfilesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
87
123
  readonly input: DescribeInstanceProfilesCommandInput;
@@ -79,6 +79,39 @@ export interface DescribeMetadataModelAssessmentsCommandOutput extends DescribeM
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Describe Metadata Model Assessments
83
+ * ```javascript
84
+ * // Returns a paginated list of metadata model assessments for your account in the current region.
85
+ * const input = {
86
+ * "Filters": [
87
+ * {
88
+ * "Name": "my-migration-project",
89
+ * "Values": [
90
+ * "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
91
+ * ]
92
+ * }
93
+ * ],
94
+ * "Marker": "0123456789abcdefghijklmnopqrs",
95
+ * "MaxRecords": 20,
96
+ * "MigrationProjectIdentifier": ""
97
+ * };
98
+ * const command = new DescribeMetadataModelAssessmentsCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "Marker": "ASDLKJASDJKHDFHGDNBGDASKJHGFK",
103
+ * "Requests": [
104
+ * {
105
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef",
107
+ * "Status": "SUCCESS"
108
+ * }
109
+ * ]
110
+ * }
111
+ * *\/
112
+ * // example id: describe-metadata-model-assessments-1689718702303
113
+ * ```
114
+ *
82
115
  */
83
116
  export declare class DescribeMetadataModelAssessmentsCommand extends $Command<DescribeMetadataModelAssessmentsCommandInput, DescribeMetadataModelAssessmentsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
117
  readonly input: DescribeMetadataModelAssessmentsCommandInput;
@@ -79,6 +79,39 @@ export interface DescribeMetadataModelConversionsCommandOutput extends DescribeM
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Describe Metadata Model Conversions
83
+ * ```javascript
84
+ * // Returns a paginated list of metadata model conversions for a migration project.
85
+ * const input = {
86
+ * "Filters": [
87
+ * {
88
+ * "Name": "request-id",
89
+ * "Values": [
90
+ * "01234567-89ab-cdef-0123-456789abcdef"
91
+ * ]
92
+ * }
93
+ * ],
94
+ * "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456",
95
+ * "MaxRecords": 123,
96
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
97
+ * };
98
+ * const command = new DescribeMetadataModelConversionsCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "Marker": "0123456789abcdefghijklmnopqrs",
103
+ * "Requests": [
104
+ * {
105
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef",
107
+ * "Status": "SUCCESS"
108
+ * }
109
+ * ]
110
+ * }
111
+ * *\/
112
+ * // example id: describe-metadata-model-conversions-1689719021495
113
+ * ```
114
+ *
82
115
  */
83
116
  export declare class DescribeMetadataModelConversionsCommand extends $Command<DescribeMetadataModelConversionsCommandInput, DescribeMetadataModelConversionsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
117
  readonly input: DescribeMetadataModelConversionsCommandInput;
@@ -79,6 +79,39 @@ export interface DescribeMetadataModelExportsAsScriptCommandOutput extends Descr
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Describe Metadata Model Exports As Script
83
+ * ```javascript
84
+ * // Returns a paginated list of metadata model exports.
85
+ * const input = {
86
+ * "Filters": [
87
+ * {
88
+ * "Name": "request-id",
89
+ * "Values": [
90
+ * "01234567-89ab-cdef-0123-456789abcdef"
91
+ * ]
92
+ * }
93
+ * ],
94
+ * "Marker": "0123456789abcdefghijklmnopqrs",
95
+ * "MaxRecords": 20,
96
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
97
+ * };
98
+ * const command = new DescribeMetadataModelExportsAsScriptCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "Marker": "0123456789abcdefghijklmnopqrs",
103
+ * "Requests": [
104
+ * {
105
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef",
107
+ * "Status": "SUCCESS"
108
+ * }
109
+ * ]
110
+ * }
111
+ * *\/
112
+ * // example id: describe-metadata-model-exports-as-script-1689719253938
113
+ * ```
114
+ *
82
115
  */
83
116
  export declare class DescribeMetadataModelExportsAsScriptCommand extends $Command<DescribeMetadataModelExportsAsScriptCommandInput, DescribeMetadataModelExportsAsScriptCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
117
  readonly input: DescribeMetadataModelExportsAsScriptCommandInput;
@@ -79,6 +79,39 @@ export interface DescribeMetadataModelExportsToTargetCommandOutput extends Descr
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Describe Metadata Model Exports To Target
83
+ * ```javascript
84
+ * // Returns a paginated list of metadata model exports.
85
+ * const input = {
86
+ * "Filters": [
87
+ * {
88
+ * "Name": "request-id",
89
+ * "Values": [
90
+ * "01234567-89ab-cdef-0123-456789abcdef"
91
+ * ]
92
+ * }
93
+ * ],
94
+ * "Marker": "0123456789abcdefghijklmnopqrs",
95
+ * "MaxRecords": 20,
96
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
97
+ * };
98
+ * const command = new DescribeMetadataModelExportsToTargetCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "Marker": "0123456789abcdefghijklmnopqrs",
103
+ * "Requests": [
104
+ * {
105
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef",
107
+ * "Status": "SUCCESS"
108
+ * }
109
+ * ]
110
+ * }
111
+ * *\/
112
+ * // example id: describe-metadata-model-exports-to-target-1689719484750
113
+ * ```
114
+ *
82
115
  */
83
116
  export declare class DescribeMetadataModelExportsToTargetCommand extends $Command<DescribeMetadataModelExportsToTargetCommandInput, DescribeMetadataModelExportsToTargetCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
117
  readonly input: DescribeMetadataModelExportsToTargetCommandInput;
@@ -79,6 +79,39 @@ export interface DescribeMetadataModelImportsCommandOutput extends DescribeMetad
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Describe Metadata Model Imports
83
+ * ```javascript
84
+ * // Returns a paginated list of metadata model imports.
85
+ * const input = {
86
+ * "Filters": [
87
+ * {
88
+ * "Name": "request-id",
89
+ * "Values": [
90
+ * "01234567-89ab-cdef-0123-456789abcdef"
91
+ * ]
92
+ * }
93
+ * ],
94
+ * "Marker": "0123456789abcdefghijklmnopqrs",
95
+ * "MaxRecords": 20,
96
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
97
+ * };
98
+ * const command = new DescribeMetadataModelImportsCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "Marker": "0123456789abcdefghijklmnopqrs",
103
+ * "Requests": [
104
+ * {
105
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
106
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef",
107
+ * "Status": "SUCCESS"
108
+ * }
109
+ * ]
110
+ * }
111
+ * *\/
112
+ * // example id: describe-metadata-model-imports-1689719771322
113
+ * ```
114
+ *
82
115
  */
83
116
  export declare class DescribeMetadataModelImportsCommand extends $Command<DescribeMetadataModelImportsCommandInput, DescribeMetadataModelImportsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
117
  readonly input: DescribeMetadataModelImportsCommandInput;
@@ -97,6 +97,60 @@ export interface DescribeMigrationProjectsCommandOutput extends DescribeMigratio
97
97
  * @throws {@link DatabaseMigrationServiceServiceException}
98
98
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
99
99
  *
100
+ * @example Describe Migration Projects
101
+ * ```javascript
102
+ * // Returns a paginated list of migration projects for your account in the current region.
103
+ * const input = {
104
+ * "Filters": [
105
+ * {
106
+ * "Name": "migration-project-identifier",
107
+ * "Values": [
108
+ * "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ12345678901"
109
+ * ]
110
+ * }
111
+ * ],
112
+ * "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456",
113
+ * "MaxRecords": 20
114
+ * };
115
+ * const command = new DescribeMigrationProjectsCommand(input);
116
+ * const response = await client.send(command);
117
+ * /* response ==
118
+ * {
119
+ * "Marker": "0123456789abcdefghijklmnopqrs",
120
+ * "MigrationProjects": [
121
+ * {
122
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
123
+ * "InstanceProfileName": "my-instance-profile",
124
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
125
+ * "MigrationProjectCreationTime": "2023-04-19T11:45:15.805253Z",
126
+ * "MigrationProjectName": "my-migration-project",
127
+ * "SchemaConversionApplicationAttributes": {
128
+ * "S3BucketPath": "my-s3-bucket/my_folder",
129
+ * "S3BucketRoleArn": "arn:aws:iam::012345678901:role/my-s3role"
130
+ * },
131
+ * "SourceDataProviderDescriptors": [
132
+ * {
133
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
134
+ * "DataProviderName": "all-source-oracle-12",
135
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role",
136
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/ALL.SOURCE.ORACLE_12-012345"
137
+ * }
138
+ * ],
139
+ * "TargetDataProviderDescriptors": [
140
+ * {
141
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
142
+ * "DataProviderName": "my-data-provider",
143
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/dmytbon-admin-access",
144
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/TARGET.postgresql-012345"
145
+ * }
146
+ * ]
147
+ * }
148
+ * ]
149
+ * }
150
+ * *\/
151
+ * // example id: describe-migration-projects-1689719912075
152
+ * ```
153
+ *
100
154
  */
101
155
  export declare class DescribeMigrationProjectsCommand extends $Command<DescribeMigrationProjectsCommandInput, DescribeMigrationProjectsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
102
156
  readonly input: DescribeMigrationProjectsCommandInput;
@@ -66,6 +66,34 @@ export interface ExportMetadataModelAssessmentCommandOutput extends ExportMetada
66
66
  * @throws {@link DatabaseMigrationServiceServiceException}
67
67
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
68
68
  *
69
+ * @example Export Metadata Model Assessment
70
+ * ```javascript
71
+ * // Saves a copy of a database migration assessment report to your S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.
72
+ * const input = {
73
+ * "AssessmentReportTypes": [
74
+ * "pdf"
75
+ * ],
76
+ * "FileName": "file",
77
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
78
+ * "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-a1b2c3d4e5f6.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}"
79
+ * };
80
+ * const command = new ExportMetadataModelAssessmentCommand(input);
81
+ * const response = await client.send(command);
82
+ * /* response ==
83
+ * {
84
+ * "CsvReport": {
85
+ * "ObjectURL": "url",
86
+ * "S3ObjectKey": "object-name"
87
+ * },
88
+ * "PdfReport": {
89
+ * "ObjectURL": "url",
90
+ * "S3ObjectKey": "object-name"
91
+ * }
92
+ * }
93
+ * *\/
94
+ * // example id: export-metadata-model-assessment-1689720309558
95
+ * ```
96
+ *
69
97
  */
70
98
  export declare class ExportMetadataModelAssessmentCommand extends $Command<ExportMetadataModelAssessmentCommandInput, ExportMetadataModelAssessmentCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
71
99
  readonly input: ExportMetadataModelAssessmentCommandInput;
@@ -57,6 +57,23 @@ export interface ModifyConversionConfigurationCommandOutput extends ModifyConver
57
57
  * @throws {@link DatabaseMigrationServiceServiceException}
58
58
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
59
59
  *
60
+ * @example Modify Conversion Configuration
61
+ * ```javascript
62
+ * // Modifies the specified schema conversion configuration using the provided parameters.
63
+ * const input = {
64
+ * "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"ORACLE_TO_POSTGRESQL\" : {\"ToTimeZone\":false,\"LastDayBuiltinFunctionOracle\":false, \"NextDayBuiltinFunctionOracle\":false,\"ConvertProceduresToFunction\":false,\"NvlBuiltinFunctionOracle\":false,\"DbmsAssertBuiltinFunctionOracle\":false}}",
65
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
66
+ * };
67
+ * const command = new ModifyConversionConfigurationCommand(input);
68
+ * const response = await client.send(command);
69
+ * /* response ==
70
+ * {
71
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
72
+ * }
73
+ * *\/
74
+ * // example id: modify-conversion-configuration-1689720529855
75
+ * ```
76
+ *
60
77
  */
61
78
  export declare class ModifyConversionConfigurationCommand extends $Command<ModifyConversionConfigurationCommandInput, ModifyConversionConfigurationCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
62
79
  readonly input: ModifyConversionConfigurationCommandInput;
@@ -197,6 +197,46 @@ export interface ModifyDataProviderCommandOutput extends ModifyDataProviderRespo
197
197
  * @throws {@link DatabaseMigrationServiceServiceException}
198
198
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
199
199
  *
200
+ * @example Modify Data Provider
201
+ * ```javascript
202
+ * // Modifies the specified data provider using the provided settings.
203
+ * const input = {
204
+ * "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
205
+ * "DataProviderName": "new-name",
206
+ * "Description": "description",
207
+ * "Engine": "sqlserver",
208
+ * "Settings": {
209
+ * "MicrosoftSqlServerSettings": {
210
+ * "DatabaseName": "DatabaseName",
211
+ * "Port": 11112,
212
+ * "ServerName": "ServerName2",
213
+ * "SslMode": "none"
214
+ * }
215
+ * }
216
+ * };
217
+ * const command = new ModifyDataProviderCommand(input);
218
+ * const response = await client.send(command);
219
+ * /* response ==
220
+ * {
221
+ * "DataProvider": {
222
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider",
223
+ * "DataProviderCreationTime": "2023-05-12T10:50:41.988561Z",
224
+ * "DataProviderName": "my-target-data-provider",
225
+ * "Engine": "postgres",
226
+ * "Settings": {
227
+ * "PostgreSqlSettings": {
228
+ * "DatabaseName": "target",
229
+ * "Port": 5432,
230
+ * "ServerName": "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com",
231
+ * "SslMode": "none"
232
+ * }
233
+ * }
234
+ * }
235
+ * }
236
+ * *\/
237
+ * // example id: modify-data-provider-1689720700567
238
+ * ```
239
+ *
200
240
  */
201
241
  export declare class ModifyDataProviderCommand extends $Command<ModifyDataProviderCommandInput, ModifyDataProviderCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
202
242
  readonly input: ModifyDataProviderCommandInput;
@@ -97,6 +97,41 @@ export interface ModifyInstanceProfileCommandOutput extends ModifyInstanceProfil
97
97
  * @throws {@link DatabaseMigrationServiceServiceException}
98
98
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
99
99
  *
100
+ * @example Modify Instance Profile
101
+ * ```javascript
102
+ * // Modifies the specified instance profile using the provided parameters.
103
+ * const input = {
104
+ * "AvailabilityZone": "",
105
+ * "Description": "",
106
+ * "InstanceProfileIdentifier": "",
107
+ * "InstanceProfileName": "",
108
+ * "KmsKeyArn": "",
109
+ * "NetworkType": "",
110
+ * "PubliclyAccessible": true,
111
+ * "SubnetGroupIdentifier": "",
112
+ * "VpcSecurityGroups": []
113
+ * };
114
+ * const command = new ModifyInstanceProfileCommand(input);
115
+ * const response = await client.send(command);
116
+ * /* response ==
117
+ * {
118
+ * "InstanceProfile": {
119
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
120
+ * "InstanceProfileCreationTime": "2022-12-16T09:44:43.543246Z",
121
+ * "InstanceProfileName": "my-instance-profile",
122
+ * "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
123
+ * "PubliclyAccessible": true,
124
+ * "SubnetGroupIdentifier": "public-subnets",
125
+ * "VpcIdentifier": "vpc-0a1b2c3d4e5f6g7h8",
126
+ * "VpcSecurityGroups": [
127
+ * "sg-0123456"
128
+ * ]
129
+ * }
130
+ * }
131
+ * *\/
132
+ * // example id: modify-instance-profile-1689724223329
133
+ * ```
134
+ *
100
135
  */
101
136
  export declare class ModifyInstanceProfileCommand extends $Command<ModifyInstanceProfileCommandInput, ModifyInstanceProfileCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
102
137
  readonly input: ModifyInstanceProfileCommandInput;
@@ -120,6 +120,69 @@ export interface ModifyMigrationProjectCommandOutput extends ModifyMigrationProj
120
120
  * @throws {@link DatabaseMigrationServiceServiceException}
121
121
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
122
122
  *
123
+ * @example Modify Migration Project
124
+ * ```javascript
125
+ * // Modifies the specified migration project using the provided parameters.
126
+ * const input = {
127
+ * "Description": "description",
128
+ * "InstanceProfileIdentifier": "my-instance-profile",
129
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
130
+ * "MigrationProjectName": "new-name",
131
+ * "SchemaConversionApplicationAttributes": {
132
+ * "S3BucketPath": "arn:aws:s3:::myuser-bucket",
133
+ * "S3BucketRoleArn": "arn:aws:iam::012345678901:role/Admin"
134
+ * },
135
+ * "SourceDataProviderDescriptors": [
136
+ * {
137
+ * "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
138
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access",
139
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/ALL.SOURCE.ORACLE_12-A1B2C3"
140
+ * }
141
+ * ],
142
+ * "TargetDataProviderDescriptors": [
143
+ * {
144
+ * "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
145
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access",
146
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/TARGET.postgresql-A1B2C3"
147
+ * }
148
+ * ]
149
+ * };
150
+ * const command = new ModifyMigrationProjectCommand(input);
151
+ * const response = await client.send(command);
152
+ * /* response ==
153
+ * {
154
+ * "MigrationProject": {
155
+ * "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
156
+ * "InstanceProfileName": "my-instance-profile",
157
+ * "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
158
+ * "MigrationProjectCreationTime": "2023-04-19T11:45:15.805253Z",
159
+ * "MigrationProjectName": "my-migration-project",
160
+ * "SchemaConversionApplicationAttributes": {
161
+ * "S3BucketPath": "my-s3-bucket/my_folder",
162
+ * "S3BucketRoleArn": "arn:aws:iam::012345678901:role/my-s3role"
163
+ * },
164
+ * "SourceDataProviderDescriptors": [
165
+ * {
166
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
167
+ * "DataProviderName": "all-source-oracle-12",
168
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role",
169
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/ALL.SOURCE.ORACLE_12-TP5rA9"
170
+ * }
171
+ * ],
172
+ * "TargetDataProviderDescriptors": [
173
+ * {
174
+ * "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
175
+ * "DataProviderName": "my-dataprovider",
176
+ * "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role",
177
+ * "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/TARGET.postgresql-mysecret"
178
+ * }
179
+ * ]
180
+ * }
181
+ * }
182
+ * *\/
183
+ * // example id: modify-migration-project-1689721117475
184
+ * ```
185
+ *
123
186
  */
124
187
  export declare class ModifyMigrationProjectCommand extends $Command<ModifyMigrationProjectCommandInput, ModifyMigrationProjectCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
125
188
  readonly input: ModifyMigrationProjectCommandInput;
@@ -79,6 +79,22 @@ export interface StartExtensionPackAssociationCommandOutput extends StartExtensi
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Start Extension Pack Association
83
+ * ```javascript
84
+ * // Applies the extension pack to your target database.
85
+ * const input = {
86
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
87
+ * };
88
+ * const command = new StartExtensionPackAssociationCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response ==
91
+ * {
92
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
93
+ * }
94
+ * *\/
95
+ * // example id: start-extension-pack-association-1689721897266
96
+ * ```
97
+ *
82
98
  */
83
99
  export declare class StartExtensionPackAssociationCommand extends $Command<StartExtensionPackAssociationCommandInput, StartExtensionPackAssociationCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
100
  readonly input: StartExtensionPackAssociationCommandInput;
@@ -80,6 +80,24 @@ export interface StartMetadataModelAssessmentCommandOutput extends StartMetadata
80
80
  * @throws {@link DatabaseMigrationServiceServiceException}
81
81
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
82
82
  *
83
+ * @example Start Metadata Model Assessment
84
+ * ```javascript
85
+ * // Creates a database migration assessment report by assessing the migration complexity for
86
+ * // your source database.
87
+ * const input = {
88
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
89
+ * "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}"
90
+ * };
91
+ * const command = new StartMetadataModelAssessmentCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
96
+ * }
97
+ * *\/
98
+ * // example id: start-metadata-model-assessment-1689722322596
99
+ * ```
100
+ *
83
101
  */
84
102
  export declare class StartMetadataModelAssessmentCommand extends $Command<StartMetadataModelAssessmentCommandInput, StartMetadataModelAssessmentCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
85
103
  readonly input: StartMetadataModelAssessmentCommandInput;
@@ -77,6 +77,23 @@ export interface StartMetadataModelConversionCommandOutput extends StartMetadata
77
77
  * @throws {@link DatabaseMigrationServiceServiceException}
78
78
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
79
79
  *
80
+ * @example Start Metadata Model Conversion
81
+ * ```javascript
82
+ * // Converts your source database objects to a format compatible with the target database.
83
+ * const input = {
84
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
85
+ * "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}"
86
+ * };
87
+ * const command = new StartMetadataModelConversionCommand(input);
88
+ * const response = await client.send(command);
89
+ * /* response ==
90
+ * {
91
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
92
+ * }
93
+ * *\/
94
+ * // example id: start-metadata-model-conversion-1689722427798
95
+ * ```
96
+ *
80
97
  */
81
98
  export declare class StartMetadataModelConversionCommand extends $Command<StartMetadataModelConversionCommandInput, StartMetadataModelConversionCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
82
99
  readonly input: StartMetadataModelConversionCommandInput;
@@ -79,6 +79,25 @@ export interface StartMetadataModelExportAsScriptCommandOutput extends StartMeta
79
79
  * @throws {@link DatabaseMigrationServiceServiceException}
80
80
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
81
81
  *
82
+ * @example Start Metadata Model Export As Script
83
+ * ```javascript
84
+ * // Saves your converted code to a file as a SQL script, and stores this file on your S3 bucket.
85
+ * const input = {
86
+ * "FileName": "FILE",
87
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
88
+ * "Origin": "SOURCE",
89
+ * "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}"
90
+ * };
91
+ * const command = new StartMetadataModelExportAsScriptCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
96
+ * }
97
+ * *\/
98
+ * // example id: start-metadata-model-export-as-script-1689722681469
99
+ * ```
100
+ *
82
101
  */
83
102
  export declare class StartMetadataModelExportAsScriptCommand extends $Command<StartMetadataModelExportAsScriptCommandInput, StartMetadataModelExportAsScriptCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
84
103
  readonly input: StartMetadataModelExportAsScriptCommandInput;
@@ -78,6 +78,24 @@ export interface StartMetadataModelExportToTargetCommandOutput extends StartMeta
78
78
  * @throws {@link DatabaseMigrationServiceServiceException}
79
79
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
80
80
  *
81
+ * @example Start Metadata Model Export To Target
82
+ * ```javascript
83
+ * // Applies converted database objects to your target database.
84
+ * const input = {
85
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
86
+ * "OverwriteExtensionPack": true,
87
+ * "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-a1b2c3d4e5f6.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}"
88
+ * };
89
+ * const command = new StartMetadataModelExportToTargetCommand(input);
90
+ * const response = await client.send(command);
91
+ * /* response ==
92
+ * {
93
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
94
+ * }
95
+ * *\/
96
+ * // example id: start-metadata-model-export-to-target-1689783666835
97
+ * ```
98
+ *
81
99
  */
82
100
  export declare class StartMetadataModelExportToTargetCommand extends $Command<StartMetadataModelExportToTargetCommandInput, StartMetadataModelExportToTargetCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
83
101
  readonly input: StartMetadataModelExportToTargetCommandInput;
@@ -80,6 +80,25 @@ export interface StartMetadataModelImportCommandOutput extends StartMetadataMode
80
80
  * @throws {@link DatabaseMigrationServiceServiceException}
81
81
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
82
82
  *
83
+ * @example Start Metadata Model Import
84
+ * ```javascript
85
+ * // Loads the metadata for all the dependent database objects of the parent object.
86
+ * const input = {
87
+ * "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
88
+ * "Origin": "SOURCE",
89
+ * "Refresh": false,
90
+ * "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}"
91
+ * };
92
+ * const command = new StartMetadataModelImportCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response ==
95
+ * {
96
+ * "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
97
+ * }
98
+ * *\/
99
+ * // example id: start-metadata-model-import-1689723124259
100
+ * ```
101
+ *
83
102
  */
84
103
  export declare class StartMetadataModelImportCommand extends $Command<StartMetadataModelImportCommandInput, StartMetadataModelImportCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
85
104
  readonly input: StartMetadataModelImportCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-database-migration-service",
3
3
  "description": "AWS SDK for JavaScript Database Migration Service Client for Node.js, Browser and React Native",
4
- "version": "3.418.0",
4
+ "version": "3.421.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,8 +21,8 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.418.0",
25
- "@aws-sdk/credential-provider-node": "3.418.0",
24
+ "@aws-sdk/client-sts": "3.421.0",
25
+ "@aws-sdk/credential-provider-node": "3.421.0",
26
26
  "@aws-sdk/middleware-host-header": "3.418.0",
27
27
  "@aws-sdk/middleware-logger": "3.418.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.418.0",