ModifyMigrationProject
Modifies the specified migration project using the provided parameters.
Note
The migration project must be closed before you can modify it.
Request Syntax
{
"Description": "string",
"InstanceProfileIdentifier": "string",
"MigrationProjectIdentifier": "string",
"MigrationProjectName": "string",
"SchemaConversionApplicationAttributes": {
"S3BucketPath": "string",
"S3BucketRoleArn": "string"
},
"SourceDataProviderDescriptors": [
{
"DataProviderIdentifier": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string"
}
],
"TargetDataProviderDescriptors": [
{
"DataProviderIdentifier": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string"
}
],
"TransformationRules": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Description
-
A user-friendly description of the migration project.
Type: String
Required: No
- InstanceProfileIdentifier
-
The name or Amazon Resource Name (ARN) for the instance profile.
Type: String
Required: No
- MigrationProjectIdentifier
-
The identifier of the migration project. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
Type: String
Required: Yes
- MigrationProjectName
-
A user-friendly name for the migration project.
Type: String
Required: No
- SchemaConversionApplicationAttributes
-
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
Type: SCApplicationAttributes object
Required: No
- SourceDataProviderDescriptors
-
Information about the source data provider, including the name, ARN, and AWS Secrets Manager parameters.
Type: Array of DataProviderDescriptorDefinition objects
Required: No
- TargetDataProviderDescriptors
-
Information about the target data provider, including the name, ARN, and AWS Secrets Manager parameters.
Type: Array of DataProviderDescriptorDefinition objects
Required: No
- TransformationRules
-
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
Type: String
Required: No
Response Syntax
{
"MigrationProject": {
"Description": "string",
"InstanceProfileArn": "string",
"InstanceProfileName": "string",
"MigrationProjectArn": "string",
"MigrationProjectCreationTime": "string",
"MigrationProjectName": "string",
"SchemaConversionApplicationAttributes": {
"S3BucketPath": "string",
"S3BucketRoleArn": "string"
},
"SourceDataProviderDescriptors": [
{
"DataProviderArn": "string",
"DataProviderName": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string"
}
],
"TargetDataProviderDescriptors": [
{
"DataProviderArn": "string",
"DataProviderName": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string"
}
],
"TransformationRules": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MigrationProject
-
The migration project that was modified.
Type: MigrationProject object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- FailedDependencyFault
-
A dependency threw an exception.
HTTP Status Code: 400
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
- S3AccessDeniedFault
-
Insufficient privileges are preventing access to an Amazon S3 object.
HTTP Status Code: 400
- S3ResourceNotFoundFault
-
A specified Amazon S3 bucket, bucket folder, or other object can't be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ModifyMigrationProject.
Sample Request
{
"MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
"MigrationProjectName": "new-name",
"SourceDataProviderDescriptors": [
{
"DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
"SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/ALL.SOURCE.ORACLE_12-A1B2C3",
"SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access"
}
],
"TargetDataProviderDescriptors": [
{
"DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
"SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/TARGET.postgresql-A1B2C3",
"SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access"
}
],
"InstanceProfileIdentifier": "my-instance-profile",
"SchemaConversionApplicationAttributes": {
"S3BucketPath": "arn:aws:s3:::myuser-bucket",
"S3BucketRoleArn": "arn:aws:iam::012345678901:role/Admin"
},
"Description": "description"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
