

D [AWS oc AWS SDK 示例](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub 存储库中有更多 SDK 示例。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# AWS DMS 使用示例 AWS CLI
<a name="cli_2_database-migration-service_code_examples"></a>

以下代码示例向您展示了如何使用 with 来执行操作和实现常见场景 AWS DMS。 AWS Command Line Interface 

*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `向资源添加标签`
<a name="database-migration-service_AddTagsToResource_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[标记资源](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/add-tags-to-resource.html)中的*。

### `取消元数据模型转换`
<a name="database-migration-service_CancelMetadataModelConversion_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 Database Migration Service 用户指南》**中的[转换数据库架构](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-convert.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CancelMetadataModelConversion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/cancel-metadata-model-conversion.html)中的*。

### `取消元数据模型创建`
<a name="database-migration-service_CancelMetadataModelCreation_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[创建语句元数据模型](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html#sc-metadata-model-creation)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CancelMetadataModelCreation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/cancel-metadata-model-creation.html)中的*。

### `创建数据提供商`
<a name="database-migration-service_CreateDataProvider_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用数据提供程序](https://docs.aws.amazon.com/dms/latest/userguide/data-providers.html)。  
**示例 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 用户指南》**中的[使用虚拟数据提供程序](https://docs.aws.amazon.com/dms/latest/userguide/virtual-data-provider.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDataProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-data-provider.html)中的*。

### `创建端点`
<a name="database-migration-service_CreateEndpoint_cli_2_topic"></a>

以下代码示例演示了如何使用 `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
        }
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)使用 AWS DMS 终端节点。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-endpoint.html)中的*。

### `create-event-subscription`
<a name="database-migration-service_CreateEventSubscription_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用事件和通知](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-event-subscription.html)中的*。

### `创建实例配置文件`
<a name="database-migration-service_CreateInstanceProfile_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用实例配置文件](https://docs.aws.amazon.com/dms/latest/userguide/instance-profiles.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-instance-profile.html)中的*。

### `创建迁移项目`
<a name="database-migration-service_CreateMigrationProject_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用迁移项目](https://docs.aws.amazon.com/dms/latest/userguide/migration-projects-create.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateMigrationProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-migration-project.html)中的*。

### `创建复制实例`
<a name="database-migration-service_CreateReplicationInstance_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 数据库迁移服务用户指南*》](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)中的使用 AWS DMS 复制实例。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-instance.html)中的*。

### `创建复制子网组`
<a name="database-migration-service_CreateReplicationSubnetGroup_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[为复制实例设置网络](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-subnet-group.html)中的*。

### `创建复制任务`
<a name="database-migration-service_CreateReplicationTask_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)使用 AWS DMS 任务。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-task.html)中的*。

### `删除连接`
<a name="database-migration-service_DeleteConnection_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅[https://docs.aws.amazon.com/dms/latest/userguide/CHAP\_Endpoints.Creating.html](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html)《*AWS 数据库迁移服务用户指南》*。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-connection.html)中的*。

### `删除数据提供商`
<a name="database-migration-service_DeleteDataProvider_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用数据提供程序](https://docs.aws.amazon.com/dms/latest/userguide/data-providers.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDataProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-data-provider.html)中的*。

### `删除终端节点`
<a name="database-migration-service_DeleteEndpoint_cli_2_topic"></a>

以下代码示例演示了如何使用 `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
        }
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)使用 AWS DMS 终端节点。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-endpoint.html)中的*。

### `delete-event-subscription`
<a name="database-migration-service_DeleteEventSubscription_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用事件和通知](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-event-subscription.html)中的*。

### `删除实例配置文件`
<a name="database-migration-service_DeleteInstanceProfile_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用实例配置文件](https://docs.aws.amazon.com/dms/latest/userguide/instance-profiles.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-instance-profile.html)中的*。

### `删除迁移项目`
<a name="database-migration-service_DeleteMigrationProject_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用迁移项目](https://docs.aws.amazon.com/dms/latest/userguide/migration-projects-manage.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteMigrationProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-migration-project.html)中的*。

### `删除复制实例`
<a name="database-migration-service_DeleteReplicationInstance_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 数据库迁移服务用户指南*》](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)中的使用 AWS DMS 复制实例。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-instance.html)中的*。

### `删除复制子网组`
<a name="database-migration-service_DeleteReplicationSubnetGroup_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[为复制实例设置网络](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-subnet-group.html)中的*。

### `删除复制任务`
<a name="database-migration-service_DeleteReplicationTask_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)使用 AWS DMS 任务。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-task.html)中的*。

### `描述账户属性`
<a name="database-migration-service_DescribeAccountAttributes_cli_2_topic"></a>

