AWS DMS 使用的範例 AWS CLI

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配來執行動作和實作常見案例 AWS DMS。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。

主題

動作

動作

以下程式碼範例顯示如何使用 add-tags-to-resource。

AWS CLI

將標籤新增至資源

以下 add-tags-to-resource 範例會新增標籤至複寫執行個體。


aws dms add-tags-to-resource \
    --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
    --tags Key=Environment,Value=PROD Key=Project,Value=dbMigration

此命令不會產生輸出。

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的標記資源。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 AddTagsToResource。

以下程式碼範例顯示如何使用 cancel-metadata-model-conversion。

AWS CLI

取消中繼資料模型轉換

下列cancel-metadata-model-conversion範例會取消中繼資料模型轉換操作。


aws dms cancel-metadata-model-conversion \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --request-identifier a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

輸出：


{
    "Request": {
        "Status": "CANCELING",
        "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
    }
}

如需詳細資訊，請參閱《資料庫遷移服務使用者指南》中的轉換資料庫結構描述。 AWS

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 CancelMetadataModelConversion。

以下程式碼範例顯示如何使用 cancel-metadata-model-creation。

AWS CLI

取消中繼資料模型建立

下列cancel-metadata-model-creation範例會取消中繼資料模型建立操作。


aws dms cancel-metadata-model-creation \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --request-identifier a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

輸出：


