AWS DMS を使用した例 AWS CLI - AWS Command Line Interface
アクション

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS DMS を使用した例 AWS CLI

次のコード例は、 AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS DMS。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

次の例は、add-tags-to-resource を使用する方法を説明しています。

AWS CLI

リソースにタグを追加するには

次のadd-tags-to-resource例では、レプリケーションインスタンスにタグを追加します。

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

このコマンドでは何も出力されません。

詳細については、AWS 「データベース移行サービスユーザーガイド」の「リソースのタグ付け」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスAddTagsToResource」の「」を参照してください。

次の例は、create-endpoint を使用する方法を説明しています。

AWS CLI

エンドポイントを作成するには

次のcreate-endpoint例では、Amazon S3 ソースのエンドポイントを作成します。

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

s3-settings.json の内容:

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「エンドポイントの使用 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateEndpoint」の「」を参照してください。

次のコード例は、create-event-subscription を使用する方法を示しています。

AWS CLI

イベントサブスクリプションを一覧表示するには

次のcreate-event-subscription例では、Amazon SNSトピック () へのイベントサブスクリプションを作成しますmy-sns-topic。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「イベントと通知の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateEventSubscription」の「」を参照してください。

次のコード例は、create-replication-instance を使用する方法を示しています。

AWS CLI

レプリケーションインスタンスを作成するには

次のcreate-replication-instance例では、レプリケーションインスタンスを作成します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」のAWS DMS「レプリケーションインスタンスの使用」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateReplicationInstance」の「」を参照してください。

次のコード例は、create-replication-subnet-group を使用する方法を示しています。

AWS CLI

サブネットグループを作成するには

次のcreate-replication-subnet-group例では、3 つのサブネットで構成されるグループを作成します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「レプリケーションインスタンスのネットワークのセットアップ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateReplicationSubnetGroup」の「」を参照してください。

次のコード例は、create-replication-task を使用する方法を示しています。

AWS CLI

レプリケーションタスクを作成するには

次のcreate-replication-task例では、レプリケーションタスクを作成します。

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

table-mappings.json の内容:

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「タスクの操作 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateReplicationTask」の「」を参照してください。

次の例は、delete-connection を使用する方法を説明しています。

AWS CLI

接続を削除するには

次のdelete-connection例では、レプリケーションインスタンスからエンドポイントの関連付けを解除します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」のhttps://docs.aws.amazon.com/dms/latest/userguide/CHAP「_Endpoints.Creating.html」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteConnection」の「」を参照してください。

次の例は、delete-endpoint を使用する方法を説明しています。

AWS CLI

エンドポイントを削除するには

次のdelete-endpoint例では、エンドポイントを削除します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「エンドポイントの使用 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteEndpoint」の「」を参照してください。

次のコード例は、delete-event-subscription を使用する方法を示しています。

AWS CLI

イベントサブスクリプションを削除するには

次のdelete-event-subscription例では、Amazon SNSトピックのサブスクリプションを削除します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「イベントと通知の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteEventSubscription」の「」を参照してください。

次のコード例は、delete-replication-instance を使用する方法を示しています。

AWS CLI

レプリケーションインスタンスを削除するには

次の delete-replication-instance の例では、レプリケーション インスタンスを削除します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」のAWS DMS「レプリケーションインスタンスの使用」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteReplicationInstance」の「」を参照してください。

次の例は、delete-replication-subnet-group を使用する方法を説明しています。

AWS CLI

サブネットグループを削除するには

次のdelete-replication-subnet-group例では、サブネットグループを削除します。

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

出力:

(none)

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「レプリケーションインスタンスのネットワークのセットアップ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteReplicationSubnetGroup」の「」を参照してください。

次の例は、delete-replication-task を使用する方法を説明しています。

AWS CLI

レプリケーションタスクを削除するには

次のdelete-replication-task例では、レプリケーションタスクを削除します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「タスクの操作 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteReplicationTask」の「」を参照してください。

次のコード例は、describe-account-attributes を使用する方法を示しています。

AWS CLI

アカウントの属性を記述するには

次のdescribe-account-attributes例では、 AWS アカウントの属性を一覧表示します。

aws dms describe-account-attributes

出力:

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

        ...remaining output omitted...

    ],
    "UniqueAccountIdentifier": "cqahfbfy5xee"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeAccountAttributes」の「」を参照してください。

次の例は、describe-certificates を使用する方法を説明しています。

AWS CLI

使用可能な証明書を一覧表示するには

次のdescribe-certificates例では、 AWS アカウントで使用可能な証明書を一覧表示します。

aws dms describe-certificates

出力:

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

            ... remaining output omittted ...

        }
    ]
}

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「 の使用SSL」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeCertificates」の「」を参照してください。

次の例は、describe-connections を使用する方法を説明しています。

AWS CLI

接続を記述するには