以下代码示例演示了如何使用 `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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-account-attributes.html)中的*。

### `describe-certificates`
<a name="database-migration-service_DescribeCertificates_cli_2_topic"></a>

以下代码示例演示了如何使用 `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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.SSL)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-certificates.html)中的*。

### `描述连接`
<a name="database-migration-service_DescribeConnections_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[创建源端点和目标端点](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-connections.html)中的*。

### `描述转换配置`
<a name="database-migration-service_DescribeConversionConfiguration_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[指定架构转换设置](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-settings.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeConversionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-conversion-configuration.html)中的*。

### `描述数据提供者`
<a name="database-migration-service_DescribeDataProviders_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用数据提供程序](https://docs.aws.amazon.com/dms/latest/userguide/data-providers.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeDataProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-data-providers.html)中的*。

### `描述端点类型`
<a name="database-migration-service_DescribeEndpointTypes_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 数据库迁移服务用户指南》中的使用 AWS DMS 端点 < https://docs.aws.amazon.com/dms/latest/userguide/CHAP\_Endpoints.html >`\_\_。*  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEndpointTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoint-types.html)中的*。

### `描述终端节点`
<a name="database-migration-service_DescribeEndpoints_cli_2_topic"></a>

以下代码示例演示了如何使用 `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
        }
    ]
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)使用 AWS DMS 终端节点。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoints.html)中的*。

### `describe-event-categories`
<a name="database-migration-service_DescribeEventCategories_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用事件和通知](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-categories.html)中的*。

### `describe-event-subscriptions`
<a name="database-migration-service_DescribeEventSubscriptions_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用事件和通知](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-subscriptions.html)中的*。

### `describe-events`
<a name="database-migration-service_DescribeEvents_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用事件和通知](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-events.html)中的*。

### `描述扩展包关联`
<a name="database-migration-service_DescribeExtensionPackAssociations_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-extension-pack-associations`。

**AWS CLI**  
**描述扩展包关联**  
以下 `describe-extension-pack-associations` 示例检索将扩展包应用于目标数据库的操作的状态，这些操作由其请求 ID 标识。  

```
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 用户指南》**中的[使用扩展包](https://docs.aws.amazon.com/dms/latest/userguide/extension-pack.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeExtensionPackAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-extension-pack-associations.html)中的*。

### `描述实例配置文件`
<a name="database-migration-service_DescribeInstanceProfiles_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用实例配置文件](https://docs.aws.amazon.com/dms/latest/userguide/instance-profiles.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeInstanceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-instance-profiles.html)中的*。

### `描述元数据模型评估`
<a name="database-migration-service_DescribeMetadataModelAssessments_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-metadata-model-assessments`。

**AWS CLI**  
**描述元数据模型评测**  
以下 `describe-metadata-model-assessments` 示例检索由请求 ID 标识的元数据模型评测操作的状态。  

```
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 Database Migration Service 用户指南》**中的[创建数据库迁移评测报告](https://docs.aws.amazon.com/dms/latest/userguide/assessment-reports.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelAssessments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-assessments.html)中的*。

### `描述子模型的元数据`
<a name="database-migration-service_DescribeMetadataModelChildren_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[在元数据模型树中导航](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html#sc-metadata-model-navigating)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelChildren](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-children.html)中的*。

### `描述元数据模型转换`
<a name="database-migration-service_DescribeMetadataModelConversions_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-metadata-model-conversions`。

**AWS CLI**  
**描述元数据模型转换**  
以下 `describe-metadata-model-conversions` 示例检索由请求 ID 标识的元数据模型转换操作的状态。  

```
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 Database Migration Service 用户指南》**中的[转换数据库架构](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-convert.html#schema-conversion-convert-steps)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelConversions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-conversions.html)中的*。

### `描述元数据模型创建`
<a name="database-migration-service_DescribeMetadataModelCreations_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-metadata-model-creations`。

**AWS CLI**  
**描述元数据模型的创建**  
以下 `describe-metadata-model-creations` 示例检索由请求 ID 标识的元数据模型创建操作的状态。  

```
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 用户指南》**中的[创建语句元数据模型](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html#sc-metadata-model-creation)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelCreations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-creations.html)中的*。

### `描述元数据模型导出为脚本`
<a name="database-migration-service_DescribeMetadataModelExportsAsScript_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-metadata-model-exports-as-script`。

**AWS CLI**  
**将元数据模型导出描述为脚本**  
以下 `describe-metadata-model-exports-as-script` 示例检索将元数据模型导出为数据定义语言（DDL）脚本的操作的状态，这些操作由其请求 ID 标识。  

```
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 文件](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-save-apply.html#schema-conversion-save)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelExportsAsScript](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-exports-as-script.html)中的*。

### `描述元数据模型导出到目标`
<a name="database-migration-service_DescribeMetadataModelExportsToTarget_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-metadata-model-exports-to-target`。

