@aws-sdk/client-database-migration-service 3.1097.0 → 3.1099.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +1 -1
- package/dist-types/commands/CancelMetadataModelConversionCommand.d.ts +24 -0
- package/dist-types/commands/CancelMetadataModelCreationCommand.d.ts +24 -0
- package/dist-types/commands/CreateDataProviderCommand.d.ts +25 -24
- package/dist-types/commands/CreateInstanceProfileCommand.d.ts +23 -20
- package/dist-types/commands/CreateMigrationProjectCommand.d.ts +36 -36
- package/dist-types/commands/DeleteDataProviderCommand.d.ts +18 -12
- package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +16 -10
- package/dist-types/commands/DeleteMigrationProjectCommand.d.ts +25 -19
- package/dist-types/commands/DescribeConversionConfigurationCommand.d.ts +9 -5
- package/dist-types/commands/DescribeDataProvidersCommand.d.ts +20 -17
- package/dist-types/commands/DescribeExtensionPackAssociationsCommand.d.ts +35 -13
- package/dist-types/commands/DescribeInstanceProfilesCommand.d.ts +20 -14
- package/dist-types/commands/DescribeMetadataModelAssessmentsCommand.d.ts +41 -12
- package/dist-types/commands/DescribeMetadataModelChildrenCommand.d.ts +38 -0
- package/dist-types/commands/DescribeMetadataModelCommand.d.ts +29 -0
- package/dist-types/commands/DescribeMetadataModelConversionsCommand.d.ts +42 -10
- package/dist-types/commands/DescribeMetadataModelCreationsCommand.d.ts +55 -1
- package/dist-types/commands/DescribeMetadataModelExportsAsScriptCommand.d.ts +42 -10
- package/dist-types/commands/DescribeMetadataModelExportsToTargetCommand.d.ts +38 -10
- package/dist-types/commands/DescribeMetadataModelImportsCommand.d.ts +38 -10
- package/dist-types/commands/DescribeMigrationProjectsCommand.d.ts +26 -23
- package/dist-types/commands/ExportMetadataModelAssessmentCommand.d.ts +15 -10
- package/dist-types/commands/GetTargetSelectionRulesCommand.d.ts +20 -0
- package/dist-types/commands/ModifyConversionConfigurationCommand.d.ts +9 -5
- package/dist-types/commands/ModifyDataProviderCommand.d.ts +20 -18
- package/dist-types/commands/ModifyInstanceProfileCommand.d.ts +18 -18
- package/dist-types/commands/ModifyMigrationProjectCommand.d.ts +27 -36
- package/dist-types/commands/StartExtensionPackAssociationCommand.d.ts +18 -7
- package/dist-types/commands/StartMetadataModelAssessmentCommand.d.ts +22 -10
- package/dist-types/commands/StartMetadataModelConversionCommand.d.ts +56 -6
- package/dist-types/commands/StartMetadataModelCreationCommand.d.ts +53 -2
- package/dist-types/commands/StartMetadataModelExportAsScriptCommand.d.ts +22 -9
- package/dist-types/commands/StartMetadataModelExportToTargetCommand.d.ts +25 -6
- package/dist-types/commands/StartMetadataModelImportCommand.d.ts +16 -8
- package/dist-types/models/models_0.d.ts +339 -71
- package/dist-types/models/models_1.d.ts +93 -25
- package/package.json +6 -6
|
@@ -24,7 +24,13 @@ declare const DescribeMetadataModelExportsToTargetCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Returns a paginated list of metadata model
|
|
27
|
+
* <p>Returns a paginated list of metadata model export requests for a migration
|
|
28
|
+
* project, initiated by
|
|
29
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportToTarget.html">StartMetadataModelExportToTarget</a>.</p>
|
|
30
|
+
* <p>
|
|
31
|
+
* <b>Required permissions:</b>
|
|
32
|
+
* <code>dms:ListMetadataModelExports</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>
|
|
28
34
|
* @example
|
|
29
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
36
|
* ```javascript
|
|
@@ -93,32 +99,54 @@ declare const DescribeMetadataModelExportsToTargetCommand_base: {
|
|
|
93
99
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
94
100
|
*
|
|
95
101
|
*
|
|
96
|
-
* @example
|
|
102
|
+
* @example Retrieve the status of metadata model exports to target
|
|
97
103
|
* ```javascript
|
|
98
|
-
* //
|
|
104
|
+
* // The following example retrieves the status of operations that export converted metadata models to the target database, identified by their request IDs.
|
|
99
105
|
* const input = {
|
|
100
106
|
* Filters: [
|
|
101
107
|
* {
|
|
102
108
|
* Name: "request-id",
|
|
103
109
|
* Values: [
|
|
104
|
-
* "
|
|
110
|
+
* "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
111
|
+
* "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
112
|
+
* "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
|
|
105
113
|
* ]
|
|
106
114
|
* }
|
|
107
115
|
* ],
|
|
108
|
-
*
|
|
109
|
-
* MaxRecords: 20,
|
|
110
|
-
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
|
|
116
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
|
|
111
117
|
* };
|
|
112
118
|
* const command = new DescribeMetadataModelExportsToTargetCommand(input);
|
|
113
119
|
* const response = await client.send(command);
|
|
114
120
|
* /* response is
|
|
115
121
|
* {
|
|
116
|
-
* Marker: "0123456789abcdefghijklmnopqrs",
|
|
117
122
|
* Requests: [
|
|
118
123
|
* {
|
|
119
|
-
* MigrationProjectArn: "arn:aws:dms:us-east-1:
|
|
120
|
-
* RequestIdentifier: "
|
|
124
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
125
|
+
* RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
121
126
|
* Status: "SUCCESS"
|
|
127
|
+
* },
|
|
128
|
+
* {
|
|
129
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
130
|
+
* Progress: {
|
|
131
|
+
* ProcessedObject: {
|
|
132
|
+
* EndpointType: "TARGET"
|
|
133
|
+
* },
|
|
134
|
+
* ProgressPercent: 50.0,
|
|
135
|
+
* ProgressStep: "APPLYING",
|
|
136
|
+
* TotalObjects: 100
|
|
137
|
+
* },
|
|
138
|
+
* RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
139
|
+
* Status: "IN_PROGRESS"
|
|
140
|
+
* },
|
|
141
|
+
* {
|
|
142
|
+
* Error: {
|
|
143
|
+
* defaultErrorDetails: {
|
|
144
|
+
* Message: "No objects were found according to the specified selection rules. Please review your selection rules and try again."
|
|
145
|
+
* }
|
|
146
|
+
* },
|
|
147
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
148
|
+
* RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
149
|
+
* Status: "FAILED"
|
|
122
150
|
* }
|
|
123
151
|
* ]
|
|
124
152
|
* }
|
|
@@ -24,7 +24,13 @@ declare const DescribeMetadataModelImportsCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Returns a paginated list of metadata model
|
|
27
|
+
* <p>Returns a paginated list of metadata model import requests for a migration
|
|
28
|
+
* project, initiated by
|
|
29
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html">StartMetadataModelImport</a>.</p>
|
|
30
|
+
* <p>
|
|
31
|
+
* <b>Required permissions:</b>
|
|
32
|
+
* <code>dms:DescribeMetadataModelImports</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>
|
|
28
34
|
* @example
|
|
29
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
36
|
* ```javascript
|
|
@@ -93,32 +99,54 @@ declare const DescribeMetadataModelImportsCommand_base: {
|
|
|
93
99
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
94
100
|
*
|
|
95
101
|
*
|
|
96
|
-
* @example
|
|
102
|
+
* @example Retrieve the status of metadata model imports
|
|
97
103
|
* ```javascript
|
|
98
|
-
* //
|
|
104
|
+
* // The following example retrieves the status of metadata import operations identified by their request IDs.
|
|
99
105
|
* const input = {
|
|
100
106
|
* Filters: [
|
|
101
107
|
* {
|
|
102
108
|
* Name: "request-id",
|
|
103
109
|
* Values: [
|
|
104
|
-
* "
|
|
110
|
+
* "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
111
|
+
* "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
112
|
+
* "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
|
|
105
113
|
* ]
|
|
106
114
|
* }
|
|
107
115
|
* ],
|
|
108
|
-
*
|
|
109
|
-
* MaxRecords: 20,
|
|
110
|
-
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
|
|
116
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
|
|
111
117
|
* };
|
|
112
118
|
* const command = new DescribeMetadataModelImportsCommand(input);
|
|
113
119
|
* const response = await client.send(command);
|
|
114
120
|
* /* response is
|
|
115
121
|
* {
|
|
116
|
-
* Marker: "0123456789abcdefghijklmnopqrs",
|
|
117
122
|
* Requests: [
|
|
118
123
|
* {
|
|
119
|
-
* MigrationProjectArn: "arn:aws:dms:us-east-1:
|
|
120
|
-
* RequestIdentifier: "
|
|
124
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
125
|
+
* RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
121
126
|
* Status: "SUCCESS"
|
|
127
|
+
* },
|
|
128
|
+
* {
|
|
129
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
130
|
+
* Progress: {
|
|
131
|
+
* ProcessedObject: {
|
|
132
|
+
* EndpointType: "SOURCE"
|
|
133
|
+
* },
|
|
134
|
+
* ProgressPercent: 50.0,
|
|
135
|
+
* ProgressStep: "IN_PROGRESS",
|
|
136
|
+
* TotalObjects: 100
|
|
137
|
+
* },
|
|
138
|
+
* RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
139
|
+
* Status: "IN_PROGRESS"
|
|
140
|
+
* },
|
|
141
|
+
* {
|
|
142
|
+
* Error: {
|
|
143
|
+
* defaultErrorDetails: {
|
|
144
|
+
* Message: "No objects were found according to the specified selection rules. Please review your selection rules and try again."
|
|
145
|
+
* }
|
|
146
|
+
* },
|
|
147
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
148
|
+
* RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
149
|
+
* Status: "FAILED"
|
|
122
150
|
* }
|
|
123
151
|
* ]
|
|
124
152
|
* }
|
|
@@ -26,6 +26,10 @@ declare const DescribeMigrationProjectsCommand_base: {
|
|
|
26
26
|
/**
|
|
27
27
|
* <p>Returns a paginated list of migration projects for your account in the current
|
|
28
28
|
* region.</p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>Required permissions:</b>
|
|
31
|
+
* <code>dms:ListMigrationProjects</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
|
|
@@ -105,53 +109,52 @@ declare const DescribeMigrationProjectsCommand_base: {
|
|
|
105
109
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
106
110
|
*
|
|
107
111
|
*
|
|
108
|
-
* @example Describe
|
|
112
|
+
* @example Describe migration projects with a filter
|
|
109
113
|
* ```javascript
|
|
110
|
-
* //
|
|
114
|
+
* // The following example retrieves the details of a migration project identified by its ARN.
|
|
111
115
|
* const input = {
|
|
112
116
|
* Filters: [
|
|
113
117
|
* {
|
|
114
118
|
* Name: "migration-project-identifier",
|
|
115
119
|
* Values: [
|
|
116
|
-
* "arn:aws:dms:us-east-1:
|
|
120
|
+
* "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
|
|
117
121
|
* ]
|
|
118
122
|
* }
|
|
119
|
-
* ]
|
|
120
|
-
* Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456",
|
|
121
|
-
* MaxRecords: 20
|
|
123
|
+
* ]
|
|
122
124
|
* };
|
|
123
125
|
* const command = new DescribeMigrationProjectsCommand(input);
|
|
124
126
|
* const response = await client.send(command);
|
|
125
127
|
* /* response is
|
|
126
128
|
* {
|
|
127
|
-
* Marker: "0123456789abcdefghijklmnopqrs",
|
|
128
129
|
* MigrationProjects: [
|
|
129
130
|
* {
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
131
|
+
* Description: "Example migration project for documentation",
|
|
132
|
+
* InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
133
|
+
* InstanceProfileName: "example-instance-profile",
|
|
134
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
135
|
+
* MigrationProjectCreationTime: "2026-01-09T12:30:00.000000Z",
|
|
136
|
+
* MigrationProjectName: "example-migration-project",
|
|
135
137
|
* SchemaConversionApplicationAttributes: {
|
|
136
|
-
* S3BucketPath: "
|
|
137
|
-
* S3BucketRoleArn: "arn:aws:iam::
|
|
138
|
+
* S3BucketPath: "s3://amzn-s3-demo-bucket",
|
|
139
|
+
* S3BucketRoleArn: "arn:aws:iam::111122223333:role/example-s3-access-role"
|
|
138
140
|
* },
|
|
139
141
|
* SourceDataProviderDescriptors: [
|
|
140
142
|
* {
|
|
141
|
-
* DataProviderArn: "arn:aws:dms:us-east-1:
|
|
142
|
-
* DataProviderName: "
|
|
143
|
-
* SecretsManagerAccessRoleArn: "arn:aws:iam::
|
|
144
|
-
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:
|
|
143
|
+
* DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
144
|
+
* DataProviderName: "example-data-provider",
|
|
145
|
+
* SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
146
|
+
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3"
|
|
145
147
|
* }
|
|
146
148
|
* ],
|
|
147
149
|
* TargetDataProviderDescriptors: [
|
|
148
150
|
* {
|
|
149
|
-
* DataProviderArn: "arn:aws:dms:us-east-1:
|
|
150
|
-
* DataProviderName: "
|
|
151
|
-
* SecretsManagerAccessRoleArn: "arn:aws:iam::
|
|
152
|
-
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:
|
|
151
|
+
* DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
152
|
+
* DataProviderName: "example-data-provider",
|
|
153
|
+
* SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
154
|
+
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3"
|
|
153
155
|
* }
|
|
154
|
-
* ]
|
|
156
|
+
* ],
|
|
157
|
+
* TransformationRules: `{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}`
|
|
155
158
|
* }
|
|
156
159
|
* ]
|
|
157
160
|
* }
|
|
@@ -26,6 +26,10 @@ declare const ExportMetadataModelAssessmentCommand_base: {
|
|
|
26
26
|
/**
|
|
27
27
|
* <p>Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can
|
|
28
28
|
* save your assessment report as a comma-separated value (CSV) or a PDF file. </p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>Required permissions:</b>
|
|
31
|
+
* <code>dms:ExportMetadataModelAssessment</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
|
|
@@ -70,28 +74,29 @@ declare const ExportMetadataModelAssessmentCommand_base: {
|
|
|
70
74
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
71
75
|
*
|
|
72
76
|
*
|
|
73
|
-
* @example Export
|
|
77
|
+
* @example Export a conversion assessment report
|
|
74
78
|
* ```javascript
|
|
75
|
-
* //
|
|
79
|
+
* // The following example exports a conversion assessment report for all objects in the ExampleSchema schema.
|
|
76
80
|
* const input = {
|
|
77
81
|
* AssessmentReportTypes: [
|
|
78
|
-
* "pdf"
|
|
82
|
+
* "pdf",
|
|
83
|
+
* "csv"
|
|
79
84
|
* ],
|
|
80
|
-
* FileName: "
|
|
81
|
-
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:
|
|
82
|
-
* SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "
|
|
85
|
+
* FileName: "example-assessment-report",
|
|
86
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
87
|
+
* SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"}, "rule-action": "explicit"}]}`
|
|
83
88
|
* };
|
|
84
89
|
* const command = new ExportMetadataModelAssessmentCommand(input);
|
|
85
90
|
* const response = await client.send(command);
|
|
86
91
|
* /* response is
|
|
87
92
|
* {
|
|
88
93
|
* CsvReport: {
|
|
89
|
-
* ObjectURL: "
|
|
90
|
-
* S3ObjectKey: "
|
|
94
|
+
* ObjectURL: "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.zip",
|
|
95
|
+
* S3ObjectKey: "example-migration-project/example-assessment-report.zip"
|
|
91
96
|
* },
|
|
92
97
|
* PdfReport: {
|
|
93
|
-
* ObjectURL: "
|
|
94
|
-
* S3ObjectKey: "
|
|
98
|
+
* ObjectURL: "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.pdf",
|
|
99
|
+
* S3ObjectKey: "example-migration-project/example-assessment-report.pdf"
|
|
95
100
|
* }
|
|
96
101
|
* }
|
|
97
102
|
* *\/
|
|
@@ -25,6 +25,10 @@ declare const GetTargetSelectionRulesCommand_base: {
|
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
27
|
* <p>Converts source selection rules into their target counterparts for schema conversion operations.</p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Required permissions:</b>
|
|
30
|
+
* <code>dms:GetTargetSelectionRules</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
|
|
@@ -65,6 +69,22 @@ declare const GetTargetSelectionRulesCommand_base: {
|
|
|
65
69
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
66
70
|
*
|
|
67
71
|
*
|
|
72
|
+
* @example Convert source selection rules to target selection rules
|
|
73
|
+
* ```javascript
|
|
74
|
+
* // The following example converts source selection rules that select the ExampleTable table in the ExampleSchema schema into target selection rules that reference its converted counterpart.
|
|
75
|
+
* const input = {
|
|
76
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
77
|
+
* SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "database-name": "ExampleDatabase", "schema-name": "ExampleSchema", "table-name": "ExampleTable"}, "rule-action": "explicit"}]}`
|
|
78
|
+
* };
|
|
79
|
+
* const command = new GetTargetSelectionRulesCommand(input);
|
|
80
|
+
* const response = await client.send(command);
|
|
81
|
+
* /* response is
|
|
82
|
+
* {
|
|
83
|
+
* TargetSelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-target-server.us-east-1.rds.amazonaws.com", "schema-name": "exampledatabase_exampleschema", "table-name": "exampletable"}, "rule-action": "explicit"}]}`
|
|
84
|
+
* }
|
|
85
|
+
* *\/
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
68
88
|
* @public
|
|
69
89
|
*/
|
|
70
90
|
export declare class GetTargetSelectionRulesCommand extends GetTargetSelectionRulesCommand_base {
|
|
@@ -25,6 +25,10 @@ declare const ModifyConversionConfigurationCommand_base: {
|
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
27
|
* <p>Modifies the specified schema conversion configuration using the provided parameters. </p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Required permissions:</b>
|
|
30
|
+
* <code>dms:UpdateConversionConfiguration</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
|
|
@@ -61,18 +65,18 @@ declare const ModifyConversionConfigurationCommand_base: {
|
|
|
61
65
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
62
66
|
*
|
|
63
67
|
*
|
|
64
|
-
* @example
|
|
68
|
+
* @example Modifying conversion configuration for a migration project
|
|
65
69
|
* ```javascript
|
|
66
|
-
* //
|
|
70
|
+
* // The following example enables generative AI assisted conversion and updates a conversion pair setting for a migration project.
|
|
67
71
|
* const input = {
|
|
68
|
-
* ConversionConfiguration: `{"Common project settings":{"
|
|
69
|
-
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:
|
|
72
|
+
* ConversionConfiguration: `{"Common project settings":{"EnableGenAiConversion":true},"MSSQL_TO_AURORA_POSTGRESQL":{"ConvertProceduresToFunction":false}}`,
|
|
73
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
|
|
70
74
|
* };
|
|
71
75
|
* const command = new ModifyConversionConfigurationCommand(input);
|
|
72
76
|
* const response = await client.send(command);
|
|
73
77
|
* /* response is
|
|
74
78
|
* {
|
|
75
|
-
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:
|
|
79
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
|
|
76
80
|
* }
|
|
77
81
|
* *\/
|
|
78
82
|
* ```
|
|
@@ -25,6 +25,10 @@ declare const ModifyDataProviderCommand_base: {
|
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
27
|
* <p>Modifies the specified data provider using the provided settings.</p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Required permissions:</b>
|
|
30
|
+
* <code>dms:UpdateDataProvider</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>You must remove the data provider from all migration projects before you can modify
|
|
30
34
|
* it.</p>
|
|
@@ -287,20 +291,16 @@ declare const ModifyDataProviderCommand_base: {
|
|
|
287
291
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
288
292
|
*
|
|
289
293
|
*
|
|
290
|
-
* @example Modify
|
|
294
|
+
* @example Modify a data provider
|
|
291
295
|
* ```javascript
|
|
292
|
-
* //
|
|
296
|
+
* // The following example updates the description and server name of a data provider.
|
|
293
297
|
* const input = {
|
|
294
|
-
* DataProviderIdentifier: "arn:aws:dms:us-east-1:
|
|
295
|
-
*
|
|
296
|
-
* Description: "description",
|
|
298
|
+
* DataProviderIdentifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
299
|
+
* Description: "Updated data provider description",
|
|
297
300
|
* Engine: "sqlserver",
|
|
298
301
|
* Settings: {
|
|
299
302
|
* MicrosoftSqlServerSettings: {
|
|
300
|
-
*
|
|
301
|
-
* Port: 11112,
|
|
302
|
-
* ServerName: "ServerName2",
|
|
303
|
-
* SslMode: "none"
|
|
303
|
+
* ServerName: "new-source-server.us-east-1.rds.amazonaws.com"
|
|
304
304
|
* }
|
|
305
305
|
* }
|
|
306
306
|
* };
|
|
@@ -309,16 +309,18 @@ declare const ModifyDataProviderCommand_base: {
|
|
|
309
309
|
* /* response is
|
|
310
310
|
* {
|
|
311
311
|
* DataProvider: {
|
|
312
|
-
* DataProviderArn: "arn:aws:dms:us-east-1:
|
|
313
|
-
* DataProviderCreationTime: "
|
|
314
|
-
* DataProviderName: "
|
|
315
|
-
*
|
|
312
|
+
* DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
313
|
+
* DataProviderCreationTime: "2026-01-09T12:30:00.000000Z",
|
|
314
|
+
* DataProviderName: "example-data-provider",
|
|
315
|
+
* Description: "Updated data provider description",
|
|
316
|
+
* Engine: "sqlserver",
|
|
316
317
|
* Settings: {
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
318
|
+
* MicrosoftSqlServerSettings: {
|
|
319
|
+
* CertificateArn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
320
|
+
* DatabaseName: "ExampleDatabase",
|
|
321
|
+
* Port: 1433,
|
|
322
|
+
* ServerName: "new-source-server.us-east-1.rds.amazonaws.com",
|
|
323
|
+
* SslMode: "verify-full"
|
|
322
324
|
* }
|
|
323
325
|
* }
|
|
324
326
|
* }
|
|
@@ -25,6 +25,10 @@ declare const ModifyInstanceProfileCommand_base: {
|
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
27
|
* <p>Modifies the specified instance profile using the provided parameters.</p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Required permissions:</b>
|
|
30
|
+
* <code>dms:UpdateInstanceProfile</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 modify the instance profile.</p>
|
|
@@ -104,33 +108,29 @@ declare const ModifyInstanceProfileCommand_base: {
|
|
|
104
108
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
105
109
|
*
|
|
106
110
|
*
|
|
107
|
-
* @example Modify
|
|
111
|
+
* @example Modify an instance profile
|
|
108
112
|
* ```javascript
|
|
109
|
-
* //
|
|
113
|
+
* // The following example updates the description and network type of an instance profile.
|
|
110
114
|
* const input = {
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* InstanceProfileName: "",
|
|
115
|
-
* KmsKeyArn: "",
|
|
116
|
-
* NetworkType: "",
|
|
117
|
-
* PubliclyAccessible: true,
|
|
118
|
-
* SubnetGroupIdentifier: "",
|
|
119
|
-
* VpcSecurityGroups: []
|
|
115
|
+
* Description: "Updated instance profile description",
|
|
116
|
+
* InstanceProfileIdentifier: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
117
|
+
* NetworkType: "DUAL"
|
|
120
118
|
* };
|
|
121
119
|
* const command = new ModifyInstanceProfileCommand(input);
|
|
122
120
|
* const response = await client.send(command);
|
|
123
121
|
* /* response is
|
|
124
122
|
* {
|
|
125
123
|
* InstanceProfile: {
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
124
|
+
* Description: "Updated instance profile description",
|
|
125
|
+
* InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
126
|
+
* InstanceProfileCreationTime: "2026-01-09T12:30:00.000000Z",
|
|
127
|
+
* InstanceProfileName: "example-instance-profile",
|
|
128
|
+
* KmsKeyArn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
129
|
+
* NetworkType: "DUAL",
|
|
130
|
+
* PubliclyAccessible: false,
|
|
131
|
+
* SubnetGroupIdentifier: "example-replication-subnet-group",
|
|
132
132
|
* VpcSecurityGroups: [
|
|
133
|
-
* "sg-
|
|
133
|
+
* "sg-0123456789abcdef0"
|
|
134
134
|
* ]
|
|
135
135
|
* }
|
|
136
136
|
* }
|
|
@@ -25,6 +25,10 @@ declare const ModifyMigrationProjectCommand_base: {
|
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
27
|
* <p>Modifies the specified migration project using the provided parameters.</p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Required permissions:</b>
|
|
30
|
+
* <code>dms:UpdateMigrationProject</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 modify it.</p>
|
|
30
34
|
* </note>
|
|
@@ -127,30 +131,15 @@ declare const ModifyMigrationProjectCommand_base: {
|
|
|
127
131
|
* <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
|
|
128
132
|
*
|
|
129
133
|
*
|
|
130
|
-
* @example Modify
|
|
134
|
+
* @example Modify a migration project
|
|
131
135
|
* ```javascript
|
|
132
|
-
* //
|
|
136
|
+
* // The following example updates the source data provider and description of a migration project.
|
|
133
137
|
* const input = {
|
|
134
|
-
* Description: "description",
|
|
135
|
-
*
|
|
136
|
-
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
|
|
137
|
-
* MigrationProjectName: "new-name",
|
|
138
|
-
* SchemaConversionApplicationAttributes: {
|
|
139
|
-
* S3BucketPath: "arn:aws:s3:::myuser-bucket",
|
|
140
|
-
* S3BucketRoleArn: "arn:aws:iam::012345678901:role/Admin"
|
|
141
|
-
* },
|
|
138
|
+
* Description: "Updated migration project description",
|
|
139
|
+
* MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
142
140
|
* SourceDataProviderDescriptors: [
|
|
143
141
|
* {
|
|
144
|
-
* DataProviderIdentifier: "arn:aws:dms:us-east-1:
|
|
145
|
-
* SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/myuser-admin-access",
|
|
146
|
-
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/ALL.SOURCE.ORACLE_12-A1B2C3"
|
|
147
|
-
* }
|
|
148
|
-
* ],
|
|
149
|
-
* TargetDataProviderDescriptors: [
|
|
150
|
-
* {
|
|
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/myuser/TARGET.postgresql-A1B2C3"
|
|
142
|
+
* DataProviderIdentifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
|
|
154
143
|
* }
|
|
155
144
|
* ]
|
|
156
145
|
* };
|
|
@@ -159,31 +148,33 @@ declare const ModifyMigrationProjectCommand_base: {
|
|
|
159
148
|
* /* response is
|
|
160
149
|
* {
|
|
161
150
|
* MigrationProject: {
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
151
|
+
* Description: "Updated migration project description",
|
|
152
|
+
* InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
153
|
+
* InstanceProfileName: "example-instance-profile",
|
|
154
|
+
* MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
155
|
+
* MigrationProjectCreationTime: "2026-01-09T12:30:00.000000Z",
|
|
156
|
+
* MigrationProjectName: "example-migration-project",
|
|
167
157
|
* SchemaConversionApplicationAttributes: {
|
|
168
|
-
* S3BucketPath: "
|
|
169
|
-
* S3BucketRoleArn: "arn:aws:iam::
|
|
158
|
+
* S3BucketPath: "s3://amzn-s3-demo-bucket",
|
|
159
|
+
* S3BucketRoleArn: "arn:aws:iam::111122223333:role/example-s3-access-role"
|
|
170
160
|
* },
|
|
171
161
|
* SourceDataProviderDescriptors: [
|
|
172
162
|
* {
|
|
173
|
-
* DataProviderArn: "arn:aws:dms:us-east-1:
|
|
174
|
-
* DataProviderName: "
|
|
175
|
-
* SecretsManagerAccessRoleArn: "arn:aws:iam::
|
|
176
|
-
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:
|
|
163
|
+
* DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
164
|
+
* DataProviderName: "example-data-provider",
|
|
165
|
+
* SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
166
|
+
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3"
|
|
177
167
|
* }
|
|
178
168
|
* ],
|
|
179
169
|
* TargetDataProviderDescriptors: [
|
|
180
170
|
* {
|
|
181
|
-
* DataProviderArn: "arn:aws:dms:us-east-1:
|
|
182
|
-
* DataProviderName: "
|
|
183
|
-
* SecretsManagerAccessRoleArn: "arn:aws:iam::
|
|
184
|
-
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:
|
|
171
|
+
* DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
172
|
+
* DataProviderName: "example-data-provider",
|
|
173
|
+
* SecretsManagerAccessRoleArn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
174
|
+
* SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3"
|
|
185
175
|
* }
|
|
186
|
-
* ]
|
|
176
|
+
* ],
|
|
177
|
+
* TransformationRules: `{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}`
|
|
187
178
|
* }
|
|
188
179
|
* }
|
|
189
180
|
* *\/
|