次のdescribe-connections例は、レプリケーションインスタンスとエンドポイントの間でテストした接続を一覧表示します。

aws dms describe-connections

出力:

{
    "Connections": [
        {
            "Status": "successful",
            "ReplicationInstanceIdentifier": "test",
            "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
            "EndpointIdentifier": "testsrc1",
            "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
        }
    ]
}

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「ソースエンドポイントとターゲットエンドポイントの作成」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeConnections」の「」を参照してください。

次のコード例は、describe-endpoint-types を使用する方法を示しています。

AWS CLI

使用可能なエンドポイントタイプを一覧表示するには

次のdescribe-endpoint-types例では、使用可能な MySQL エンドポイントタイプを一覧表示します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「エンドポイントの使用 AWS DMS」＜https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html>`__」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEndpointTypes」の「」を参照してください。

次の例は、describe-endpoints を使用する方法を説明しています。

AWS CLI

エンドポイントを記述するには

次のdescribe-endpoints例では、 AWS アカウントのエンドポイントを一覧表示します。

aws dms describe-endpoints

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「エンドポイントの使用 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEndpoints」の「」を参照してください。

次のコード例は、describe-event-categories を使用する方法を示しています。

AWS CLI

イベントカテゴリを記述するには

次のdescribe-event-categories例では、使用可能なイベントカテゴリを一覧表示します。

aws dms describe-event-categories

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「イベントと通知の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEventCategories」の「」を参照してください。

次の例は、describe-event-subscriptions を使用する方法を説明しています。

AWS CLI

イベントサブスクリプションを記述するには

次のdescribe-event-subscriptions例では、Amazon SNSトピックへのイベントサブスクリプションを一覧表示します。

aws dms describe-event-subscriptions

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「イベントと通知の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEventSubscriptions」の「」を参照してください。

次のコード例は、describe-events を使用する方法を示しています。

AWS CLI

DMSイベントを一覧表示するには

次のdescribe-events例では、レプリケーションインスタンスから発生したイベントを一覧表示します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「イベントと通知の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeEvents」の「」を参照してください。

次の例は、describe-orderable-replication-instances を使用する方法を説明しています。

AWS CLI

注文可能なレプリケーションインスタンスを記述するには

次のdescribe-orderable-replication-instances例では、注文できるレプリケーションインスタンスタイプを一覧表示します。

aws dms describe-orderable-replication-instances

出力:

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

        ...remaining output omitted...

    }

詳細については、AWS 「 Database Migration Service ユーザーガイド」のAWS DMS「レプリケーションインスタンスの使用」を参照してください。

次の例は、describe-refresh-schemas-status を使用する方法を説明しています。

AWS CLI

エンドポイントの更新ステータスを一覧表示するには

次のdescribe-refresh-schemas-status例では、以前の更新リクエストのステータスを返します。

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

出力:

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

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeRefreshSchemasStatus」の「」を参照してください。

次の例は、describe-replication-instances を使用する方法を説明しています。

AWS CLI

レプリケーションインスタンスを記述するには

次のdescribe-replication-instances例では、 AWS アカウントのレプリケーションインスタンスを一覧表示します。

aws dms describe-replication-instances

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」のAWS DMS「レプリケーションインスタンスの使用」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeReplicationInstances」の「」を参照してください。

次のコード例は、describe-replication-subnet-groups を使用する方法を示しています。

AWS CLI

使用可能なサブネットグループを表示するには

次のdescribe-replication-subnet-groups例では、使用可能なサブネットグループを一覧表示します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「レプリケーションインスタンスのネットワークのセットアップ」を参照してください。

次の例は、describe-replication-task-assessment-results を使用する方法を説明しています。

AWS CLI

レプリケーションタスク評価の結果を一覧表示するには

次のdescribe-replication-task-assessment-results例では、以前のタスク評価の結果を一覧表示します。

aws dms describe-replication-task-assessment-results

出力:

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

詳細については、「 Database Migration Service ユーザーガイド」の「タスク評価レポートの作成」を参照してください。 AWS

次の例は、describe-replication-tasks を使用する方法を説明しています。

AWS CLI

レプリケーションタスクを記述するには

次のdescribe-replication-tasks例では、現在のレプリケーションタスクについて説明します。

aws dms describe-replication-tasks

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「タスクの操作 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeReplicationTasks」の「」を参照してください。

次の例は、describe-schemas を使用する方法を説明しています。

AWS CLI

データベーススキーマを記述するには

次のdescribe-schemas例では、エンドポイントで使用可能なテーブルを一覧表示します。

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

出力:

{
    "Schemas": [
        "prodrep"
    ]
}

詳細については、AWS 「データベース移行サービスユーザーガイド」の「これはトピックタイトルです」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeSchemas」の「」を参照してください。

次のコード例は、list-tags-for-resource を使用する方法を示しています。

AWS CLI

リソースのタグを一覧表示するには

次のlist-tags-for-resource例では、レプリケーションインスタンスのタグを一覧表示します。

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

出力:

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

詳細については、AWS 「データベース移行サービスユーザーガイド」の「リソースのタグ付け」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスListTagsForResource」の「」を参照してください。

次のコード例は、modify-endpoint を使用する方法を示しています。

AWS CLI

エンドポイントを変更するには

次のmodify-endpoint例では、エンドポイントに追加の接続属性を追加します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「エンドポイントの使用 AWS DMS」＜https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html>`__」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスModifyEndpoint」の「」を参照してください。