**AWS CLI**  
**描述将元数据模型导出到目标**  
以下 `describe-metadata-model-exports-to-target` 示例检索将转换后的元数据模型导出到目标数据库的操作的状态，这些操作由其请求 ID 标识。  

```
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 用户指南》**中的[应用转换后的代码](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-save-apply.html#schema-conversion-apply)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelExportsToTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-exports-to-target.html)中的*。

### `描述元数据模型导入`
<a name="database-migration-service_DescribeMetadataModelImports_cli_2_topic"></a>

以下代码示例演示了如何使用 `describe-metadata-model-imports`。

**AWS CLI**  
**描述元数据模型导入**  
以下 `describe-metadata-model-imports` 示例检索由请求 ID 标识的元数据导入操作的状态。  

```
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 用户指南》**中的[在元数据模型树中导航](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModelImports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model-imports.html)中的*。

### `描述元数据模型`
<a name="database-migration-service_DescribeMetadataModel_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[在元数据模型树中导航](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html#sc-metadata-model-navigating)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMetadataModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-metadata-model.html)中的*。

### `描述迁移项目`
<a name="database-migration-service_DescribeMigrationProjects_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用迁移项目](https://docs.aws.amazon.com/dms/latest/userguide/migration-projects.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeMigrationProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-migration-projects.html)中的*。

### `描述可排序的复制实例`
<a name="database-migration-service_DescribeOrderableReplicationInstances_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 数据库迁移服务用户指南*》](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)中的使用 AWS DMS 复制实例。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeOrderableReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-orderable-replication-instances.html)中的*。

### `描述刷新架构状态`
<a name="database-migration-service_DescribeRefreshSchemasStatus_cli_2_topic"></a>

以下代码示例演示了如何使用 `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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-refresh-schemas-status.html)中的*。

### `描述复制实例`
<a name="database-migration-service_DescribeReplicationInstances_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 数据库迁移服务用户指南*》](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)x中的使用 AWS DMS 复制实例。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-instances.html)中的*。

### `描述复制子网组`
<a name="database-migration-service_DescribeReplicationSubnetGroups_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[为复制实例设置网络](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeReplicationSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-subnet-groups.html)中的*。

### `描述复制任务评估结果`
<a name="database-migration-service_DescribeReplicationTaskAssessmentResults_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[创建任务评估报告](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeReplicationTaskAssessmentResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-task-assessment-results.html)中的*。

### `描述复制任务`
<a name="database-migration-service_DescribeReplicationTasks_cli_2_topic"></a>

以下代码示例演示了如何使用 `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
            }
        }
    ]
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)使用 AWS DMS 任务。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeReplicationTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-tasks.html)中的*。

### `描述架构`
<a name="database-migration-service_DescribeSchemas_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[这是主题标题](https://link.to.the/topic/page)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeSchemas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-schemas.html)中的*。

### `导出元数据模型评估`
<a name="database-migration-service_ExportMetadataModelAssessment_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅《AWS Database Migration Service 用户指南》**中的[创建数据库迁移评测报告](https://docs.aws.amazon.com/dms/latest/userguide/assessment-reports.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ExportMetadataModelAssessment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/export-metadata-model-assessment.html)中的*。

### `获取目标选择规则`
<a name="database-migration-service_GetTargetSelectionRules_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用选择规则](https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetTargetSelectionRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/get-target-selection-rules.html)中的*。

### `list-tags-for-resource`
<a name="database-migration-service_ListTagsForResource_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[标记资源](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/list-tags-for-resource.html)中的*。

### `修改转换配置`
<a name="database-migration-service_ModifyConversionConfiguration_cli_2_topic"></a>

以下代码示例演示了如何使用 `modify-conversion-configuration`。

**AWS CLI**  
**修改转换配置**  
以下 `modify-conversion-configuration` 示例启用生成式人工智能辅助转换，并更新迁移项目的转换路径设置。  

```
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 用户指南》**中的[指定架构转换设置](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-settings.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyConversionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-conversion-configuration.html)中的*。

### `修改数据提供商`
<a name="database-migration-service_ModifyDataProvider_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用数据提供程序](https://docs.aws.amazon.com/dms/latest/userguide/data-providers.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyDataProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-data-provider.html)中的*。

### `修改端点`
<a name="database-migration-service_ModifyEndpoint_cli_2_topic"></a>

以下代码示例演示了如何使用 `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
        }
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南》中的使用 AWS DMS 端点 < https://docs.aws.amazon.com/dms/latest/userguide/CHAP\_Endpoints.html >`\_\_。*  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-endpoint.html)中的*。

### `modify-event-subscription`
<a name="database-migration-service_ModifyEventSubscription_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用事件和通知](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-event-subscription.html)中的*。

