{ "version": "1.0", "examples": { "AddTagsToResource": [ { "input": { "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", "Tags": [ { "Key": "Acount", "Value": "1633456" } ] }, "output": {}, "comments": { "input": { "ResourceArn": "Required. Use the ARN of the resource you want to tag.", "Tags": "Required. Use the Key/Value pair format." }, "output": {} }, "description": "Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.", "id": "add-tags-to-resource-1481744141435", "title": "Add tags to resource" } ], "CancelMetadataModelConversion": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "output": { "Request": { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "CANCELING" } }, "comments": { "input": {}, "output": {} }, "description": "The following example cancels a metadata model conversion operation.", "id": "cancel-metadata-model-conversion-1689722427798", "title": "Cancel a metadata model conversion" } ], "CancelMetadataModelCreation": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "output": { "Request": { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "CANCELING" } }, "comments": { "input": {}, "output": {} }, "description": "The following example cancels a metadata model creation operation.", "id": "cancel-metadata-model-creation-1689722427798", "title": "Cancel a metadata model creation" } ], "CreateDataProvider": [ { "input": { "DataProviderName": "example-data-provider", "Description": "Example data provider for documentation", "Engine": "sqlserver", "Settings": { "MicrosoftSqlServerSettings": { "CertificateArn": "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS", "DatabaseName": "ExampleDatabase", "Port": 1433, "ServerName": "example-source-server.us-east-1.rds.amazonaws.com", "SslMode": "verify-full" } } }, "output": { "DataProvider": { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderCreationTime": "2026-01-09T12:30:00.000000Z", "DataProviderName": "example-data-provider", "Description": "Example data provider for documentation", "Engine": "sqlserver", "Settings": { "MicrosoftSqlServerSettings": { "CertificateArn": "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS", "DatabaseName": "ExampleDatabase", "Port": 1433, "ServerName": "example-source-server.us-east-1.rds.amazonaws.com", "SslMode": "verify-full" } } } }, "comments": { "input": {}, "output": {} }, "description": "The following example creates a Microsoft SQL Server data provider.", "id": "create-data-provider-1689726511871", "title": "Create a Microsoft SQL Server data provider" } ], "CreateEndpoint": [ { "input": { "CertificateArn": "", "DatabaseName": "testdb", "EndpointIdentifier": "test-endpoint-1", "EndpointType": "source", "EngineName": "mysql", "ExtraConnectionAttributes": "", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", "Password": "pasword", "Port": 3306, "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", "SslMode": "require", "Tags": [ { "Key": "Acount", "Value": "143327655" } ], "Username": "username" }, "output": { "Endpoint": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", "EndpointIdentifier": "test-endpoint-1", "EndpointType": "source", "EngineName": "mysql", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", "Port": 3306, "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", "Status": "active", "Username": "username" } }, "comments": { "input": {}, "output": {} }, "description": "Creates an endpoint using the provided settings.", "id": "create-endpoint-1481746254348", "title": "Create endpoint" } ], "CreateInstanceProfile": [ { "input": { "Description": "Example instance profile for documentation", "InstanceProfileName": "example-instance-profile", "KmsKeyArn": "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "NetworkType": "IPV4", "PubliclyAccessible": false, "SubnetGroupIdentifier": "example-replication-subnet-group", "VpcSecurityGroups": [ "sg-0123456789abcdef0" ] }, "output": { "InstanceProfile": { "Description": "Example instance profile for documentation", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000Z", "InstanceProfileName": "example-instance-profile", "KmsKeyArn": "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "NetworkType": "IPV4", "PubliclyAccessible": false, "SubnetGroupIdentifier": "example-replication-subnet-group", "VpcSecurityGroups": [ "sg-0123456789abcdef0" ] } }, "comments": { "input": {}, "output": {} }, "description": "The following example creates an instance profile.", "id": "create-instance-profile-1689716070633", "title": "Create an instance profile" } ], "CreateMigrationProject": [ { "input": { "Description": "Example migration project for documentation", "InstanceProfileIdentifier": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "MigrationProjectName": "example-migration-project", "SchemaConversionApplicationAttributes": { "S3BucketPath": "s3://amzn-s3-demo-bucket", "S3BucketRoleArn": "arn:aws:iam::111122223333:role/example-s3-access-role" }, "SourceDataProviderDescriptors": [ { "DataProviderIdentifier": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3" } ], "TargetDataProviderDescriptors": [ { "DataProviderIdentifier": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3" } ], "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}" }, "output": { "MigrationProject": { "Description": "Example migration project for documentation", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileName": "example-instance-profile", "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000Z", "MigrationProjectName": "example-migration-project", "SchemaConversionApplicationAttributes": { "S3BucketPath": "s3://amzn-s3-demo-bucket", "S3BucketRoleArn": "arn:aws:iam::111122223333:role/example-s3-access-role" }, "SourceDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3" } ], "TargetDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3" } ], "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}" } }, "comments": { "input": {}, "output": {} }, "description": "The following example creates a migration project.", "id": "create-migration-project-1689716672685", "title": "Create a migration project" } ], "CreateReplicationInstance": [ { "input": { "AllocatedStorage": 123, "AutoMinorVersionUpgrade": true, "AvailabilityZone": "", "EngineVersion": "", "KmsKeyId": "", "MultiAZ": true, "PreferredMaintenanceWindow": "", "PubliclyAccessible": true, "ReplicationInstanceClass": "", "ReplicationInstanceIdentifier": "", "ReplicationSubnetGroupIdentifier": "", "Tags": [ { "Key": "string", "Value": "string" } ], "VpcSecurityGroupIds": [] }, "output": { "ReplicationInstance": { "AllocatedStorage": 5, "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "PubliclyAccessible": true, "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceIdentifier": "test-rep-1", "ReplicationInstanceStatus": "creating", "ReplicationSubnetGroup": { "ReplicationSubnetGroupDescription": "default", "ReplicationSubnetGroupIdentifier": "default", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetAvailabilityZone": { "Name": "us-east-1d" }, "SubnetIdentifier": "subnet-f6dd91af", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1b" }, "SubnetIdentifier": "subnet-3605751d", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetIdentifier": "subnet-c2daefb5", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetIdentifier": "subnet-85e90cb8", "SubnetStatus": "Active" } ], "VpcId": "vpc-6741a603" } } }, "comments": { "output": {} }, "description": "Creates the replication instance using the specified parameters.", "id": "create-replication-instance-1481746705295", "title": "Create replication instance" } ], "CreateReplicationSubnetGroup": [ { "input": { "ReplicationSubnetGroupDescription": "US West subnet group", "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366", "SubnetIds": [ "subnet-e145356n", "subnet-58f79200" ], "Tags": [ { "Key": "Acount", "Value": "145235" } ] }, "output": { "ReplicationSubnetGroup": {} }, "comments": { "output": {} }, "description": "Creates a replication subnet group given a list of the subnet IDs in a VPC.", "id": "create-replication-subnet-group-1481747297930", "title": "Create replication subnet group" } ], "CreateReplicationTask": [ { "input": { "CdcStartTime": "2016-12-14T18:25:43Z", "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationTaskIdentifier": "task1", "ReplicationTaskSettings": "", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "TableMappings": "file://mappingfile.json", "Tags": [ { "Key": "Acount", "Value": "24352226" } ], "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" }, "output": { "ReplicationTask": { "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", "ReplicationTaskIdentifier": "task1", "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "Status": "creating", "TableMappings": "file://mappingfile.json", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" } }, "comments": { "input": {}, "output": {} }, "description": "Creates a replication task using the specified parameters.", "id": "create-replication-task-1481747646288", "title": "Create replication task" } ], "DeleteCertificate": [ { "input": { "CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ" }, "output": { "Certificate": {} }, "comments": { "input": {}, "output": {} }, "description": "Deletes the specified certificate.", "id": "delete-certificate-1481751957981", "title": "Delete Certificate" } ], "DeleteConnection": [ { "input": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" }, "output": { "Connection": {} }, "comments": { "input": {}, "output": {} }, "description": "Deletes the connection between the replication instance and the endpoint.", "id": "delete-connection-1481751957981", "title": "Delete Connection" } ], "DeleteDataProvider": [ { "input": { "DataProviderIdentifier": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "DataProvider": { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderCreationTime": "2026-01-09T12:30:00.000000Z", "DataProviderName": "example-data-provider", "Description": "Example data provider for documentation", "Engine": "sqlserver", "Settings": { "MicrosoftSqlServerSettings": { "CertificateArn": "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS", "DatabaseName": "ExampleDatabase", "Port": 1433, "ServerName": "example-source-server.us-east-1.rds.amazonaws.com", "SslMode": "verify-full" } } } }, "comments": { "input": {}, "output": {} }, "description": "The following example deletes a data provider identified by its ARN.", "id": "delete-data-provider-1689724476356", "title": "Delete a data provider" } ], "DeleteEndpoint": [ { "input": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM" }, "output": { "Endpoint": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", "EndpointIdentifier": "test-endpoint-1", "EndpointType": "source", "EngineName": "mysql", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", "Port": 3306, "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", "Status": "active", "Username": "username" } }, "comments": { "input": {}, "output": {} }, "description": "Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.\n", "id": "delete-endpoint-1481752425530", "title": "Delete Endpoint" } ], "DeleteInstanceProfile": [ { "input": { "InstanceProfileIdentifier": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "InstanceProfile": { "Description": "Example instance profile for documentation", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000Z", "InstanceProfileName": "example-instance-profile", "KmsKeyArn": "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "NetworkType": "IPV4", "PubliclyAccessible": false, "SubnetGroupIdentifier": "example-replication-subnet-group", "VpcSecurityGroups": [ "sg-0123456789abcdef0" ] } }, "comments": { "input": {}, "output": {} }, "description": "The following example deletes an instance profile identified by its ARN.", "id": "delete-instance-profile-1689716924105", "title": "Delete an instance profile" } ], "DeleteMigrationProject": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "MigrationProject": { "Description": "Example migration project for documentation", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileName": "example-instance-profile", "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000Z", "MigrationProjectName": "example-migration-project", "SchemaConversionApplicationAttributes": { "S3BucketPath": "s3://amzn-s3-demo-bucket", "S3BucketRoleArn": "arn:aws:iam::111122223333:role/example-s3-access-role" }, "SourceDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3" } ], "TargetDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3" } ], "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}" } }, "comments": { "input": {}, "output": {} }, "description": "The following example deletes a migration project identified by its ARN.", "id": "delete-migration-project-1689717217454", "title": "Delete a migration project" } ], "DeleteReplicationInstance": [ { "input": { "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" }, "output": { "ReplicationInstance": { "AllocatedStorage": 5, "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "PubliclyAccessible": true, "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceIdentifier": "test-rep-1", "ReplicationInstanceStatus": "creating", "ReplicationSubnetGroup": { "ReplicationSubnetGroupDescription": "default", "ReplicationSubnetGroupIdentifier": "default", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetAvailabilityZone": { "Name": "us-east-1d" }, "SubnetIdentifier": "subnet-f6dd91af", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1b" }, "SubnetIdentifier": "subnet-3605751d", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetIdentifier": "subnet-c2daefb5", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetIdentifier": "subnet-85e90cb8", "SubnetStatus": "Active" } ], "VpcId": "vpc-6741a603" } } }, "comments": { "output": {} }, "description": "Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.\n\n", "id": "delete-replication-instance-1481752552839", "title": "Delete Replication Instance" } ], "DeleteReplicationSubnetGroup": [ { "input": { "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366" }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "Deletes a replication subnet group.", "id": "delete-replication-subnet-group-1481752728597", "title": "Delete Replication Subnet Group" } ], "DeleteReplicationTask": [ { "input": { "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" }, "output": { "ReplicationTask": { "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", "ReplicationTaskIdentifier": "task1", "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "Status": "creating", "TableMappings": "file://mappingfile.json", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" } }, "comments": { "input": {}, "output": {} }, "description": "Deletes the specified replication task.", "id": "delete-replication-task-1481752903506", "title": "Delete Replication Task" } ], "DescribeAccountAttributes": [ { "input": {}, "output": { "AccountQuotas": [ { "AccountQuotaName": "ReplicationInstances", "Max": 20, "Used": 0 }, { "AccountQuotaName": "AllocatedStorage", "Max": 20, "Used": 0 }, { "AccountQuotaName": "Endpoints", "Max": 20, "Used": 0 } ] }, "comments": { "input": {}, "output": {} }, "description": "Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.", "id": "describe-acount-attributes-1481753085663", "title": "Describe acount attributes" } ], "DescribeCertificates": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Certificates": [], "Marker": "" }, "comments": { "input": {}, "output": {} }, "description": "Provides a description of the certificate.", "id": "describe-certificates-1481753186244", "title": "Describe certificates" } ], "DescribeConnections": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Connections": [ { "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "EndpointIdentifier": "testsrc1", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationInstanceIdentifier": "test", "Status": "successful" } ], "Marker": "" }, "comments": { "input": {}, "output": {} }, "description": "Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.", "id": "describe-connections-1481754477953", "title": "Describe connections" } ], "DescribeConversionConfiguration": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\",\"EnableGenAiConversion\":false},\"MSSQL_TO_AURORA_POSTGRESQL\":{\"ConvertProceduresToFunction\":true,\"UniqueIndexGeneration\":true,\"CaseSensitivityNames\":false},\"Conversion version\":{\"MSSQL_TO_AURORA_POSTGRESQL_target_engine_version\":\"15\"}}", "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the conversion configuration for a migration project.", "id": "describe-conversion-configuration-1689717690907", "title": "Retrieving conversion configuration for a migration project" } ], "DescribeDataProviders": [ { "input": { "Filters": [ { "Name": "data-provider-identifier", "Values": [ "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS" ] } ] }, "output": { "DataProviders": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderCreationTime": "2026-01-09T12:30:00.000000Z", "DataProviderName": "example-data-provider", "Description": "Example data provider for documentation", "Engine": "sqlserver", "Settings": { "MicrosoftSqlServerSettings": { "CertificateArn": "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS", "DatabaseName": "ExampleDatabase", "Port": 1433, "ServerName": "example-source-server.us-east-1.rds.amazonaws.com", "SslMode": "verify-full" } } } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the details of a data provider identified by its ARN.", "id": "describe-data-providers-1689725897156", "title": "Describe data providers with a filter" } ], "DescribeEndpointTypes": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Marker": "", "SupportedEndpointTypes": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns information about the type of endpoints available.", "id": "describe-endpoint-types-1481754742591", "title": "Describe endpoint types" } ], "DescribeEndpoints": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Endpoints": [], "Marker": "" }, "comments": { "input": {}, "output": {} }, "description": "Returns information about the endpoints for your account in the current region.", "id": "describe-endpoints-1481754926060", "title": "Describe endpoints" } ], "DescribeExtensionPackAssociations": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Progress": { "ProgressPercent": 50.0, "ProgressStep": "IN_PROGRESS" }, "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "The database user in your target secret does not have sufficient privileges. Grant the required privileges and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of operations that apply an extension pack to the target database, identified by their request IDs.", "id": "describe-extension-pack-associations-1689718322580", "title": "Retrieve the status of extension pack associations" } ], "DescribeInstanceProfiles": [ { "input": { "Filters": [ { "Name": "instance-profile-identifier", "Values": [ "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS" ] } ] }, "output": { "InstanceProfiles": [ { "Description": "Example instance profile for documentation", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000Z", "InstanceProfileName": "example-instance-profile", "KmsKeyArn": "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "NetworkType": "IPV4", "PubliclyAccessible": false, "SubnetGroupIdentifier": "example-replication-subnet-group", "VpcSecurityGroups": [ "sg-0123456789abcdef0" ] } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the details of an instance profile identified by its ARN.", "id": "describe-instance-profiles-1689718406840", "title": "Describe instance profiles with a filter" } ], "DescribeMetadataModel": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Origin": "SOURCE", "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\", \"table-name\": \"ExampleTable\"}, \"rule-action\": \"explicit\"}]}" }, "output": { "Definition": "CREATE TABLE ExampleTable (ExampleColumn INTEGER NOT NULL);", "MetadataModelName": "ExampleTable", "MetadataModelType": "table", "TargetMetadataModels": [ { "MetadataModelName": "exampletable", "SelectionRules": "{\"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\": \"exampleschema\", \"table-name\": \"exampletable\"}, \"rule-action\": \"explicit\"}]}" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves detailed information about the ExampleTable table in the ExampleSchema schema from the source metadata tree, including its SQL definition and references to the corresponding converted metadata models in the target database.", "id": "describe-metadata-model-1716000000000", "title": "Retrieve a source table metadata model" } ], "DescribeMetadataModelAssessments": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Progress": { "ProcessedObject": { "EndpointType": "SOURCE", "Name": "ExampleTable", "Type": "table" }, "ProgressPercent": 50.0, "ProgressStep": "ANALYZING", "TotalObjects": 100 }, "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of metadata model assessment operations identified by their request IDs.", "id": "describe-metadata-model-assessments-1689718702303", "title": "Retrieve the status of metadata model assessments" } ], "DescribeMetadataModelChildren": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Origin": "SOURCE", "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\"}]}" }, "output": { "MetadataModelChildren": [ { "MetadataModelName": "Tables", "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\", \"category-name\": \"Tables\"}, \"rule-action\": \"explicit\"}]}" }, { "MetadataModelName": "Views", "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"2\", \"rule-name\": \"2\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"schema-name\": \"ExampleSchema\", \"category-name\": \"Views\"}, \"rule-action\": \"explicit\"}]}" }, { "MetadataModelName": "Functions", "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"3\", \"rule-name\": \"3\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"schema-name\": \"ExampleSchema\", \"category-name\": \"Functions\"}, \"rule-action\": \"explicit\"}]}" }, { "MetadataModelName": "Sequences", "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"4\", \"rule-name\": \"4\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"schema-name\": \"ExampleSchema\", \"category-name\": \"Sequences\"}, \"rule-action\": \"explicit\"}]}" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the child metadata models of the ExampleSchema schema from the source metadata tree.", "id": "describe-metadata-model-children-1716000000000", "title": "Retrieve children of a schema" } ], "DescribeMetadataModelConversions": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Progress": { "ProcessedObject": { "EndpointType": "SOURCE", "Name": "ExampleTable", "Type": "table" }, "ProgressPercent": 50.0, "ProgressStep": "CONVERTING", "TotalObjects": 100 }, "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of metadata model conversion operations identified by their request IDs.", "id": "describe-metadata-model-conversions-1689719021495", "title": "Retrieve the status of metadata model conversions" } ], "DescribeMetadataModelCreations": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of metadata model creation operations identified by their request IDs.", "id": "describe-metadata-model-creations-1689719900000", "title": "Retrieve the status of metadata model creations" } ], "DescribeMetadataModelExportsAsScript": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "ExportSqlDetails": { "ObjectURL": "https://amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com/example-migration-project/ExampleScript.zip", "S3ObjectKey": "s3://amzn-s3-demo-bucket/example-migration-project/ExampleScript.zip" }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Progress": { "ProcessedObject": { "EndpointType": "TARGET" }, "ProgressPercent": 50.0, "ProgressStep": "IN_PROGRESS", "TotalObjects": 100 }, "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of operations that export metadata models as data definition language (DDL) scripts, identified by their request IDs.", "id": "describe-metadata-model-exports-as-script-1689719253938", "title": "Retrieve the status of metadata model exports as script" } ], "DescribeMetadataModelExportsToTarget": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Progress": { "ProcessedObject": { "EndpointType": "TARGET" }, "ProgressPercent": 50.0, "ProgressStep": "APPLYING", "TotalObjects": 100 }, "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of operations that export converted metadata models to the target database, identified by their request IDs.", "id": "describe-metadata-model-exports-to-target-1689719484750", "title": "Retrieve the status of metadata model exports to target" } ], "DescribeMetadataModelImports": [ { "input": { "Filters": [ { "Name": "request-id", "Values": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ], "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "Requests": [ { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "SUCCESS" }, { "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Progress": { "ProcessedObject": { "EndpointType": "SOURCE" }, "ProgressPercent": 50.0, "ProgressStep": "IN_PROGRESS", "TotalObjects": 100 }, "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Status": "IN_PROGRESS" }, { "Error": { "defaultErrorDetails": { "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again." } }, "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Status": "FAILED" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the status of metadata import operations identified by their request IDs.", "id": "describe-metadata-model-imports-1689719771322", "title": "Retrieve the status of metadata model imports" } ], "DescribeMigrationProjects": [ { "input": { "Filters": [ { "Name": "migration-project-identifier", "Values": [ "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" ] } ] }, "output": { "MigrationProjects": [ { "Description": "Example migration project for documentation", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileName": "example-instance-profile", "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000Z", "MigrationProjectName": "example-migration-project", "SchemaConversionApplicationAttributes": { "S3BucketPath": "s3://amzn-s3-demo-bucket", "S3BucketRoleArn": "arn:aws:iam::111122223333:role/example-s3-access-role" }, "SourceDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3" } ], "TargetDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3" } ], "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}" } ] }, "comments": { "input": {}, "output": {} }, "description": "The following example retrieves the details of a migration project identified by its ARN.", "id": "describe-migration-projects-1689719912075", "title": "Describe migration projects with a filter" } ], "DescribeOrderableReplicationInstances": [ { "input": { "Marker": "", "MaxRecords": 123 }, "output": { "Marker": "", "OrderableReplicationInstances": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns information about the replication instance types that can be created in the specified region.", "id": "describe-orderable-replication-instances-1481755123669", "title": "Describe orderable replication instances" } ], "DescribeRefreshSchemasStatus": [ { "input": { "EndpointArn": "" }, "output": { "RefreshSchemasStatus": {} }, "comments": { "input": {}, "output": {} }, "description": "Returns the status of the refresh-schemas operation.", "id": "describe-refresh-schema-status-1481755303497", "title": "Describe refresh schema status" } ], "DescribeReplicationInstances": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Marker": "", "ReplicationInstances": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns the status of the refresh-schemas operation.", "id": "describe-replication-instances-1481755443952", "title": "Describe replication instances" } ], "DescribeReplicationSubnetGroups": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Marker": "", "ReplicationSubnetGroups": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns information about the replication subnet groups.", "id": "describe-replication-subnet-groups-1481755621284", "title": "Describe replication subnet groups" } ], "DescribeReplicationTasks": [ { "input": { "Filters": [ { "Name": "string", "Values": [ "string", "string" ] } ], "Marker": "", "MaxRecords": 123 }, "output": { "Marker": "", "ReplicationTasks": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns information about replication tasks for your account in the current region.", "id": "describe-replication-tasks-1481755777563", "title": "Describe replication tasks" } ], "DescribeSchemas": [ { "input": { "EndpointArn": "", "Marker": "", "MaxRecords": 123 }, "output": { "Marker": "", "Schemas": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns information about the schema for the specified endpoint.", "id": "describe-schemas-1481755933924", "title": "Describe schemas" } ], "DescribeTableStatistics": [ { "input": { "Marker": "", "MaxRecords": 123, "ReplicationTaskArn": "" }, "output": { "Marker": "", "ReplicationTaskArn": "", "TableStatistics": [] }, "comments": { "input": {}, "output": {} }, "description": "Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.", "id": "describe-table-statistics-1481756071890", "title": "Describe table statistics" } ], "ExportMetadataModelAssessment": [ { "input": { "AssessmentReportTypes": [ "pdf", "csv" ], "FileName": "example-assessment-report", "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "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\"}]}" }, "output": { "CsvReport": { "ObjectURL": "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.zip", "S3ObjectKey": "example-migration-project/example-assessment-report.zip" }, "PdfReport": { "ObjectURL": "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.pdf", "S3ObjectKey": "example-migration-project/example-assessment-report.pdf" } }, "comments": { "input": {}, "output": {} }, "description": "The following example exports a conversion assessment report for all objects in the ExampleSchema schema.", "id": "export-metadata-model-assessment-1689720309558", "title": "Export a conversion assessment report" } ], "GetTargetSelectionRules": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "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\"}]}" }, "output": { "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\"}]}" }, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "get-target-selection-rules-1716000000000", "title": "Convert source selection rules to target selection rules" } ], "ImportCertificate": [ { "input": { "CertificateIdentifier": "", "CertificatePem": "" }, "output": { "Certificate": {} }, "comments": { "input": {}, "output": {} }, "description": "Uploads the specified certificate.", "id": "import-certificate-1481756197206", "title": "Import certificate" } ], "ListTagsForResource": [ { "input": { "ResourceArn": "" }, "output": { "TagList": [] }, "comments": { "input": {}, "output": {} }, "description": "Lists all tags for an AWS DMS resource.", "id": "list-tags-for-resource-1481761095501", "title": "List tags for resource" } ], "ModifyConversionConfiguration": [ { "input": { "ConversionConfiguration": "{\"Common project settings\":{\"EnableGenAiConversion\":true},\"MSSQL_TO_AURORA_POSTGRESQL\":{\"ConvertProceduresToFunction\":false}}", "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "comments": { "input": {}, "output": {} }, "description": "The following example enables generative AI assisted conversion and updates a conversion pair setting for a migration project.", "id": "modify-conversion-configuration-1689720529855", "title": "Modifying conversion configuration for a migration project" } ], "ModifyDataProvider": [ { "input": { "DataProviderIdentifier": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "Description": "Updated data provider description", "Engine": "sqlserver", "Settings": { "MicrosoftSqlServerSettings": { "ServerName": "new-source-server.us-east-1.rds.amazonaws.com" } } }, "output": { "DataProvider": { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderCreationTime": "2026-01-09T12:30:00.000000Z", "DataProviderName": "example-data-provider", "Description": "Updated data provider description", "Engine": "sqlserver", "Settings": { "MicrosoftSqlServerSettings": { "CertificateArn": "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS", "DatabaseName": "ExampleDatabase", "Port": 1433, "ServerName": "new-source-server.us-east-1.rds.amazonaws.com", "SslMode": "verify-full" } } } }, "comments": { "input": {}, "output": {} }, "description": "The following example updates the description and server name of a data provider.", "id": "modify-data-provider-1689720700567", "title": "Modify a data provider" } ], "ModifyEndpoint": [ { "input": { "CertificateArn": "", "DatabaseName": "", "EndpointArn": "", "EndpointIdentifier": "", "EndpointType": "source", "EngineName": "", "ExtraConnectionAttributes": "", "Password": "", "Port": 123, "ServerName": "", "SslMode": "require", "Username": "" }, "output": { "Endpoint": {} }, "comments": { "input": {}, "output": {} }, "description": "Modifies the specified endpoint.", "id": "modify-endpoint-1481761649937", "title": "Modify endpoint" } ], "ModifyInstanceProfile": [ { "input": { "Description": "Updated instance profile description", "InstanceProfileIdentifier": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "NetworkType": "DUAL" }, "output": { "InstanceProfile": { "Description": "Updated instance profile description", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000Z", "InstanceProfileName": "example-instance-profile", "KmsKeyArn": "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "NetworkType": "DUAL", "PubliclyAccessible": false, "SubnetGroupIdentifier": "example-replication-subnet-group", "VpcSecurityGroups": [ "sg-0123456789abcdef0" ] } }, "comments": { "input": {}, "output": {} }, "description": "The following example updates the description and network type of an instance profile.", "id": "modify-instance-profile-1689724223329", "title": "Modify an instance profile" } ], "ModifyMigrationProject": [ { "input": { "Description": "Updated migration project description", "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "SourceDataProviderDescriptors": [ { "DataProviderIdentifier": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS" } ] }, "output": { "MigrationProject": { "Description": "Updated migration project description", "InstanceProfileArn": "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS", "InstanceProfileName": "example-instance-profile", "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000Z", "MigrationProjectName": "example-migration-project", "SchemaConversionApplicationAttributes": { "S3BucketPath": "s3://amzn-s3-demo-bucket", "S3BucketRoleArn": "arn:aws:iam::111122223333:role/example-s3-access-role" }, "SourceDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3" } ], "TargetDataProviderDescriptors": [ { "DataProviderArn": "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS", "DataProviderName": "example-data-provider", "SecretsManagerAccessRoleArn": "arn:aws:iam::111122223333:role/example-secrets-manager-role", "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3" } ], "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}" } }, "comments": { "input": {}, "output": {} }, "description": "The following example updates the source data provider and description of a migration project.", "id": "modify-migration-project-1689721117475", "title": "Modify a migration project" } ], "ModifyReplicationInstance": [ { "input": { "AllocatedStorage": 123, "AllowMajorVersionUpgrade": true, "ApplyImmediately": true, "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "MultiAZ": true, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceIdentifier": "test-rep-1", "VpcSecurityGroupIds": [] }, "output": { "ReplicationInstance": { "AllocatedStorage": 5, "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "PubliclyAccessible": true, "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceIdentifier": "test-rep-1", "ReplicationInstanceStatus": "available", "ReplicationSubnetGroup": { "ReplicationSubnetGroupDescription": "default", "ReplicationSubnetGroupIdentifier": "default", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetAvailabilityZone": { "Name": "us-east-1d" }, "SubnetIdentifier": "subnet-f6dd91af", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1b" }, "SubnetIdentifier": "subnet-3605751d", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetIdentifier": "subnet-c2daefb5", "SubnetStatus": "Active" }, { "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetIdentifier": "subnet-85e90cb8", "SubnetStatus": "Active" } ], "VpcId": "vpc-6741a603" } } }, "comments": { "output": {} }, "description": "Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.", "id": "modify-replication-instance-1481761784746", "title": "Modify replication instance" } ], "ModifyReplicationSubnetGroup": [ { "input": { "ReplicationSubnetGroupDescription": "", "ReplicationSubnetGroupIdentifier": "", "SubnetIds": [] }, "output": { "ReplicationSubnetGroup": {} }, "comments": { "input": {}, "output": {} }, "description": "Modifies the settings for the specified replication subnet group.", "id": "modify-replication-subnet-group-1481762275392", "title": "Modify replication subnet group" } ], "RefreshSchemas": [ { "input": { "EndpointArn": "", "ReplicationInstanceArn": "" }, "output": { "RefreshSchemasStatus": {} }, "comments": { "input": {}, "output": {} }, "description": "Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.", "id": "refresh-schema-1481762399111", "title": "Refresh schema" } ], "RemoveTagsFromResource": [ { "input": { "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", "TagKeys": [] }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "Removes metadata tags from an AWS DMS resource.", "id": "remove-tags-from-resource-1481762571330", "title": "Remove tags from resource" } ], "StartExtensionPackAssociation": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues the installation of the extension pack on the target database.", "id": "start-extension-pack-association-1689721897266", "title": "Install the extension pack on the target database" } ], "StartMetadataModelAssessment": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "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\"}]}" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues an assessment of the conversion complexity for all objects in the ExampleSchema schema.", "id": "start-metadata-model-assessment-1689722322596", "title": "Assess all objects in a schema" } ], "StartMetadataModelConversion": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "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\"}]}" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues a conversion of all objects in the ExampleSchema schema to the target database format.", "id": "start-metadata-model-conversion-1689722427798", "title": "Convert all objects in a schema" } ], "StartMetadataModelCreation": [ { "input": { "MetadataModelName": "ExampleStatement", "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Properties": { "StatementProperties": { "Definition": "SELECT * FROM ExampleTable;" } }, "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\"}, \"rule-action\": \"explicit\"}]}" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues the creation of a metadata model for a SQL statement. The selection rule specifies the schema where the metadata model is placed, and MetadataModelName provides a unique identifier for use in subsequent operations.", "id": "start-metadata-model-creation-1689722322596", "title": "Create a metadata model for a SQL statement" } ], "StartMetadataModelExportAsScript": [ { "input": { "FileName": "ExampleScript", "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Origin": "TARGET", "SelectionRules": "{\"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\": \"ExampleSchema\"},\"rule-action\": \"explicit\"}]}" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues an export of converted metadata models for all objects in the ExampleSchema schema as data definition language (DDL) scripts to the S3 bucket associated with the migration project.", "id": "start-metadata-model-export-as-script-1689722681469", "title": "Export converted metadata models as DDL scripts" } ], "StartMetadataModelExportToTarget": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "OverwriteExtensionPack": true, "SelectionRules": "{\"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\": \"ExampleSchema\"},\"rule-action\": \"explicit\"}]}" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues an export of converted metadata models for all objects in the ExampleSchema schema to the target database.", "id": "start-metadata-model-export-to-target-1689783666835", "title": "Export converted metadata models to the target database" } ], "StartMetadataModelImport": [ { "input": { "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS", "Origin": "SOURCE", "Refresh": false, "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\"}]}" }, "output": { "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "comments": { "input": {}, "output": {} }, "description": "The following example queues a metadata import for all objects in the ExampleSchema schema from the source database.", "id": "start-metadata-model-import-1689723124259", "title": "Import metadata from the source database" } ], "StartReplicationTask": [ { "input": { "CdcStartTime": "2016-12-14T13:33:20Z", "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "StartReplicationTaskType": "start-replication" }, "output": { "ReplicationTask": { "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", "ReplicationTaskIdentifier": "task1", "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "Status": "creating", "TableMappings": "file://mappingfile.json", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" } }, "comments": { "input": {}, "output": {} }, "description": "Starts the replication task.", "id": "start-replication-task-1481762706778", "title": "Start replication task" } ], "StopReplicationTask": [ { "input": { "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" }, "output": { "ReplicationTask": { "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", "ReplicationTaskIdentifier": "task1", "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "Status": "creating", "TableMappings": "file://mappingfile.json", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" } }, "comments": { "input": {}, "output": {} }, "description": "Stops the replication task.", "id": "stop-replication-task-1481762924947", "title": "Stop replication task" } ], "TestConnection": [ { "input": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" }, "output": { "Connection": {} }, "comments": { "input": {}, "output": {} }, "description": "Tests the connection between the replication instance and the endpoint.", "id": "test-conection-1481763017636", "title": "Test conection" } ] } }