次のコード例は、modify-event-subscription を使用する方法を示しています。

AWS CLI

イベントサブスクリプションを変更するには

次のmodify-event-subscription例では、イベントサブスクリプションのソースタイプを変更します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「イベントと通知の操作」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスModifyEventSubscription」の「」を参照してください。

次のコード例は、modify-replication-instance を使用する方法を示しています。

AWS CLI

レプリケーションインスタンスを変更するには

次のmodify-replication-instance例では、マルチ AZ デプロイを使用するようにレプリケーションインスタンスを変更します。

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

出力:

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

        ...output omitted...

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

        ...output omitted...

    }
}

詳細については、AWS 「 Database Migration Service ユーザーガイド」のAWS DMS「レプリケーションインスタンスの使用」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスModifyReplicationInstance」の「」を参照してください。

次の例は、modify-replication-subnet-group を使用する方法を説明しています。

AWS CLI

サブネットグループを変更するには

次のmodify-replication-subnet-group例では、サブネットグループに関連付けられたサブネットのリストを変更します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「レプリケーションインスタンスのネットワークのセットアップ」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスModifyReplicationSubnetGroup」の「」を参照してください。

次のコード例は、modify-replication-task を使用する方法を示しています。

AWS CLI

レプリケーションタスクを変更するには

次のmodify-replication-task例では、タスクのテーブルマッピングを変更します。

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

table-mappings.json の内容:

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「タスクの操作 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスModifyReplicationTask」の「」を参照してください。

次の例は、reboot-replication-instance を使用する方法を説明しています。

AWS CLI

レプリケーションインスタンスを再起動するには

次の reboot-replication-instance の例では、レプリケーション インスタンスを再起動します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」のAWS DMS「レプリケーションインスタンスの使用」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスRebootReplicationInstance」の「」を参照してください。

次のコード例は、refresh-schemas を使用する方法を示しています。

AWS CLI

データベーススキーマを更新するには

次のrefresh-schemas例では、エンドポイントのスキーマのリストを更新するリクエスト AWS DMSをリクエストします。

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

出力:

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

  • API 詳細については、AWS CLI 「 コマンドリファレンスRefreshSchemas」の「」を参照してください。

次の例は、reload-tables を使用する方法を説明しています。

AWS CLI

エンドポイントで使用できるテーブルのリストを更新するには

次のreload-tables例では、エンドポイントで使用可能なテーブルのリストを再ロードします。

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

出力:

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

  • API 詳細については、AWS CLI 「 コマンドリファレンスReloadTables」の「」を参照してください。

次の例は、remove-tags-from-resource を使用する方法を説明しています。

AWS CLI

レプリケーションインスタンスからタグを削除するには

次のremove-tags-from-resource例では、レプリケーションインスタンスからタグを削除します。

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

このコマンドでは何も出力されません。

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「リソースのタグ付け」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスRemoveTagsFromResource」の「」を参照してください。

次のコード例は、start-replication-task-assessment を使用する方法を示しています。

AWS CLI

タスク評価を開始するには

次のstart-replication-task-assessment例では、レプリケーションタスクの評価を開始します。

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

出力:

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

詳細については、「 Database Migration Service ユーザーガイド」の「タスク評価レポートの作成」を参照してください。 AWS

次の例は、start-replication-task を使用する方法を説明しています。

AWS CLI

レプリケーションタスクを開始するには

次のcommand-name例では、 AWS アカウントで使用可能なウィジェットを一覧表示します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「タスクの操作 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスStartReplicationTask」の「」を参照してください。

次のコード例は、stop-replication-task を使用する方法を示しています。

AWS CLI

タスクを停止するには

次のstop-replication-task例では、タスクを停止します。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「タスクの操作 AWS DMS」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスStopReplicationTask」の「」を参照してください。

次のコード例は、test-connection を使用する方法を示しています。

AWS CLI

エンドポイントへの接続をテストするには

次のtest-connection例では、レプリケーションインスタンスからエンドポイントにアクセスできるかどうかをテストします。

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

出力:

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

詳細については、AWS 「 Database Migration Service ユーザーガイド」の「ソースエンドポイントとターゲットエンドポイントの作成」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスTestConnection」の「」を参照してください。