### `修改实例配置文件`
<a name="database-migration-service_ModifyInstanceProfile_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用实例配置文件](https://docs.aws.amazon.com/dms/latest/userguide/instance-profiles.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-instance-profile.html)中的*。

### `修改迁移项目`
<a name="database-migration-service_ModifyMigrationProject_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用迁移项目](https://docs.aws.amazon.com/dms/latest/userguide/migration-projects-manage.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyMigrationProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-migration-project.html)中的*。

### `修改复制实例`
<a name="database-migration-service_ModifyReplicationInstance_cli_2_topic"></a>

以下代码示例演示了如何使用 `modify-replication-instance`。

**AWS CLI**  
**修改复制实例**  
以下`modify-replication-instance`示例修改了复制实例，使其使用 Multi-AZ 部署。  

```
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 数据库迁移服务用户指南*》](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)中的使用 AWS DMS 复制实例。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-instance.html)中的*。

### `修改复制子网组`
<a name="database-migration-service_ModifyReplicationSubnetGroup_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[为复制实例设置网络](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-subnet-group.html)中的*。

### `修改复制任务`
<a name="database-migration-service_ModifyReplicationTask_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)使用 AWS DMS 任务。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ModifyReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-task.html)中的*。

### `重启复制实例`
<a name="database-migration-service_RebootReplicationInstance_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 数据库迁移服务用户指南*》](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)中的使用 AWS DMS 复制实例。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[RebootReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/reboot-replication-instance.html)中的*。

### `刷新架构`
<a name="database-migration-service_RefreshSchemas_cli_2_topic"></a>

以下代码示例演示了如何使用 `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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/refresh-schemas.html)中的*。

### `重装表`
<a name="database-migration-service_ReloadTables_cli_2_topic"></a>

以下代码示例演示了如何使用 `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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/reload-tables.html)中的*。

### `从资源中移除标签`
<a name="database-migration-service_RemoveTagsFromResource_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[标记资源](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/remove-tags-from-resource.html)中的*。

### `启动扩展包关联`
<a name="database-migration-service_StartExtensionPackAssociation_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[使用扩展包](https://docs.aws.amazon.com/dms/latest/userguide/extension-pack.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartExtensionPackAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-extension-pack-association.html)中的*。

### `开始元数据模型评估`
<a name="database-migration-service_StartMetadataModelAssessment_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 Database Migration Service 用户指南》**中的[创建数据库迁移评测报告](https://docs.aws.amazon.com/dms/latest/userguide/assessment-reports.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartMetadataModelAssessment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-metadata-model-assessment.html)中的*。

### `开始元数据模型转换`
<a name="database-migration-service_StartMetadataModelConversion_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 Database Migration Service 用户指南》**中的[转换数据库架构](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-convert.html#schema-conversion-convert-steps)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartMetadataModelConversion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-metadata-model-conversion.html)中的*。

### `开始创建元数据模型`
<a name="database-migration-service_StartMetadataModelCreation_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[创建语句元数据模型](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html#sc-metadata-model-creation)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartMetadataModelCreation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-metadata-model-creation.html)中的*。

### `启动元数据模型导出为脚本`
<a name="database-migration-service_StartMetadataModelExportAsScript_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 文件](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-save-apply.html#schema-conversion-save)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartMetadataModelExportAsScript](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-metadata-model-export-as-script.html)中的*。

### `开始将元数据模型导出到目标`
<a name="database-migration-service_StartMetadataModelExportToTarget_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[应用转换后的代码](https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-save-apply.html#schema-conversion-apply)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartMetadataModelExportToTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-metadata-model-export-to-target.html)中的*。

### `开始元数据模型导入`
<a name="database-migration-service_StartMetadataModelImport_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[在元数据模型树中导航](https://docs.aws.amazon.com/dms/latest/userguide/sc-metadata-model.html#sc-metadata-model-navigating)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartMetadataModelImport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-metadata-model-import.html)中的*。

### `开始复制任务评估`
<a name="database-migration-service_StartReplicationTaskAssessment_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[创建任务评估报告](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartReplicationTaskAssessment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-replication-task-assessment.html)中的*。

### `启动复制任务`
<a name="database-migration-service_StartReplicationTask_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)使用 AWS DMS 任务。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StartReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-replication-task.html)中的*。

### `停止复制任务`
<a name="database-migration-service_StopReplicationTask_cli_2_topic"></a>

以下代码示例演示了如何使用 `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"
    }
}
```
有关更多信息，请参阅《*AWS 数据库迁移服务用户指南*》[中的](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)使用 AWS DMS 任务。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[StopReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/stop-replication-task.html)中的*。

### `测试连接`
<a name="database-migration-service_TestConnection_cli_2_topic"></a>

以下代码示例演示了如何使用 `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 用户指南》**中的[创建源端点和目标端点](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[TestConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/test-connection.html)中的*。