View a markdown version of this page

AWS DMS exemplos usando AWS CLI - AWS Exemplos de código do SDK

Há mais exemplos de AWS SDK disponíveis no repositório AWS Doc SDK Examples GitHub .

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AWS DMS exemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS DMS.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar add-tags-to-resource.

AWS CLI

Para adicionar tags a um recurso

O exemplo add-tags-to-resource a seguir adiciona tags a uma instância de replicação.

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

Este comando não produz saída.

Para ter mais informações, consulte Marcação de recursos no Guia do usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte AddTagsToResourceem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar cancel-metadata-model-conversion.

AWS CLI

Para cancelar uma conversão de modelo de metadados

O cancel-metadata-model-conversion exemplo a seguir cancela uma operação de conversão do modelo de metadados.

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

Saída:

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

Para obter mais informações, consulte Conversão de esquemas de banco de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar cancel-metadata-model-creation.

AWS CLI

Para cancelar a criação de um modelo de metadados

O cancel-metadata-model-creation exemplo a seguir cancela uma operação de criação de modelo de metadados.

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

Saída:

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

Para obter mais informações, consulte Criação de modelos de metadados de instruções no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar create-data-provider.

AWS CLI

Exemplo 1: Para criar um provedor de dados do Microsoft SQL Server

O create-data-provider exemplo a seguir cria um provedor de dados do 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}

Saída:

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

Para obter mais informações, consulte Trabalhando com provedores de dados no Guia do Usuário do AWS Database Migration Service.

Exemplo 2: Para criar um provedor de dados virtual

O create-data-provider exemplo a seguir cria um provedor de dados virtual, que não exige uma conexão com o banco de dados.

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}

Saída:

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

Para obter mais informações, consulte Trabalhando com provedores de dados virtuais no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte CreateDataProviderem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-endpoint.

AWS CLI

Para criar um endpoint

O exemplo create-endpoint a seguir cria um endpoint para uma origem do Amazon S3.

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

Conteúdo de s3-settings.json:

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

Saída:

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

Para obter mais informações, consulte Trabalhando com endpoints do AWS DMS no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte CreateEndpointem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-event-subscription.

AWS CLI

Para listar assinaturas de eventos

O exemplo create-event-subscription a seguir cria uma assinatura de evento para um tópico do 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

Saída:

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

Para obter mais informações, consulte Como trabalhar com eventos e notificações no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar create-instance-profile.

AWS CLI

Como criar um perfil de instância

O create-instance-profile exemplo a seguir cria um perfil de instância.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com perfis de instância no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar create-migration-project.

AWS CLI

Para criar um projeto de migração

O create-migration-project exemplo a seguir cria um projeto de migração.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com projetos de migração no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar create-replication-instance.

AWS CLI

Para criar uma instância de replicação

O exemplo create-replication-instance a seguir cria uma instância de replicação.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com uma instância de replicação do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar create-replication-subnet-group.

AWS CLI

Para criar um grupo de sub-redes

O exemplo create-replication-subnet-group a seguir cria um grupo que consiste em 3 sub-redes.

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

Saída:

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

Para obter mais informações, consulte Configurar uma rede para uma instância de replicação no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar create-replication-task.

AWS CLI

Para criar uma tarefa de replicação

O exemplo create-replication-task a seguir cria uma tarefa de replicação.

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

Conteúdo de table-mappings.json:

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

Saída:

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

Para obter mais informações, consulte Trabalhando com tarefas do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar delete-connection.

AWS CLI

Para excluir uma conexão

O exemplo delete-connection a seguir dissocia um endpoint de uma instância de replicação.

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

Saída:

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

Para obter mais informações, consulte https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.htmlo Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte DeleteConnectionem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-data-provider.

AWS CLI

Para excluir um provedor de dados

O delete-data-provider exemplo a seguir exclui um provedor de dados identificado por seu ARN.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com provedores de dados no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte DeleteDataProviderem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-endpoint.

AWS CLI

Para excluir um endpoint

O exemplo delete-endpoint a seguir exclui um endpoint.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com endpoints do AWS DMS no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte DeleteEndpointem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-event-subscription.

AWS CLI

Para excluir uma assinatura de evento

O exemplo delete-event-subscription a seguir exclui uma assinatura de um tópico do Amazon SNS.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com eventos e notificações no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar delete-instance-profile.

AWS CLI

Como excluir um perfil de instância