{
    "Request": {
        "Status": "CANCELING",
        "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的建立陳述式中繼資料模型。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 CancelMetadataModelCreation。

以下程式碼範例顯示如何使用 create-data-provider。

AWS CLI

範例 1：建立 Microsoft SQL Server 資料提供者

下列create-data-provider範例會建立 Microsoft SQL Server 資料提供者。


aws dms create-data-provider \
    --data-provider-name example-data-provider \
    --engine sqlserver \
    --description "Example data provider for documentation" \
    --settings MicrosoftSqlServerSettings={ServerName=example-source-server.us-east-1.rds.amazonaws.com,Port=1433,DatabaseName=ExampleDatabase,SslMode=verify-full,CertificateArn=arn:aws:dms:us-east-1:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS}

輸出：


{
    "DataProvider": {
        "DataProviderName": "example-data-provider",
        "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "Description": "Example data provider for documentation",
        "Engine": "sqlserver",
        "Settings": {
            "MicrosoftSqlServerSettings": {
                "ServerName": "example-source-server.us-east-1.rds.amazonaws.com",
                "Port": 1433,
                "DatabaseName": "ExampleDatabase",
                "SslMode": "verify-full",
                "CertificateArn": "arn:aws:dms:us-east-1:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用資料提供者。

範例 2：建立虛擬資料提供者

下列create-data-provider範例會建立虛擬資料提供者，而不需要與資料庫的連線。


aws dms create-data-provider \
    --data-provider-name example-virtual-data-provider \
    --engine aurora-postgresql \
    --description "Example data provider for documentation" \
    --virtual \
    --settings PostgreSqlSettings={ServerName=virtual,Port=5432,DatabaseName=virtual,SslMode=none}

輸出：


{
    "DataProvider": {
        "DataProviderName": "example-virtual-data-provider",
        "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "Description": "Example data provider for documentation",
        "Engine": "aurora-postgresql",
        "Virtual": true,
        "Settings": {
            "PostgreSqlSettings": {
                "ServerName": "virtual",
                "Port": 5432,
                "DatabaseName": "virtual",
                "SslMode": "none"
            }
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用虛擬資料提供者。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 CreateDataProvider。

以下程式碼範例顯示如何使用 create-endpoint。

AWS CLI

建立端點

下列 create-endpoint 範例會建立 Amazon S3 來源的端點。


aws dms create-endpoint \
    --endpoint-type source \
    --engine-name s3 \
    --endpoint-identifier src-endpoint \
    --s3-settings file://s3-settings.json

s3-settings.json 的內容：


{
    "BucketName":"my-corp-data",
    "BucketFolder":"sourcedata",
    "ServiceAccessRoleArn":"arn:aws:iam::123456789012:role/my-s3-access-role"
}

輸出：


{
    "Endpoint": {
        "EndpointIdentifier": "src-endpoint",
        "EndpointType": "SOURCE",
        "EngineName": "s3",
        "EngineDisplayName": "Amazon S3",
        "ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;",
        "Status": "active",
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U",
        "SslMode": "none",
        "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
        "S3Settings": {
            "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
            "CsvRowDelimiter": "\\n",
            "CsvDelimiter": ",",
            "BucketFolder": "sourcedata",
            "BucketName": "my-corp-data",
            "CompressionType": "NONE",
            "EnableStatistics": true
        }
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 端點。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateEndpoint。

以下程式碼範例顯示如何使用 create-event-subscription。

AWS CLI

列出事件訂閱

下列 create-event-subscription 範例會建立 Amazon SNS 主題 (my-sns-topic) 的事件訂閱。


aws dms create-event-subscription \
    --subscription-name my-dms-events \
    --sns-topic-arn arn:aws:sns:us-east-1:123456789012:my-sns-topic

輸出：


{
    "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "my-dms-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
        "Status": "creating",
        "SubscriptionCreationTime": "2020-05-21 21:58:38.598",
        "Enabled": true
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用事件和通知。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateEventSubscription。

以下程式碼範例顯示如何使用 create-instance-profile。

AWS CLI

建立執行個體設定檔

下列create-instance-profile範例會建立執行個體描述檔。


aws dms create-instance-profile \
    --instance-profile-name example-instance-profile \
    --description "Example instance profile for documentation" \
    --subnet-group-identifier example-replication-subnet-group \
    --vpc-security-groups "sg-0123456789abcdef0" \
    --kms-key-arn arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --network-type IPV4 \
    --no-publicly-accessible

輸出：


{
    "InstanceProfile": {
        "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "KmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "PubliclyAccessible": false,
        "NetworkType": "IPV4",
        "InstanceProfileName": "example-instance-profile",
        "Description": "Example instance profile for documentation",
        "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "SubnetGroupIdentifier": "example-replication-subnet-group",
        "VpcSecurityGroups": [
            "sg-0123456789abcdef0"
        ]
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用執行個體描述檔。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateInstanceProfile。

以下程式碼範例顯示如何使用 create-migration-project。

AWS CLI

建立遷移專案

下列create-migration-project範例會建立遷移專案。


aws dms create-migration-project \
    --migration-project-name example-migration-project \
    --description "Example migration project for documentation" \
    --source-data-provider-descriptors DataProviderIdentifier=arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS,SecretsManagerSecretId=arn:aws:secretsmanager:us-east-1:123456789012:secret:example-source-secret-A1B2C3,SecretsManagerAccessRoleArn=arn:aws:iam::123456789012:role/example-secrets-manager-role \
    --target-data-provider-descriptors DataProviderIdentifier=arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS,SecretsManagerSecretId=arn:aws:secretsmanager:us-east-1:123456789012:secret:example-target-secret-A1B2C3,SecretsManagerAccessRoleArn=arn:aws:iam::123456789012:role/example-secrets-manager-role \
    --instance-profile-identifier arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --transformation-rules '{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}' \
    --schema-conversion-application-attributes S3BucketPath=s3://amzn-s3-demo-bucket,S3BucketRoleArn=arn:aws:iam::123456789012:role/example-s3-access-role

輸出：


{
    "MigrationProject": {
        "MigrationProjectName": "example-migration-project",
        "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "SourceDataProviderDescriptors": [
            {
                "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-source-secret-A1B2C3",
                "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                "DataProviderName": "example-data-provider",
                "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        ],
        "TargetDataProviderDescriptors": [
            {
                "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-target-secret-A1B2C3",
                "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                "DataProviderName": "example-data-provider",
                "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        ],
        "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "InstanceProfileName": "example-instance-profile",
        "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
        "Description": "Example migration project for documentation",
        "SchemaConversionApplicationAttributes": {
            "S3BucketPath": "s3://amzn-s3-demo-bucket",
            "S3BucketRoleArn": "arn:aws:iam::123456789012:role/example-s3-access-role"
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用遷移專案。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 CreateMigrationProject。

以下程式碼範例顯示如何使用 create-replication-instance。

AWS CLI

建立複寫執行個體

以下 create-replication-instance 範例會建立複寫執行個體。


aws dms create-replication-instance \
    --replication-instance-identifier my-repl-instance \
    --replication-instance-class dms.t2.micro \
    --allocated-storage 5

輸出：


{
    "ReplicationInstance": {
        "ReplicationInstanceIdentifier": "my-repl-instance",
        "ReplicationInstanceClass": "dms.t2.micro",
        "ReplicationInstanceStatus": "creating",
        "AllocatedStorage": 5,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-f839b688",
                "Status": "active"
            }
        ],
        "ReplicationSubnetGroup": {
            "ReplicationSubnetGroupIdentifier": "default",
            "ReplicationSubnetGroupDescription": "default",
            "VpcId": "vpc-136a4c6a",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-da327bf6",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-42599426",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1d"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-bac383e0",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-6746046b",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1f"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-d7c825e8",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1e"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-cbfff283",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1b"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "sat:12:35-sat:13:05",
        "PendingModifiedValues": {},
        "MultiAZ": false,
        "EngineVersion": "3.3.2",
        "AutoMinorVersionUpgrade": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:ZK2VQBUWFDBAWHIXHAYG5G2PKY",
        "PubliclyAccessible": true
    }
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 複寫執行個體。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateReplicationInstance。

以下程式碼範例顯示如何使用 create-replication-subnet-group。

AWS CLI

建立子網路群組

下列 create-replication-subnet-group 範例會建立由 3 個子網路組成的群組。


aws dms create-replication-subnet-group \
    --replication-subnet-group-identifier my-subnet-group \
    --replication-subnet-group-description "my subnet group" \
    --subnet-ids subnet-da327bf6 subnet-bac383e0 subnet-d7c825e8

輸出：


{
    "ReplicationSubnetGroup": {
        "ReplicationSubnetGroupIdentifier": "my-subnet-group",
        "ReplicationSubnetGroupDescription": "my subnet group",
        "VpcId": "vpc-136a4c6a",
        "SubnetGroupStatus": "Complete",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-da327bf6",
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1a"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-bac383e0",
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1c"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-d7c825e8",
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1e"
                },
                "SubnetStatus": "Active"
            }
        ]
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的設定複寫執行個體的網路。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateReplicationSubnetGroup。

以下程式碼範例顯示如何使用 create-replication-task。

AWS CLI

建立複寫任務

下列 create-replication-task 範例會建立複寫任務。


aws dms create-replication-task \
    --replication-task-identifier movedata \
    --source-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \
    --target-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U \
    --replication-instance-arn $RI_ARN \
    --migration-type full-load \
    --table-mappings file://table-mappings.json

table-mappings.json 的內容：


{
    "rules": [
        {
            "rule-type": "selection",
            "rule-id": "1",
            "rule-name": "1",
            "object-locator": {
                "schema-name": "prodrep",
                "table-name": "%"
            },
            "rule-action": "include",
            "filters": []
        }
    ]
}

輸出：


{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted... ,
        "ReplicationTaskSettings": ...output omitted... ,
        "Status": "creating",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 任務。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateReplicationTask。

以下程式碼範例顯示如何使用 delete-connection。

AWS CLI

刪除連線

下列 delete-connection 範例會取消端點與複寫執行個體的關聯。


aws dms delete-connection \
    --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \
    --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE

輸出：


{
    "Connection": {
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "Status": "deleting",
        "EndpointIdentifier": "src-database-1",
        "ReplicationInstanceIdentifier": "my-repl-instance"
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的 https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteConnection。

以下程式碼範例顯示如何使用 delete-data-provider。

AWS CLI

刪除資料提供者

下列delete-data-provider範例會刪除由其 ARN 識別的資料提供者。


aws dms delete-data-provider \
    --data-provider-identifier arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "DataProvider": {
        "DataProviderName": "example-data-provider",
        "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "Description": "Example data provider for documentation",
        "Engine": "sqlserver",
        "Settings": {
            "MicrosoftSqlServerSettings": {
                "ServerName": "example-source-server.us-east-1.rds.amazonaws.com",
                "Port": 1433,
                "DatabaseName": "ExampleDatabase",
                "SslMode": "verify-full",
                "CertificateArn": "arn:aws:dms:us-east-1:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用資料提供者。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DeleteDataProvider。

以下程式碼範例顯示如何使用 delete-endpoint。

AWS CLI

刪除端點

下列 delete-endpoint 範例會刪除端點。


aws dms delete-endpoint \
    --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y

輸出：


{
    "Endpoint": {
        "EndpointIdentifier": "src-endpoint",
        "EndpointType": "SOURCE",
        "EngineName": "s3",
        "EngineDisplayName": "Amazon S3",
        "ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;",
        "Status": "deleting",
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y",
        "SslMode": "none",
        "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
        "S3Settings": {
            "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
            "CsvRowDelimiter": "\\n",
            "CsvDelimiter": ",",
            "BucketFolder": "sourcedata",
            "BucketName": "my-corp-data",
            "CompressionType": "NONE",
            "EnableStatistics": true
        }
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 端點。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteEndpoint。

以下程式碼範例顯示如何使用 delete-event-subscription。

AWS CLI

刪除事件訂閱

下列 delete-event-subscription 範例會刪除 Amazon SNS 主題的訂閱。


aws dms delete-event-subscription \
    --subscription-name "my-dms-events"

輸出：


{
    "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "my-dms-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
        "Status": "deleting",
        "SubscriptionCreationTime": "2020-05-21 21:58:38.598",
        "Enabled": true
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用事件和通知。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteEventSubscription。

以下程式碼範例顯示如何使用 delete-instance-profile。

AWS CLI

刪除執行個體設定檔

下列delete-instance-profile範例會刪除由其 ARN 識別的執行個體描述檔。


aws dms delete-instance-profile \
    --instance-profile-identifier arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "InstanceProfile": {
        "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "KmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "PubliclyAccessible": false,
        "NetworkType": "IPV4",
        "InstanceProfileName": "example-instance-profile",
        "Description": "Example instance profile for documentation",
        "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "SubnetGroupIdentifier": "example-replication-subnet-group",
        "VpcSecurityGroups": [
            "sg-0123456789abcdef0"
        ]
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用執行個體描述檔。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteInstanceProfile。

以下程式碼範例顯示如何使用 delete-migration-project。

AWS CLI

刪除遷移專案

下列delete-migration-project範例會刪除其 ARN 所識別的遷移專案。


aws dms delete-migration-project \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "MigrationProject": {
        "MigrationProjectName": "example-migration-project",
        "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "SourceDataProviderDescriptors": [
            {
                "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-source-secret-A1B2C3",
                "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                "DataProviderName": "example-data-provider",
                "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        ],
        "TargetDataProviderDescriptors": [
            {
                "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-target-secret-A1B2C3",
                "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                "DataProviderName": "example-data-provider",
                "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        ],
        "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "InstanceProfileName": "example-instance-profile",
        "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
        "Description": "Example migration project for documentation",
        "SchemaConversionApplicationAttributes": {
            "S3BucketPath": "s3://amzn-s3-demo-bucket",
            "S3BucketRoleArn": "arn:aws:iam::123456789012:role/example-s3-access-role"
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用遷移專案。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DeleteMigrationProject。

以下程式碼範例顯示如何使用 delete-replication-instance。

AWS CLI

刪除複寫執行個體

以下 delete-replication-instance 範例會刪除複寫執行個體。


aws dms delete-replication-instance \
    --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE

輸出：


{
    "ReplicationInstance": {
        "ReplicationInstanceIdentifier": "my-repl-instance",
        "ReplicationInstanceClass": "dms.t2.micro",
        "ReplicationInstanceStatus": "deleting",
        "AllocatedStorage": 5,
        "InstanceCreateTime": 1590011235.952,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-f839b688",
                "Status": "active"
            }
        ],
        "AvailabilityZone": "us-east-1e",
        "ReplicationSubnetGroup": {
            "ReplicationSubnetGroupIdentifier": "default",
            "ReplicationSubnetGroupDescription": "default",
            "VpcId": "vpc-136a4c6a",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-da327bf6",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-42599426",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1d"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-bac383e0",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-6746046b",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1f"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-d7c825e8",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1e"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-cbfff283",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1b"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "wed:11:42-wed:12:12",
        "PendingModifiedValues": {},
        "MultiAZ": true,
        "EngineVersion": "3.3.2",
        "AutoMinorVersionUpgrade": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "ReplicationInstancePublicIpAddress": "54.225.120.92",
        "ReplicationInstancePrivateIpAddress": "172.31.30.121",
        "ReplicationInstancePublicIpAddresses": [
            "54.225.120.92",
            "3.230.18.248"
        ],
        "ReplicationInstancePrivateIpAddresses": [
            "172.31.30.121",
            "172.31.75.90"
        ],
        "PubliclyAccessible": true,
        "SecondaryAvailabilityZone": "us-east-1b"
    }
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 複寫執行個體。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteReplicationInstance。

以下程式碼範例顯示如何使用 delete-replication-subnet-group。

AWS CLI

刪除子網路群組

以下 delete-replication-subnet-group 範例會刪除子網路群組。


aws dms delete-replication-subnet-group \
--replication-subnet-group-identifier my-subnet-group

輸出：


(none)

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的設定複寫執行個體的網路。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteReplicationSubnetGroup。

以下程式碼範例顯示如何使用 delete-replication-task。

AWS CLI

刪除複寫任務

以下 delete-replication-task 範例會刪除複寫任務。


aws dms delete-replication-task \
    --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII

輸出：


{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted...,
        "ReplicationTaskSettings": ...output omitted...,
        "Status": "deleting",
        "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskStartDate": 1590789988.677,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 任務。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteReplicationTask。

以下程式碼範例顯示如何使用 describe-account-attributes。

AWS CLI

描述帳戶屬性

下列describe-account-attributes範例列出您 AWS 帳戶的屬性。


aws dms describe-account-attributes

輸出：


{
    "AccountQuotas": [
        {
            "AccountQuotaName": "ReplicationInstances",
            "Used": 1,
            "Max": 20
        },
        {
            "AccountQuotaName": "AllocatedStorage",
            "Used": 5,
            "Max": 10000
        },

        ...remaining output omitted...

    ],
    "UniqueAccountIdentifier": "cqahfbfy5xee"
}

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeAccountAttributes。

以下程式碼範例顯示如何使用 describe-certificates。

AWS CLI

列出可用的憑證

下列describe-certificates範例列出您 AWS 帳戶中可用的憑證。


aws dms describe-certificates

輸出：


{
    "Certificates": [
        {
            "CertificateIdentifier": "my-cert",
            "CertificateCreationDate": 1543259542.506,
            "CertificatePem": "-----BEGIN CERTIFICATE-----\nMIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQ ...U"

            ... remaining output omittted ...

        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用 SSL。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeCertificates。

以下程式碼範例顯示如何使用 describe-connections。

AWS CLI

描述連線

下列 describe-connections 範例列出您在複寫執行個體和端點之間測試過的連線。


aws dms describe-connections

輸出：


{
    "Connections": [
        {
            "Status": "successful",
            "ReplicationInstanceIdentifier": "test",
            "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"
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的建立來源和目標端點。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeConnections。

以下程式碼範例顯示如何使用 describe-conversion-configuration。

AWS CLI

描述轉換組態

下列describe-conversion-configuration範例會擷取遷移專案的轉換組態。


aws dms describe-conversion-configuration \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "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\"}}"
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的指定結構描述轉換設定。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeConversionConfiguration。

以下程式碼範例顯示如何使用 describe-data-providers。

AWS CLI

描述資料提供者

下列describe-data-providers範例會擷取由其 ARN 識別的資料提供者詳細資訊。


aws dms describe-data-providers \
    --filters Name=data-provider-identifier,Values=arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "DataProviders": [
        {
            "DataProviderName": "example-data-provider",
            "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
            "Description": "Example data provider for documentation",
            "Engine": "sqlserver",
            "Settings": {
                "MicrosoftSqlServerSettings": {
                    "ServerName": "example-source-server.us-east-1.rds.amazonaws.com",
                    "Port": 1433,
                    "DatabaseName": "ExampleDatabase",
                    "SslMode": "verify-full",
                    "CertificateArn": "arn:aws:dms:us-east-1:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS"
                }
            }
        }
    ]
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用資料提供者。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeDataProviders。

以下程式碼範例顯示如何使用 describe-endpoint-types。

AWS CLI

列出可用的端點類型

下列 describe-endpoint-types 範例列出可用的 MySQL 端點類型。


aws dms describe-endpoint-types \
    --filters "Name=engine-name,Values=mysql"

輸出：


{
    "SupportedEndpointTypes": [
        {
            "EngineName": "mysql",
            "SupportsCDC": true,
            "EndpointType": "source",
            "EngineDisplayName": "MySQL"
        },
        {
            "EngineName": "mysql",
            "SupportsCDC": true,
            "EndpointType": "target",
            "EngineDisplayName": "MySQL"
        }
    ]
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 端點 <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html>`__。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeEndpointTypes。

以下程式碼範例顯示如何使用 describe-endpoints。

AWS CLI

描述端點

下列describe-endpoints範例列出您 AWS 帳戶中的端點。


aws dms describe-endpoints

輸出：


{
    "Endpoints": [
        {
            "Username": "dms",
            "Status": "active",
            "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:SF2WOFLWYWKVEOHID2EKLP3SJI",
            "ServerName": "ec2-52-32-48-61.us-west-2.compute.amazonaws.com",
            "EndpointType": "SOURCE",
            "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/94d5c4e7-4e4c-44be-b58a-c8da7adf57cd",
            "DatabaseName": "test",
            "EngineName": "mysql",
            "EndpointIdentifier": "pri100",
            "Port": 8193
        },
        {
            "Username": "admin",
            "Status": "active",
            "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:TJJZCIH3CJ24TJRU4VC32WEWFR",
            "ServerName": "test.example.com",
            "EndpointType": "SOURCE",
            "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/2431021b-1cf2-a2d4-77b2-59a9e4bce323",
            "DatabaseName": "EMPL",
            "EngineName": "oracle",
            "EndpointIdentifier": "test",
            "Port": 1521
        }
    ]
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 端點。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeEndpoints。

以下程式碼範例顯示如何使用 describe-event-categories。

AWS CLI

描述事件類別

下列 describe-event-categories 範例列出可用的事件類別。


aws dms describe-event-categories

輸出：


{
    "EventCategoryGroupList": [
        {
            "SourceType": "replication-instance",
            "EventCategories": [
                "low storage",
                "configuration change",
                "maintenance",
                "deletion",
                "creation",
                "failover",
                "failure"
            ]
        },
        {
            "SourceType": "replication-task",
            "EventCategories": [
                "configuration change",
                "state change",
                "deletion",
                "creation",
                "failure"
            ]
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用事件和通知。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeEventCategories。

以下程式碼範例顯示如何使用 describe-event-subscriptions。

AWS CLI

描述事件訂閱

下列 describe-event-subscriptions 範例列出 Amazon SNS 主題的事件訂閱。


aws dms describe-event-subscriptions

輸出：


{
    "EventSubscriptionsList": [
        {
            "CustomerAwsId": "123456789012",
            "CustSubscriptionId": "my-dms-events",
            "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
            "Status": "deleting",
            "SubscriptionCreationTime": "2020-05-21 22:28:51.924",
            "Enabled": true
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用事件和通知。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeEventSubscriptions。

以下程式碼範例顯示如何使用 describe-events。

AWS CLI

列出 DMS 事件

下列 describe-events 範例列出源自複寫執行個體的事件。


aws dms describe-events \
    --source-type "replication-instance"

輸出：


{
    "Events": [
        {
            "SourceIdentifier": "my-repl-instance",
            "SourceType": "replication-instance",
            "Message": "Replication application shutdown",
            "EventCategories": [],
            "Date": 1590771645.776
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用事件和通知。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeEvents。

以下程式碼範例顯示如何使用 describe-extension-pack-associations。

AWS CLI

描述延伸套件關聯

下列describe-extension-pack-associations範例會擷取將延伸套件套用至目標資料庫的操作狀態，並以其請求 IDs識別。


aws dms describe-extension-pack-associations \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "ProgressStep": "IN_PROGRESS"
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "The database user in your target secret does not have sufficient privileges. Grant the required privileges and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用延伸套件。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeExtensionPackAssociations。

以下程式碼範例顯示如何使用 describe-instance-profiles。

AWS CLI

描述執行個體描述檔

下列describe-instance-profiles範例會擷取其 ARN 所識別之執行個體描述檔的詳細資訊。


aws dms describe-instance-profiles \
    --filters Name=instance-profile-identifier,Values=arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "InstanceProfiles": [
        {
            "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "KmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "PubliclyAccessible": false,
            "NetworkType": "IPV4",
            "InstanceProfileName": "example-instance-profile",
            "Description": "Example instance profile for documentation",
            "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000+00:00",
            "SubnetGroupIdentifier": "example-replication-subnet-group",
            "VpcSecurityGroups": [
                "sg-0123456789abcdef0"
            ]
        }
    ]
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用執行個體描述檔。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeInstanceProfiles。

以下程式碼範例顯示如何使用 describe-metadata-model-assessments。

AWS CLI

描述中繼資料模型評估

下列describe-metadata-model-assessments範例會擷取其請求 IDs所識別的中繼資料模型評估操作狀態。


aws dms describe-metadata-model-assessments \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "TotalObjects": 100,
                "ProgressStep": "ANALYZING",
                "ProcessedObject": {
                    "Name": "ExampleTable",
                    "Type": "table",
                    "EndpointType": "SOURCE"
                }
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱《資料庫遷移服務使用者指南》中的建立資料庫遷移評估報告。 AWS

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelAssessments。

以下程式碼範例顯示如何使用 describe-metadata-model-children。

AWS CLI

描述中繼資料模型子系

下列describe-metadata-model-children範例會從來源中繼資料樹狀目錄擷取ExampleSchema結構描述的子中繼資料模型。


aws dms describe-metadata-model-children \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --origin SOURCE

輸出：


{
    "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\"}]}"
        }
    ]
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的導覽中繼資料模型樹。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelChildren。

以下程式碼範例顯示如何使用 describe-metadata-model-conversions。

AWS CLI

描述中繼資料模型轉換

下列describe-metadata-model-conversions範例會擷取其請求 IDs所識別的中繼資料模型轉換操作狀態。


aws dms describe-metadata-model-conversions \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "TotalObjects": 100,
                "ProgressStep": "CONVERTING",
                "ProcessedObject": {
                    "Name": "ExampleTable",
                    "Type": "table",
                    "EndpointType": "SOURCE"
                }
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱《資料庫遷移服務使用者指南》中的轉換資料庫結構描述。 AWS

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelConversions。

以下程式碼範例顯示如何使用 describe-metadata-model-creations。

AWS CLI

描述中繼資料模型建立

下列describe-metadata-model-creations範例會擷取其請求 IDs所識別的中繼資料模型建立操作狀態。


aws dms describe-metadata-model-creations \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的建立陳述式中繼資料模型。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelCreations。

以下程式碼範例顯示如何使用 describe-metadata-model-exports-as-script。

AWS CLI

將中繼資料模型匯出描述為指令碼

下列describe-metadata-model-exports-as-script範例會擷取將中繼資料模型匯出為資料定義語言 (DDL) 指令碼的操作狀態，並以其請求 IDs識別。


aws dms describe-metadata-model-exports-as-script \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "ExportSqlDetails": {
                "S3ObjectKey": "s3://amzn-s3-demo-bucket/example-migration-project/ExampleScript.zip",
                "ObjectURL": "https://amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com/example-migration-project/ExampleScript.zip"
            }
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "TotalObjects": 100,
                "ProgressStep": "IN_PROGRESS",
                "ProcessedObject": {
                    "EndpointType": "TARGET"
                }
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的將轉換後的程式碼儲存至 SQL 檔案。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelExportsAsScript。

以下程式碼範例顯示如何使用 describe-metadata-model-exports-to-target。

AWS CLI

描述中繼資料模型匯出至目標

下列describe-metadata-model-exports-to-target範例會擷取將轉換後的中繼資料模型匯出至目標資料庫的操作狀態，並以其請求 IDs識別。


aws dms describe-metadata-model-exports-to-target \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "TotalObjects": 100,
                "ProgressStep": "APPLYING",
                "ProcessedObject": {
                    "EndpointType": "TARGET"
                }
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的套用轉換後的程式碼。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelExportsToTarget。

以下程式碼範例顯示如何使用 describe-metadata-model-imports。

AWS CLI

描述中繼資料模型匯入

下列describe-metadata-model-imports範例會擷取其請求 IDs所識別的中繼資料匯入操作狀態。


aws dms describe-metadata-model-imports \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

輸出：


{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "TotalObjects": 100,
                "ProgressStep": "IN_PROGRESS",
                "ProcessedObject": {
                    "EndpointType": "SOURCE"
                }
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的導覽中繼資料模型樹。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModelImports。

以下程式碼範例顯示如何使用 describe-metadata-model。

AWS CLI

描述中繼資料模型

下列describe-metadata-model範例會從來源中繼資料樹狀目錄中擷取ExampleSchema結構描述中ExampleTable資料表的詳細資訊，包括其 SQL 定義和目標資料庫中對應轉換中繼資料模型的參考。


aws dms describe-metadata-model \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --origin SOURCE

輸出：


{
    "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\"}]}"
        }
    ],
    "Definition": "CREATE TABLE ExampleTable (ExampleColumn INTEGER NOT NULL);"
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的導覽中繼資料模型樹。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMetadataModel。

以下程式碼範例顯示如何使用 describe-migration-projects。

AWS CLI

描述遷移專案

下列describe-migration-projects範例會擷取其 ARN 所識別之遷移專案的詳細資訊。


aws dms describe-migration-projects \
    --filters Name=migration-project-identifier,Values=arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "MigrationProjects": [
        {
            "MigrationProjectName": "example-migration-project",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000+00:00",
            "SourceDataProviderDescriptors": [
                {
                    "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-source-secret-A1B2C3",
                    "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                    "DataProviderName": "example-data-provider",
                    "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
                }
            ],
            "TargetDataProviderDescriptors": [
                {
                    "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-target-secret-A1B2C3",
                    "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                    "DataProviderName": "example-data-provider",
                    "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
                }
            ],
            "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "InstanceProfileName": "example-instance-profile",
            "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
            "Description": "Example migration project for documentation",
            "SchemaConversionApplicationAttributes": {
                "S3BucketPath": "s3://amzn-s3-demo-bucket",
                "S3BucketRoleArn": "arn:aws:iam::123456789012:role/example-s3-access-role"
            }
        }
    ]
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用遷移專案。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DescribeMigrationProjects。

以下程式碼範例顯示如何使用 describe-orderable-replication-instances。

AWS CLI

描述可排序的複寫執行個體

下列 describe-orderable-replication-instances 範例列出您可以排序的複寫執行個體類型。


aws dms describe-orderable-replication-instances

輸出：


{
    "OrderableReplicationInstances": [
        {
            "EngineVersion": "3.3.2",
            "ReplicationInstanceClass": "dms.c4.2xlarge",
            "StorageType": "gp2",
            "MinAllocatedStorage": 5,
            "MaxAllocatedStorage": 6144,
            "DefaultAllocatedStorage": 100,
            "IncludedAllocatedStorage": 100,
            "AvailabilityZones": [
                "us-east-1a",
                "us-east-1b",
                "us-east-1c",
                "us-east-1d",
                "us-east-1e",
                "us-east-1f"
            ]
        },
        {
            "EngineVersion": "3.3.2",
            "ReplicationInstanceClass": "dms.c4.4xlarge",
            "StorageType": "gp2",
            "MinAllocatedStorage": 5,
            "MaxAllocatedStorage": 6144,
            "DefaultAllocatedStorage": 100,
            "IncludedAllocatedStorage": 100,
            "AvailabilityZones": [
                "us-east-1a",
                "us-east-1b",
                "us-east-1c",
                "us-east-1d",
                "us-east-1e",
                "us-east-1f"
            ]
        },

        ...remaining output omitted...

    }

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 複寫執行個體。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeOrderableReplicationInstances。

以下程式碼範例顯示如何使用 describe-refresh-schemas-status。

AWS CLI

列出端點的重新整理狀態

下列 describe-refresh-schemas-status 範例會傳回先前重新整理請求的狀態。


aws dms describe-refresh-schemas-status \
    --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA

輸出：


{
    "RefreshSchemasStatus": {
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "Status": "successful",
        "LastRefreshDate": 1590786544.605
    }
}

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeRefreshSchemasStatus。

以下程式碼範例顯示如何使用 describe-replication-instances。

AWS CLI

描述複寫執行個體

下列describe-replication-instances範例列出您 AWS 帳戶中的複寫執行個體。


aws dms describe-replication-instances

輸出：


{
    "ReplicationInstances": [
        {
            "ReplicationInstanceIdentifier": "my-repl-instance",
            "ReplicationInstanceClass": "dms.t2.micro",
            "ReplicationInstanceStatus": "available",
            "AllocatedStorage": 5,
            "InstanceCreateTime": 1590011235.952,
            "VpcSecurityGroups": [
                {
                    "VpcSecurityGroupId": "sg-f839b688",
                    "Status": "active"
                }
            ],
            "AvailabilityZone": "us-east-1e",
            "ReplicationSubnetGroup": {
                "ReplicationSubnetGroupIdentifier": "default",
                "ReplicationSubnetGroupDescription": "default",
                "VpcId": "vpc-136a4c6a",
                "SubnetGroupStatus": "Complete",
                "Subnets": [
                    {
                        "SubnetIdentifier": "subnet-da327bf6",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1a"
                        },
                        "SubnetStatus": "Active"
                    },
                    {
                        "SubnetIdentifier": "subnet-42599426",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1d"
                        },
                        "SubnetStatus": "Active"
                    },
                    {
                        "SubnetIdentifier": "subnet-bac383e0",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1c"
                        },
                        "SubnetStatus": "Active"
                    },
                    {
                        "SubnetIdentifier": "subnet-6746046b",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1f"
                        },
                        "SubnetStatus": "Active"
                    },
                    {
                        "SubnetIdentifier": "subnet-d7c825e8",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1e"
                        },
                        "SubnetStatus": "Active"
                    },
                    {
                        "SubnetIdentifier": "subnet-cbfff283",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1b"
                        },
                        "SubnetStatus": "Active"
                    }
                ]
            },
            "PreferredMaintenanceWindow": "wed:11:42-wed:12:12",
            "PendingModifiedValues": {
                "MultiAZ": true
            },
            "MultiAZ": false,
            "EngineVersion": "3.3.2",
            "AutoMinorVersionUpgrade": true,
            "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
            "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
            "ReplicationInstancePublicIpAddress": "3.230.18.248",
            "ReplicationInstancePrivateIpAddress": "172.31.75.90",
            "ReplicationInstancePublicIpAddresses": [
                "3.230.18.248"
            ],
            "ReplicationInstancePrivateIpAddresses": [
                "172.31.75.90"
            ],
            "PubliclyAccessible": true,
            "FreeUntil": 1590194829.267
        }
    ]
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 複寫執行個體。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeReplicationInstances。

以下程式碼範例顯示如何使用 describe-replication-subnet-groups。

AWS CLI

顯示可用的子網路群組

下列 describe-replication-subnet-groups 範例列出可用的子網路群組。


aws dms describe-replication-subnet-groups \
    --filter "Name=replication-subnet-group-id,Values=my-subnet-group"

輸出：


{
    "ReplicationSubnetGroups": [
        {
            "ReplicationSubnetGroupIdentifier": "my-subnet-group",
            "ReplicationSubnetGroupDescription": "my subnet group",
            "VpcId": "vpc-136a4c6a",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-da327bf6",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-bac383e0",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-d7c825e8",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1e"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的設定複寫執行個體的網路。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeReplicationSubnetGroups。

以下程式碼範例顯示如何使用 describe-replication-task-assessment-results。

AWS CLI

列出複寫任務評估的結果

下列 describe-replication-task-assessment-results 範例列出先前任務評估的結果。


aws dms describe-replication-task-assessment-results

輸出：


{
    "ReplicationTaskAssessmentResults": [
        {
            "ReplicationTaskIdentifier": "moveit2",
            "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII",
            "ReplicationTaskLastAssessmentDate": 1590790230.0,
            "AssessmentStatus": "No issues found",
            "AssessmentResultsFile": "moveit2/2020-05-29-22-10"
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的建立任務評估報告。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeReplicationTaskAssessmentResults。

以下程式碼範例顯示如何使用 describe-replication-tasks。

AWS CLI

描述複寫任務

下列 describe-replication-tasks 範例描述目前的複寫任務。


aws dms describe-replication-tasks

輸出：


{
    "ReplicationTasks": [
        {
            "ReplicationTaskIdentifier": "moveit2",
            "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
            "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
            "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
            "MigrationType": "full-load",
            "TableMappings": ...output omitted... ,
            "ReplicationTaskSettings": ...output omitted... ,
            "Status": "stopped",
            "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
            "ReplicationTaskCreationDate": 1590524772.505,
            "ReplicationTaskStartDate": 1590619805.212,
            "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII",
            "ReplicationTaskStats": {
                "FullLoadProgressPercent": 100,
                "ElapsedTimeMillis": 0,
                "TablesLoaded": 0,
                "TablesLoading": 0,
                "TablesQueued": 0,
                "TablesErrored": 0,
                "FreshStartDate": 1590619811.528,
                "StartDate": 1590619811.528,
                "StopDate": 1590619842.068
            }
        }
    ]
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 任務。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeReplicationTasks。

以下程式碼範例顯示如何使用 describe-schemas。

AWS CLI

描述資料庫結構描述

下列 describe-schemas 範例列出端點的可用資料表。


aws dms describe-schemas \
    --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA"

輸出：


{
    "Schemas": [
        "prodrep"
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的這是主題標題。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DescribeSchemas。

以下程式碼範例顯示如何使用 export-metadata-model-assessment。

AWS CLI

匯出轉換評估報告

下列export-metadata-model-assessment範例匯出ExampleSchema結構描述中所有物件的轉換評估報告。


aws dms export-metadata-model-assessment \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --file-name example-assessment-report \
    --assessment-report-types pdf csv

輸出：


{
    "PdfReport": {
        "S3ObjectKey": "example-migration-project/example-assessment-report.pdf",
        "ObjectURL": "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.pdf"
    },
    "CsvReport": {
        "S3ObjectKey": "example-migration-project/example-assessment-report.zip",
        "ObjectURL": "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.zip"
    }
}

如需詳細資訊，請參閱《 Database Migration Service 使用者指南》中的建立資料庫遷移評估報告。 AWS

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ExportMetadataModelAssessment。

以下程式碼範例顯示如何使用 get-target-selection-rules。

AWS CLI

將來源選取規則轉換為目標選取規則

下列get-target-selection-rules範例會將在ExampleSchema結構描述中選取ExampleTable資料表的來源選取規則轉換為參考其轉換對等項目的目標選取規則。


aws dms get-target-selection-rules \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}'

輸出：


{
    "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\"}]}"
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用選擇規則。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 GetTargetSelectionRules。

以下程式碼範例顯示如何使用 list-tags-for-resource。

AWS CLI

列出資源的標籤

下列 list-tags-for-resource 範例會列出複寫執行個體的標籤。


aws dms list-tags-for-resource \
    --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE

輸出：


{
    "TagList": [
        {
            "Key": "Project",
            "Value": "dbMigration"
        },
        {
            "Key": "Environment",
            "Value": "PROD"
        }
    ]
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的標記資源。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ListTagsForResource。

以下程式碼範例顯示如何使用 modify-conversion-configuration。

AWS CLI

修改轉換組態

下列modify-conversion-configuration範例啟用生成式 AI 輔助轉換，並更新遷移專案的轉換路徑設定。


aws dms modify-conversion-configuration \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --conversion-configuration '{"Common project settings":{"EnableGenAiConversion":true},"MSSQL_TO_AURORA_POSTGRESQL":{"ConvertProceduresToFunction":false}}'

輸出：


{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的指定結構描述轉換設定。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ModifyConversionConfiguration。

以下程式碼範例顯示如何使用 modify-data-provider。

AWS CLI

修改資料提供者

下列modify-data-provider範例會更新資料提供者的描述和伺服器名稱。


aws dms modify-data-provider \
    --data-provider-identifier arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --description "Updated data provider description" \
    --engine sqlserver \
    --settings MicrosoftSqlServerSettings={ServerName=new-source-server.us-east-1.rds.amazonaws.com}

輸出：


{
    "DataProvider": {
        "DataProviderName": "example-data-provider",
        "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "Description": "Updated data provider description",
        "Engine": "sqlserver",
        "Settings": {
            "MicrosoftSqlServerSettings": {
                "ServerName": "new-source-server.us-east-1.rds.amazonaws.com",
                "Port": 1433,
                "DatabaseName": "ExampleDatabase",
                "SslMode": "verify-full",
                "CertificateArn": "arn:aws:dms:us-east-1:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用資料提供者。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ModifyDataProvider。

以下程式碼範例顯示如何使用 modify-endpoint。

AWS CLI

修改端點

下列 modify-endpoint 範例將額外的連線屬性加入至端點。


aws dms modify-endpoint \
    --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U" \
    --extra-connection-attributes "compressionType=GZIP"

輸出：


{
    "Endpoint": {
        "EndpointIdentifier": "src-endpoint",
        "EndpointType": "SOURCE",
        "EngineName": "s3",
        "EngineDisplayName": "Amazon S3",
        "ExtraConnectionAttributes": "compressionType=GZIP;csvDelimiter=,;csvRowDelimiter=\\n;",
        "Status": "active",
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U",
        "SslMode": "none",
        "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
        "S3Settings": {
            "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
            "CsvRowDelimiter": "\\n",
            "CsvDelimiter": ",",
            "BucketFolder": "",
            "BucketName": "",
            "CompressionType": "GZIP",
            "EnableStatistics": true
        }
    }
}

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ModifyEndpoint。

以下程式碼範例顯示如何使用 modify-event-subscription。

AWS CLI

修改事件訂閱

下列 modify-event-subscription 範例會變更事件訂閱的來源類型。


aws dms modify-event-subscription \
    --subscription-name "my-dms-events" \
    --source-type replication-task

輸出：


{
    "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "my-dms-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
        "Status": "modifying",
        "SubscriptionCreationTime": "2020-05-29 17:04:40.262",
        "SourceType": "replication-task",
        "Enabled": true
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的使用事件和通知。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ModifyEventSubscription。

以下程式碼範例顯示如何使用 modify-instance-profile。

AWS CLI

修改執行個體描述檔

下列modify-instance-profile範例會更新執行個體描述檔的描述和網路類型。


aws dms modify-instance-profile \
    --instance-profile-identifier arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --description "Updated instance profile description" \
    --network-type DUAL

輸出：


{
    "InstanceProfile": {
        "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "KmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "PubliclyAccessible": false,
        "NetworkType": "DUAL",
        "InstanceProfileName": "example-instance-profile",
        "Description": "Updated instance profile description",
        "InstanceProfileCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "SubnetGroupIdentifier": "example-replication-subnet-group",
        "VpcSecurityGroups": [
            "sg-0123456789abcdef0"
        ]
    }
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用執行個體描述檔。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ModifyInstanceProfile。

以下程式碼範例顯示如何使用 modify-migration-project。

AWS CLI

修改遷移專案

下列modify-migration-project範例會更新來源資料提供者和遷移專案的描述。


aws dms modify-migration-project \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --description "Updated migration project description" \
    --source-data-provider-descriptors DataProviderIdentifier=arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "MigrationProject": {
        "MigrationProjectName": "example-migration-project",
        "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "MigrationProjectCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "SourceDataProviderDescriptors": [
            {
                "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-source-secret-A1B2C3",
                "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                "DataProviderName": "example-data-provider",
                "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        ],
        "TargetDataProviderDescriptors": [
            {
                "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-target-secret-A1B2C3",
                "SecretsManagerAccessRoleArn": "arn:aws:iam::123456789012:role/example-secrets-manager-role",
                "DataProviderName": "example-data-provider",
                "DataProviderArn": "arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        ],
        "InstanceProfileArn": "arn:aws:dms:us-east-1:123456789012:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "InstanceProfileName": "example-instance-profile",
        "TransformationRules": "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
        "Description": "Updated migration project description",
        "SchemaConversionApplicationAttributes": {
            "S3BucketPath": "s3://amzn-s3-demo-bucket",
            "S3BucketRoleArn": "arn:aws:iam::123456789012:role/example-s3-access-role"
        }
    }
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用遷移專案。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ModifyMigrationProject。

以下程式碼範例顯示如何使用 modify-replication-instance。

AWS CLI

修改複寫執行個體

下列 modify-replication-instance 範例會修改複寫執行個體，使其能使用多可用區域部署。


aws dms modify-replication-instance \
     --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
     --multi-az

輸出：


{
    "ReplicationInstance": {
        "ReplicationInstanceIdentifier": "my-repl-instance",
        "ReplicationInstanceClass": "dms.t2.micro",
        "ReplicationInstanceStatus": "available",
        "AllocatedStorage": 5,
        "InstanceCreateTime": 1590011235.952,

        ...output omitted...

        "PendingModifiedValues": {
            "MultiAZ": true
        },
        "MultiAZ": false,
        "EngineVersion": "3.3.2",
        "AutoMinorVersionUpgrade": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",

        ...output omitted...

    }
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 複寫執行個體。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ModifyReplicationInstance。

以下程式碼範例顯示如何使用 modify-replication-subnet-group。

AWS CLI

修改子網路群組

下列 modify-replication-subnet-group 範例會變更與子網路群組相關聯的子網路清單。


aws dms modify-replication-subnet-group \
    --replication-subnet-group-identifier my-subnet-group \
    --subnet-id subnet-da327bf6 subnet-bac383e0

輸出：


{
    "ReplicationSubnetGroup": {
        "ReplicationSubnetGroupIdentifier": "my-subnet-group",
        "ReplicationSubnetGroupDescription": "my subnet group",
        "VpcId": "vpc-136a4c6a",
        "SubnetGroupStatus": "Complete",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-da327bf6",
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1a"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-bac383e0",
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1c"
                },
                "SubnetStatus": "Active"
            }
        ]
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的設定複寫執行個體的網路。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ModifyReplicationSubnetGroup。

以下程式碼範例顯示如何使用 modify-replication-task。

AWS CLI

修改複寫任務

下列 modify-replication-task 範例會變更任務的資料表映射。


aws dms modify-replication-task \
    --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \
    --table-mappings file://table-mappings.json

table-mappings.json 的內容：


{
    "rules": [
        {
            "rule-type": "selection",
            "rule-id": "1",
            "rule-name": "1",
            "object-locator": {
                "schema-name": "prodrep",
                "table-name": "ACCT_%"
            },
            "rule-action": "include",
            "filters": []
        }
    ]
}

輸出：


{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted...,
        "ReplicationTaskSettings": ...output omitted...,
        "Status": "modifying",
        "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskStartDate": 1590789424.653,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 任務。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ModifyReplicationTask。

以下程式碼範例顯示如何使用 reboot-replication-instance。

AWS CLI

重新啟動複寫執行個體

以下 reboot-replication-instance 範例會重新開機複寫執行個體。


aws dms reboot-replication-instance \
    --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE

輸出：


{
    "ReplicationInstance": {
        "ReplicationInstanceIdentifier": "my-repl-instance",
        "ReplicationInstanceClass": "dms.t2.micro",
        "ReplicationInstanceStatus": "rebooting",
        "AllocatedStorage": 5,
        "InstanceCreateTime": 1590011235.952,
    ... output omitted ...
    }
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的使用 AWS DMS 複寫執行個體。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 RebootReplicationInstance。

以下程式碼範例顯示如何使用 refresh-schemas。

AWS CLI

重新整理資料庫結構描述

下列refresh-schemas範例請求 AWS DMS 重新整理端點的結構描述清單。


aws dms refresh-schemas \
    --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
    --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA"

輸出：


{
    "RefreshSchemasStatus": {
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "Status": "refreshing",
        "LastRefreshDate": 1590019949.103
    }
}

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 RefreshSchemas。

以下程式碼範例顯示如何使用 reload-tables。

AWS CLI

重新整理端點上可用的資料表清單

下列 reload-tables 範例會重新載入端點上可用的資料表清單。


aws dms reload-tables \
    --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \
    --tables-to-reload "SchemaName=prodrep,TableName=ACCT_BAL"

輸出：


{
    "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
}

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ReloadTables。

以下程式碼範例顯示如何使用 remove-tags-from-resource。

AWS CLI

從複寫執行個體移除標籤

以下 remove-tags-from-resource 範例會從複寫執行個體移除標籤。


aws dms remove-tags-from-resource \
    --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
    --tag-keys Environment Project

此命令不會產生輸出。

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的標記資源。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 RemoveTagsFromResource。

以下程式碼範例顯示如何使用 start-extension-pack-association。

AWS CLI

將延伸套件套用至目標資料庫

下列start-extension-pack-association範例會將延伸套件的應用程式排入目標資料庫的佇列。


aws dms start-extension-pack-association \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的使用延伸套件。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartExtensionPackAssociation。

以下程式碼範例顯示如何使用 start-metadata-model-assessment。

AWS CLI

評估結構描述中的所有物件

下列start-metadata-model-assessment範例會將ExampleSchema結構描述中所有物件轉換複雜性的評估排入佇列。


aws dms start-metadata-model-assessment \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}'

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱《資料庫遷移服務使用者指南》中的建立資料庫遷移評估報告。 AWS

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartMetadataModelAssessment。

以下程式碼範例顯示如何使用 start-metadata-model-conversion。

AWS CLI

轉換結構描述中的所有物件

下列start-metadata-model-conversion範例會將ExampleSchema結構描述中所有物件的轉換排入目標資料庫格式的佇列。


aws dms start-metadata-model-conversion \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}'

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱《資料庫遷移服務使用者指南》中的轉換資料庫結構描述。 AWS

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartMetadataModelConversion。

以下程式碼範例顯示如何使用 start-metadata-model-creation。

AWS CLI

建立 SQL 陳述式的中繼資料模型

下列start-metadata-model-creation範例會將建立 SQL 陳述式中繼資料模型排入佇列。選擇規則會指定放置中繼資料模型的結構描述，--metadata-model-name並提供唯一識別符以供後續操作使用。


aws dms start-metadata-model-creation \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --metadata-model-name ExampleStatement \
    --properties StatementProperties={Definition="SELECT * FROM ExampleTable;"}

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的建立陳述式中繼資料模型。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartMetadataModelCreation。

以下程式碼範例顯示如何使用 start-metadata-model-export-as-script。

AWS CLI

將轉換後的中繼資料模型匯出為 DDL 指令碼

下列start-metadata-model-export-as-script範例會將結構描述中所有物件的轉換中繼資料模型匯出為資料定義語言 ExampleSchema (DDL) 指令碼，排入與遷移專案相關聯的 Amazon S3 儲存貯體。


aws dms start-metadata-model-export-as-script \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --origin TARGET \
    --file-name ExampleScript

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的將轉換後的程式碼儲存至 SQL 檔案。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartMetadataModelExportAsScript。

以下程式碼範例顯示如何使用 start-metadata-model-export-to-target。

AWS CLI

將轉換後的中繼資料模型匯出至目標資料庫

下列start-metadata-model-export-to-target範例會將ExampleSchema結構描述中所有物件轉換後中繼資料模型匯出至目標資料庫的佇列。


aws dms start-metadata-model-export-to-target \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --overwrite-extension-pack

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱《 AWS Database Migration Service 使用者指南》中的套用轉換後的程式碼。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartMetadataModelExportToTarget。

以下程式碼範例顯示如何使用 start-metadata-model-import。

AWS CLI

從來源資料庫匯入中繼資料

下列start-metadata-model-import範例會將來源資料庫中ExampleSchema結構描述中所有物件的中繼資料匯入排入佇列。


aws dms start-metadata-model-import \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --selection-rules '{"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"}]}' \
    --origin SOURCE \
    --no-refresh

輸出：


{
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱 AWS Database Migration Service 使用者指南中的導覽中繼資料模型樹。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 StartMetadataModelImport。

以下程式碼範例顯示如何使用 start-replication-task-assessment。

AWS CLI

開始任務評估

下列 start-replication-task-assessment 範例會啟動複寫任務評估。


aws dms start-replication-task-assessment \
    --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII

輸出：


{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted...,
        "ReplicationTaskSettings": ...output omitted...,
        "Status": "testing",
        "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskStartDate": 1590789988.677,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的建立任務評估報告。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StartReplicationTaskAssessment。

以下程式碼範例顯示如何使用 start-replication-task。

AWS CLI

啟動複寫任務

下列command-name範例列出您 AWS 帳戶中可用的小工具。


aws dms start-replication-task \
    --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII \
    --start-replication-task-type reload-target

輸出：


{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted... ,
        "ReplicationTaskSettings": ...output omitted... ,
        "Status": "starting",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskStartDate": 1590619805.212,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 任務。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StartReplicationTask。

以下程式碼範例顯示如何使用 stop-replication-task。

AWS CLI

停止任務

以下 stop-replication-task 範例會停止任務。


aws dms stop-replication-task \
    --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII

輸出：


{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted...,
        "ReplicationTaskSettings": ...output omitted...,
        "Status": "stopping",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskStartDate": 1590789424.653,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

如需詳細資訊，請參閱《 Database Migration Service AWS 使用者指南》中的使用 DMS 任務。 AWS

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StopReplicationTask。

以下程式碼範例顯示如何使用 test-connection。

AWS CLI

測試與端點的連線

下列 test-connection 範例會測試是否可以從複寫執行個體存取端點。


aws dms test-connection \
    --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
    --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA

輸出：


{
    "Connection": {
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "Status": "testing",
        "EndpointIdentifier": "src-database-1",
        "ReplicationInstanceIdentifier": "my-repl-instance"
    }
}

如需詳細資訊，請參閱《AWS Database Migration Service 使用者指南》中的建立來源和目標端點。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 TestConnection。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Directory Service 資料

Amazon DocumentDB

AWS DMS 使用 的範例 AWS CLI

主題

動作

AWS DMS 使用的範例 AWS CLI