O delete-instance-profile exemplo a seguir exclui um perfil de instância identificado por seu ARN.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com perfis de instância no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar delete-migration-project.

AWS CLI

Para excluir um projeto de migração

O delete-migration-project exemplo a seguir exclui um projeto de migração identificado por seu ARN.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com projetos de migração no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar delete-replication-instance.

AWS CLI

Para excluir uma instância de replicação

O exemplo da delete-replication-instance a seguir exclui uma instância de replicação.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com uma instância de replicação do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar delete-replication-subnet-group.

AWS CLI

Para excluir um grupo de sub-redes

O exemplo delete-replication-subnet-group a seguir exclui um grupo de sub-redes.

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

Saída:

(none)

Para obter mais informações, consulte Configurar uma rede para uma instância de replicação no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar delete-replication-task.

AWS CLI

Para excluir uma tarefa de replicação

O exemplo delete-replication-task a seguir exclui uma tarefa de replicação.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com tarefas do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-account-attributes.

AWS CLI

Como descrever os atributos da conta

O describe-account-attributes exemplo a seguir lista os atributos da sua AWS conta.

aws dms describe-account-attributes

Saída:

{ "AccountQuotas": [ { "AccountQuotaName": "ReplicationInstances", "Used": 1, "Max": 20 }, { "AccountQuotaName": "AllocatedStorage", "Used": 5, "Max": 10000 }, ...remaining output omitted... ], "UniqueAccountIdentifier": "cqahfbfy5xee" }

O código de exemplo a seguir mostra como usar describe-certificates.

AWS CLI

Para listar os certificados disponíveis

O describe-certificates exemplo a seguir lista os certificados disponíveis em sua AWS conta.

aws dms describe-certificates

Saída:

{ "Certificates": [ { "CertificateIdentifier": "my-cert", "CertificateCreationDate": 1543259542.506, "CertificatePem": "-----BEGIN CERTIFICATE-----\nMIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQ ...U" ... remaining output omittted ... } ] }

Para ter mais informações, consulte Como usar o SSL no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-connections.

AWS CLI

Para descrever conexões

O exemplo describe-connections a seguir lista as conexões que você testou entre uma instância de replicação e um endpoint.

aws dms describe-connections

Saída:

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

Para obter mais informações, consulte Criação de endpoints de origem e destino no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-conversion-configuration.

AWS CLI

Para descrever uma configuração de conversão

O describe-conversion-configuration exemplo a seguir recupera a configuração de conversão para um projeto de migração.

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

Saída:

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

Para obter mais informações, consulte Especificação das configurações de conversão de esquema no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-data-providers.

AWS CLI

Para descrever os provedores de dados

O describe-data-providers exemplo a seguir recupera os detalhes de um provedor de dados identificado por seu ARN.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com provedores de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-endpoint-types.

AWS CLI

Para listar os tipos de endpoint disponíveis

O exemplo describe-endpoint-types a seguir lista os tipos de endpoint do MySQL que estão disponíveis.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com AWS DMS Endpoints < https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html >`__ no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-endpoints.

AWS CLI

Para descrever endpoints

O describe-endpoints exemplo a seguir lista os endpoints em sua AWS conta.

aws dms describe-endpoints

Saída:

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

Para obter mais informações, consulte Trabalhando com endpoints do AWS DMS no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte DescribeEndpointsem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-event-categories.

AWS CLI

Para descrever categorias de eventos

O exemplo describe-event-categories a seguir lista as categorias de eventos disponíveis.

aws dms describe-event-categories

Saída:

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

Para obter mais informações, consulte Como trabalhar com eventos e notificações no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-event-subscriptions.

AWS CLI

Para descrever assinaturas de eventos

O exemplo describe-event-subscriptions a seguir lista as assinaturas para um evento para um tópico do Amazon SNS.

aws dms describe-event-subscriptions

Saída:

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

Para obter mais informações, consulte Como trabalhar com eventos e notificações no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-events.

AWS CLI

Para listar eventos do DMS

O exemplo describe-events a seguir lista os eventos que se originaram de uma instância de replicação.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com eventos e notificações no Guia do usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte DescribeEventsem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-extension-pack-associations.

AWS CLI

Para descrever associações de pacotes de extensão

O describe-extension-pack-associations exemplo a seguir recupera o status das operações que aplicam um pacote de extensão ao banco de dados de destino, identificado por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Usando pacotes de extensão no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-instance-profiles.

AWS CLI

Para descrever perfis de instância

O describe-instance-profiles exemplo a seguir recupera os detalhes de um perfil de instância identificado por seu ARN.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com perfis de instância no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-assessments.

AWS CLI

Para descrever as avaliações do modelo de metadados

O describe-metadata-model-assessments exemplo a seguir recupera o status das operações de avaliação do modelo de metadados identificadas por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Criação de relatórios de avaliação de migração de banco de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-children.

AWS CLI

Para descrever os filhos do modelo de metadados

O describe-metadata-model-children exemplo a seguir recupera os modelos de metadados secundários do ExampleSchema esquema da árvore de metadados de origem.

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

Saída:

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

Para obter mais informações, consulte Navegando na árvore do modelo de metadados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-conversions.

AWS CLI

Para descrever as conversões do modelo de metadados

O describe-metadata-model-conversions exemplo a seguir recupera o status das operações de conversão do modelo de metadados identificadas por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Conversão de esquemas de banco de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-creations.

AWS CLI

Para descrever as criações de modelos de metadados

O describe-metadata-model-creations exemplo a seguir recupera o status das operações de criação do modelo de metadados identificadas por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Criação de modelos de metadados de instruções no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-exports-as-script.

AWS CLI

Para descrever as exportações do modelo de metadados como script

O describe-metadata-model-exports-as-script exemplo a seguir recupera o status das operações que exportam modelos de metadados como scripts de linguagem de definição de dados (DDL), identificados por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Salvando seu código convertido em um arquivo SQL no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-exports-to-target.

AWS CLI

Para descrever as exportações do modelo de metadados para o alvo

O describe-metadata-model-exports-to-target exemplo a seguir recupera o status das operações que exportam modelos de metadados convertidos para o banco de dados de destino, identificados por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Aplicando seu código convertido no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model-imports.

AWS CLI

Para descrever as importações de modelos de metadados

O describe-metadata-model-imports exemplo a seguir recupera o status das operações de importação de metadados identificadas por seus IDs de solicitação.

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

Saída:

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

Para obter mais informações, consulte Navegando na árvore do modelo de metadados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-metadata-model.

AWS CLI

Para descrever um modelo de metadados

O describe-metadata-model exemplo a seguir recupera informações detalhadas sobre a ExampleTable tabela no ExampleSchema esquema da árvore de metadados de origem, incluindo sua definição de SQL e referências aos modelos de metadados convertidos correspondentes no banco de dados de destino.

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

Saída:

{ "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);" }

Para obter mais informações, consulte Navegando na árvore do modelo de metadados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-migration-projects.

AWS CLI

Para descrever projetos de migração

O describe-migration-projects exemplo a seguir recupera os detalhes de um projeto de migração identificado por seu ARN.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com projetos de migração no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-orderable-replication-instances.

AWS CLI

Para descrever instâncias de replicação solicitáveis

O exemplo describe-orderable-replication-instances a seguir lista os tipos de instância de replicação que você pode solicitar.

aws dms describe-orderable-replication-instances

Saída:

{ "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... }

Para obter mais informações, consulte Trabalhando com uma instância de replicação do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-refresh-schemas-status.

AWS CLI

Para listar o status de atualização de um endpoint

O exemplo describe-refresh-schemas-status a seguir retorna o status de uma solicitação de atualização anterior.

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

Saída:

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

O código de exemplo a seguir mostra como usar describe-replication-instances.

AWS CLI

Para descrever instâncias de replicação

O describe-replication-instances exemplo a seguir lista as instâncias de replicação na sua AWS conta.

aws dms describe-replication-instances

Saída:

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

Para obter mais informações, consulte Trabalhando com uma instância de replicação do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-replication-subnet-groups.

AWS CLI

Para exibir os grupos de sub-redes disponíveis

O exemplo describe-replication-subnet-groups a seguir lista os grupos de sub-redes disponíveis.

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

Saída:

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

Para obter mais informações, consulte Configurar uma rede para uma instância de replicação no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-replication-task-assessment-results.

AWS CLI

Para listar os resultados das avaliações de tarefas de replicação

O exemplo describe-replication-task-assessment-results a seguir lista os resultados de uma avaliação anterior da tarefa.

aws dms describe-replication-task-assessment-results

Saída:

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

Para obter mais informações, consulte Criação de um relatório de avaliação de tarefas no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-replication-tasks.

AWS CLI

Para descrever uma tarefa de replicação

O exemplo describe-replication-tasks a seguir descreve as tarefas de replicação atuais.

aws dms describe-replication-tasks

Saída:

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

Para obter mais informações, consulte Trabalhando com tarefas do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar describe-schemas.

AWS CLI

Como descrever esquemas de banco de dados

O exemplo describe-schemas a seguir lista as tabelas disponíveis em um endpoint.

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

Saída:

{ "Schemas": [ "prodrep" ] }

Para ter mais informações, consulte Este é o título do tópico no Guia do usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte DescribeSchemasem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar export-metadata-model-assessment.

AWS CLI

Para exportar um relatório de avaliação de conversão

O export-metadata-model-assessment exemplo a seguir exporta um relatório de avaliação de conversão para todos os objetos no ExampleSchema esquema.

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

Saída:

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

Para obter mais informações, consulte Criação de relatórios de avaliação de migração de banco de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar get-target-selection-rules.

AWS CLI

Para converter regras de seleção de origem em regras de seleção de destino

O get-target-selection-rules exemplo a seguir converte as regras de seleção de origem que selecionam a ExampleTable tabela no ExampleSchema esquema em regras de seleção de destino que fazem referência à contraparte convertida.

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"}]}'

Saída:

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

Para obter mais informações, consulte Usando regras de seleção no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar as tags de um recurso

O exemplo list-tags-for-resource a seguir lista as tags de uma instância de replicação.

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

Saída:

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

Para ter mais informações, consulte Marcação de recursos no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-conversion-configuration.

AWS CLI

Para modificar uma configuração de conversão

O modify-conversion-configuration exemplo a seguir permite a conversão generativa assistida por IA e atualiza uma configuração de caminho de conversão para um projeto de migração.

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}}'

Saída:

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

Para obter mais informações, consulte Especificação das configurações de conversão de esquema no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-data-provider.

AWS CLI

Para modificar um provedor de dados

O modify-data-provider exemplo a seguir atualiza a descrição e o nome do servidor de um provedor de dados.

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}

Saída:

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

Para obter mais informações, consulte Trabalhando com provedores de dados no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte ModifyDataProviderem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar modify-endpoint.

AWS CLI

Para modificar um endpoint

O exemplo modify-endpoint a seguir adiciona um atributo de conexão adicional a um endpoint.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com AWS DMS Endpoints < https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html >`__ no Guia do Usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte ModifyEndpointem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar modify-event-subscription.

AWS CLI

Para modificar a assinatura de um evento

O exemplo modify-event-subscription a seguir altera o tipo de origem de uma assinatura de evento.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com eventos e notificações no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-instance-profile.

AWS CLI

Para modificar um perfil de instância

O modify-instance-profile exemplo a seguir atualiza a descrição e o tipo de rede de um perfil de instância.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com perfis de instância no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-migration-project.

AWS CLI

Para modificar um projeto de migração

O modify-migration-project exemplo a seguir atualiza o provedor de dados de origem e a descrição de um projeto de migração.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com projetos de migração no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-replication-instance.

AWS CLI

Para modificar uma instância de replicação

O modify-replication-instance exemplo a seguir modifica uma instância de replicação para que ela use uma Multi-AZ implantação.

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

Saída:

{ "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... } }

Para obter mais informações, consulte Trabalhando com uma instância de replicação do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-replication-subnet-group.

AWS CLI

Para modificar um grupo de sub-redes

O exemplo modify-replication-subnet-group a seguir altera as listas de sub-redes associadas a um grupo de sub-redes.

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

Saída:

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

Para obter mais informações, consulte Configurar uma rede para uma instância de replicação no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar modify-replication-task.

AWS CLI

Para modificar uma tarefa de replicação

O exemplo modify-replication-task a seguir altera os mapeamentos de tabela de uma tarefa.

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

Conteúdo de 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": [] } ] }

Saída:

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

Para obter mais informações, consulte Trabalhando com tarefas do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar reboot-replication-instance.

AWS CLI

Para reiniciar uma instância de replicação

O exemplo da reboot-replication-instance a seguir reinicializa uma instância de replicação.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com uma instância de replicação do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar refresh-schemas.

AWS CLI

Para atualizar esquemas de banco de dados

O refresh-schemas exemplo a seguir solicita que o AWS DMS atualize a lista de esquemas em um endpoint.

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"

Saída:

{ "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 } }
  • Para obter detalhes da API, consulte RefreshSchemasem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar reload-tables.

AWS CLI

Para atualizar a lista de tabelas disponíveis em um endpoint

O exemplo reload-tables a seguir recarrega a lista de tabelas disponíveis em um endpoint.

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

Saída:

{ "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" }
  • Para obter detalhes da API, consulte ReloadTablesem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar remove-tags-from-resource.

AWS CLI

Para remover tags de uma instância de replicação

O exemplo remove-tags-from-resource a seguir remove tags de uma instância de replicação.

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

Este comando não produz saída.

Para ter mais informações, consulte Marcação de recursos no Guia do usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-extension-pack-association.

AWS CLI

Para aplicar um pacote de extensão ao banco de dados de destino

O start-extension-pack-association exemplo a seguir coloca em fila a aplicação de um pacote de extensão no banco de dados de destino.

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

Saída:

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

Para obter mais informações, consulte Usando pacotes de extensão no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-metadata-model-assessment.

AWS CLI

Para avaliar todos os objetos em um esquema

O start-metadata-model-assessment exemplo a seguir coloca em fila uma avaliação da complexidade de conversão de todos os objetos no ExampleSchema esquema.

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"}]}'

Saída:

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

Para obter mais informações, consulte Criação de relatórios de avaliação de migração de banco de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-metadata-model-conversion.

AWS CLI

Para converter todos os objetos em um esquema

O start-metadata-model-conversion exemplo a seguir coloca em fila uma conversão de todos os objetos no ExampleSchema esquema para o formato do banco de dados de destino.

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"}]}'

Saída:

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

Para obter mais informações, consulte Conversão de esquemas de banco de dados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-metadata-model-creation.

AWS CLI

Para criar um modelo de metadados para uma instrução SQL

O start-metadata-model-creation exemplo a seguir coloca em fila a criação de um modelo de metadados para uma instrução SQL. A regra de seleção especifica o esquema em que o modelo de metadados é colocado e --metadata-model-name fornece um identificador exclusivo para uso em operações subsequentes.

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;"}

Saída:

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

Para obter mais informações, consulte Criação de modelos de metadados de declarações no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-metadata-model-export-as-script.

AWS CLI

Para exportar modelos de metadados convertidos como scripts DDL

O start-metadata-model-export-as-script exemplo a seguir coloca em fila uma exportação de modelos de metadados convertidos para todos os objetos no ExampleSchema esquema como scripts de linguagem de definição de dados (DDL) para o bucket do Amazon S3 associado ao projeto de migração.

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

Saída:

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

Para obter mais informações, consulte Salvando seu código convertido em um arquivo SQL no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-metadata-model-export-to-target.

AWS CLI

Para exportar modelos de metadados convertidos para o banco de dados de destino

O start-metadata-model-export-to-target exemplo a seguir coloca em fila uma exportação de modelos de metadados convertidos de todos os objetos no ExampleSchema esquema para o banco de dados de destino.

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

Saída:

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

Para obter mais informações, consulte Aplicando seu código convertido no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-metadata-model-import.

AWS CLI

Para importar metadados do banco de dados de origem

O start-metadata-model-import exemplo a seguir coloca em fila uma importação de metadados para todos os objetos no ExampleSchema esquema do banco de dados de origem.

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

Saída:

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

Para obter mais informações, consulte Navegando na árvore do modelo de metadados no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-replication-task-assessment.

AWS CLI

Para iniciar uma avaliação de tarefas

O exemplo start-replication-task-assessment a seguir inicia uma avaliação da tarefa de replicação.

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

Saída:

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

Para obter mais informações, consulte Criação de um relatório de avaliação de tarefas no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar start-replication-task.

AWS CLI

Para iniciar uma tarefa de replicação

O command-name exemplo a seguir lista os widgets disponíveis na sua AWS conta.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com tarefas do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar stop-replication-task.

AWS CLI

Para interromper uma tarefa

O exemplo stop-replication-task a seguir interrompe uma tarefa.

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

Saída:

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

Para obter mais informações, consulte Trabalhando com tarefas do AWS DMS no Guia do Usuário do AWS Database Migration Service.

O código de exemplo a seguir mostra como usar test-connection.

AWS CLI

Para testar uma conexão com um endpoint

O exemplo test-connection a seguir testa se um endpoint pode ser acessado a partir de uma instância de replicação.

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

Saída:

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

Para obter mais informações, consulte Criação de endpoints de origem e destino no Guia do usuário do AWS Database Migration Service.

  • Para obter detalhes da API, consulte TestConnectionem Referência de AWS CLI Comandos.