@aws-sdk/client-database-migration-service 3.288.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist-types/commands/AddTagsToResourceCommand.d.ts +17 -0
  2. package/dist-types/commands/CreateEndpointCommand.d.ts +43 -0
  3. package/dist-types/commands/CreateReplicationInstanceCommand.d.ts +81 -0
  4. package/dist-types/commands/CreateReplicationSubnetGroupCommand.d.ts +27 -0
  5. package/dist-types/commands/CreateReplicationTaskCommand.d.ts +40 -0
  6. package/dist-types/commands/DeleteCertificateCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteConnectionCommand.d.ts +17 -0
  8. package/dist-types/commands/DeleteEndpointCommand.d.ts +27 -0
  9. package/dist-types/commands/DeleteReplicationInstanceCommand.d.ts +66 -0
  10. package/dist-types/commands/DeleteReplicationSubnetGroupCommand.d.ts +11 -0
  11. package/dist-types/commands/DeleteReplicationTaskCommand.d.ts +27 -0
  12. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +30 -0
  13. package/dist-types/commands/DescribeCertificatesCommand.d.ts +27 -0
  14. package/dist-types/commands/DescribeConnectionsCommand.d.ts +35 -0
  15. package/dist-types/commands/DescribeEndpointTypesCommand.d.ts +27 -0
  16. package/dist-types/commands/DescribeEndpointsCommand.d.ts +27 -0
  17. package/dist-types/commands/DescribeOrderableReplicationInstancesCommand.d.ts +18 -0
  18. package/dist-types/commands/DescribeRefreshSchemasStatusCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeReplicationInstancesCommand.d.ts +27 -0
  20. package/dist-types/commands/DescribeReplicationSubnetGroupsCommand.d.ts +27 -0
  21. package/dist-types/commands/DescribeReplicationTasksCommand.d.ts +27 -0
  22. package/dist-types/commands/DescribeSchemasCommand.d.ts +19 -0
  23. package/dist-types/commands/DescribeTableStatisticsCommand.d.ts +20 -0
  24. package/dist-types/commands/ImportCertificateCommand.d.ts +17 -0
  25. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/ModifyEndpointCommand.d.ts +27 -0
  27. package/dist-types/commands/ModifyReplicationInstanceCommand.d.ts +74 -0
  28. package/dist-types/commands/ModifyReplicationSubnetGroupCommand.d.ts +18 -0
  29. package/dist-types/commands/RefreshSchemasCommand.d.ts +17 -0
  30. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +12 -0
  31. package/dist-types/commands/StartReplicationTaskCommand.d.ts +29 -0
  32. package/dist-types/commands/StopReplicationTaskCommand.d.ts +27 -0
  33. package/dist-types/commands/TestConnectionCommand.d.ts +17 -0
  34. package/package.json +30 -30
@@ -34,6 +34,23 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceRespons
34
34
  * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @example Add tags to resource
38
+ * ```javascript
39
+ * // Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.
40
+ * const input = {
41
+ * "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E",
42
+ * "Tags": [
43
+ * {
44
+ * "Key": "Acount",
45
+ * "Value": "1633456"
46
+ * }
47
+ * ]
48
+ * };
49
+ * const command = new AddTagsToResourceCommand(input);
50
+ * await client.send(command);
51
+ * // example id: add-tags-to-resource-1481744141435
52
+ * ```
53
+ *
37
54
  */
38
55
  export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
56
  readonly input: AddTagsToResourceCommandInput;
@@ -36,6 +36,49 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
36
36
  * @see {@link CreateEndpointCommandOutput} for command's `response` shape.
37
37
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
38
38
  *
39
+ * @example Create endpoint
40
+ * ```javascript
41
+ * // Creates an endpoint using the provided settings.
42
+ * const input = {
43
+ * "CertificateArn": "",
44
+ * "DatabaseName": "testdb",
45
+ * "EndpointIdentifier": "test-endpoint-1",
46
+ * "EndpointType": "source",
47
+ * "EngineName": "mysql",
48
+ * "ExtraConnectionAttributes": "",
49
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
50
+ * "Password": "pasword",
51
+ * "Port": 3306,
52
+ * "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
53
+ * "SslMode": "require",
54
+ * "Tags": [
55
+ * {
56
+ * "Key": "Acount",
57
+ * "Value": "143327655"
58
+ * }
59
+ * ],
60
+ * "Username": "username"
61
+ * };
62
+ * const command = new CreateEndpointCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "Endpoint": {
67
+ * "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
68
+ * "EndpointIdentifier": "test-endpoint-1",
69
+ * "EndpointType": "source",
70
+ * "EngineName": "mysql",
71
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
72
+ * "Port": 3306,
73
+ * "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
74
+ * "Status": "active",
75
+ * "Username": "username"
76
+ * }
77
+ * }
78
+ * *\/
79
+ * // example id: create-endpoint-1481746254348
80
+ * ```
81
+ *
39
82
  */
40
83
  export declare class CreateEndpointCommand extends $Command<CreateEndpointCommandInput, CreateEndpointCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
41
84
  readonly input: CreateEndpointCommandInput;
@@ -34,6 +34,87 @@ export interface CreateReplicationInstanceCommandOutput extends CreateReplicatio
34
34
  * @see {@link CreateReplicationInstanceCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @example Create replication instance
38
+ * ```javascript
39
+ * // Creates the replication instance using the specified parameters.
40
+ * const input = {
41
+ * "AllocatedStorage": 123,
42
+ * "AutoMinorVersionUpgrade": true,
43
+ * "AvailabilityZone": "",
44
+ * "EngineVersion": "",
45
+ * "KmsKeyId": "",
46
+ * "MultiAZ": true,
47
+ * "PreferredMaintenanceWindow": "",
48
+ * "PubliclyAccessible": true,
49
+ * "ReplicationInstanceClass": "",
50
+ * "ReplicationInstanceIdentifier": "",
51
+ * "ReplicationSubnetGroupIdentifier": "",
52
+ * "Tags": [
53
+ * {
54
+ * "Key": "string",
55
+ * "Value": "string"
56
+ * }
57
+ * ],
58
+ * "VpcSecurityGroupIds": []
59
+ * };
60
+ * const command = new CreateReplicationInstanceCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "ReplicationInstance": {
65
+ * "AllocatedStorage": 5,
66
+ * "AutoMinorVersionUpgrade": true,
67
+ * "EngineVersion": "1.5.0",
68
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
69
+ * "PendingModifiedValues": {},
70
+ * "PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
71
+ * "PubliclyAccessible": true,
72
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
73
+ * "ReplicationInstanceClass": "dms.t2.micro",
74
+ * "ReplicationInstanceIdentifier": "test-rep-1",
75
+ * "ReplicationInstanceStatus": "creating",
76
+ * "ReplicationSubnetGroup": {
77
+ * "ReplicationSubnetGroupDescription": "default",
78
+ * "ReplicationSubnetGroupIdentifier": "default",
79
+ * "SubnetGroupStatus": "Complete",
80
+ * "Subnets": [
81
+ * {
82
+ * "SubnetAvailabilityZone": {
83
+ * "Name": "us-east-1d"
84
+ * },
85
+ * "SubnetIdentifier": "subnet-f6dd91af",
86
+ * "SubnetStatus": "Active"
87
+ * },
88
+ * {
89
+ * "SubnetAvailabilityZone": {
90
+ * "Name": "us-east-1b"
91
+ * },
92
+ * "SubnetIdentifier": "subnet-3605751d",
93
+ * "SubnetStatus": "Active"
94
+ * },
95
+ * {
96
+ * "SubnetAvailabilityZone": {
97
+ * "Name": "us-east-1c"
98
+ * },
99
+ * "SubnetIdentifier": "subnet-c2daefb5",
100
+ * "SubnetStatus": "Active"
101
+ * },
102
+ * {
103
+ * "SubnetAvailabilityZone": {
104
+ * "Name": "us-east-1e"
105
+ * },
106
+ * "SubnetIdentifier": "subnet-85e90cb8",
107
+ * "SubnetStatus": "Active"
108
+ * }
109
+ * ],
110
+ * "VpcId": "vpc-6741a603"
111
+ * }
112
+ * }
113
+ * }
114
+ * *\/
115
+ * // example id: create-replication-instance-1481746705295
116
+ * ```
117
+ *
37
118
  */
38
119
  export declare class CreateReplicationInstanceCommand extends $Command<CreateReplicationInstanceCommandInput, CreateReplicationInstanceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
120
  readonly input: CreateReplicationInstanceCommandInput;
@@ -31,6 +31,33 @@ export interface CreateReplicationSubnetGroupCommandOutput extends CreateReplica
31
31
  * @see {@link CreateReplicationSubnetGroupCommandOutput} for command's `response` shape.
32
32
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
33
33
  *
34
+ * @example Create replication subnet group
35
+ * ```javascript
36
+ * // Creates a replication subnet group given a list of the subnet IDs in a VPC.
37
+ * const input = {
38
+ * "ReplicationSubnetGroupDescription": "US West subnet group",
39
+ * "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366",
40
+ * "SubnetIds": [
41
+ * "subnet-e145356n",
42
+ * "subnet-58f79200"
43
+ * ],
44
+ * "Tags": [
45
+ * {
46
+ * "Key": "Acount",
47
+ * "Value": "145235"
48
+ * }
49
+ * ]
50
+ * };
51
+ * const command = new CreateReplicationSubnetGroupCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ReplicationSubnetGroup": {}
56
+ * }
57
+ * *\/
58
+ * // example id: create-replication-subnet-group-1481747297930
59
+ * ```
60
+ *
34
61
  */
35
62
  export declare class CreateReplicationSubnetGroupCommand extends $Command<CreateReplicationSubnetGroupCommandInput, CreateReplicationSubnetGroupCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
36
63
  readonly input: CreateReplicationSubnetGroupCommandInput;
@@ -29,6 +29,46 @@ export interface CreateReplicationTaskCommandOutput extends CreateReplicationTas
29
29
  * @see {@link CreateReplicationTaskCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Create replication task
33
+ * ```javascript
34
+ * // Creates a replication task using the specified parameters.
35
+ * const input = {
36
+ * "CdcStartTime": "2016-12-14T18:25:43Z",
37
+ * "MigrationType": "full-load",
38
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
39
+ * "ReplicationTaskIdentifier": "task1",
40
+ * "ReplicationTaskSettings": "",
41
+ * "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
42
+ * "TableMappings": "file://mappingfile.json",
43
+ * "Tags": [
44
+ * {
45
+ * "Key": "Acount",
46
+ * "Value": "24352226"
47
+ * }
48
+ * ],
49
+ * "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
50
+ * };
51
+ * const command = new CreateReplicationTaskCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ReplicationTask": {
56
+ * "MigrationType": "full-load",
57
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
58
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
59
+ * "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
60
+ * "ReplicationTaskIdentifier": "task1",
61
+ * "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
62
+ * "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
63
+ * "Status": "creating",
64
+ * "TableMappings": "file://mappingfile.json",
65
+ * "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
66
+ * }
67
+ * }
68
+ * *\/
69
+ * // example id: create-replication-task-1481747646288
70
+ * ```
71
+ *
32
72
  */
33
73
  export declare class CreateReplicationTaskCommand extends $Command<CreateReplicationTaskCommandInput, CreateReplicationTaskCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
74
  readonly input: CreateReplicationTaskCommandInput;
@@ -29,6 +29,22 @@ export interface DeleteCertificateCommandOutput extends DeleteCertificateRespons
29
29
  * @see {@link DeleteCertificateCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Delete Certificate
33
+ * ```javascript
34
+ * // Deletes the specified certificate.
35
+ * const input = {
36
+ * "CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ"
37
+ * };
38
+ * const command = new DeleteCertificateCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "Certificate": {}
43
+ * }
44
+ * *\/
45
+ * // example id: delete-certificate-1481751957981
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DeleteCertificateCommand extends $Command<DeleteCertificateCommandInput, DeleteCertificateCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
50
  readonly input: DeleteCertificateCommandInput;
@@ -29,6 +29,23 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse,
29
29
  * @see {@link DeleteConnectionCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Delete Connection
33
+ * ```javascript
34
+ * // Deletes the connection between the replication instance and the endpoint.
35
+ * const input = {
36
+ * "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
37
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
38
+ * };
39
+ * const command = new DeleteConnectionCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Connection": {}
44
+ * }
45
+ * *\/
46
+ * // example id: delete-connection-1481751957981
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class DeleteConnectionCommand extends $Command<DeleteConnectionCommandInput, DeleteConnectionCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
51
  readonly input: DeleteConnectionCommandInput;
@@ -34,6 +34,33 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
34
34
  * @see {@link DeleteEndpointCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @example Delete Endpoint
38
+ * ```javascript
39
+ * // Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
40
+ * //
41
+ * const input = {
42
+ * "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM"
43
+ * };
44
+ * const command = new DeleteEndpointCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Endpoint": {
49
+ * "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
50
+ * "EndpointIdentifier": "test-endpoint-1",
51
+ * "EndpointType": "source",
52
+ * "EngineName": "mysql",
53
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
54
+ * "Port": 3306,
55
+ * "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
56
+ * "Status": "active",
57
+ * "Username": "username"
58
+ * }
59
+ * }
60
+ * *\/
61
+ * // example id: delete-endpoint-1481752425530
62
+ * ```
63
+ *
37
64
  */
38
65
  export declare class DeleteEndpointCommand extends $Command<DeleteEndpointCommandInput, DeleteEndpointCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
66
  readonly input: DeleteEndpointCommandInput;
@@ -34,6 +34,72 @@ export interface DeleteReplicationInstanceCommandOutput extends DeleteReplicatio
34
34
  * @see {@link DeleteReplicationInstanceCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @example Delete Replication Instance
38
+ * ```javascript
39
+ * // Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
40
+ * //
41
+ * //
42
+ * const input = {
43
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
44
+ * };
45
+ * const command = new DeleteReplicationInstanceCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "ReplicationInstance": {
50
+ * "AllocatedStorage": 5,
51
+ * "AutoMinorVersionUpgrade": true,
52
+ * "EngineVersion": "1.5.0",
53
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
54
+ * "PendingModifiedValues": {},
55
+ * "PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
56
+ * "PubliclyAccessible": true,
57
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
58
+ * "ReplicationInstanceClass": "dms.t2.micro",
59
+ * "ReplicationInstanceIdentifier": "test-rep-1",
60
+ * "ReplicationInstanceStatus": "creating",
61
+ * "ReplicationSubnetGroup": {
62
+ * "ReplicationSubnetGroupDescription": "default",
63
+ * "ReplicationSubnetGroupIdentifier": "default",
64
+ * "SubnetGroupStatus": "Complete",
65
+ * "Subnets": [
66
+ * {
67
+ * "SubnetAvailabilityZone": {
68
+ * "Name": "us-east-1d"
69
+ * },
70
+ * "SubnetIdentifier": "subnet-f6dd91af",
71
+ * "SubnetStatus": "Active"
72
+ * },
73
+ * {
74
+ * "SubnetAvailabilityZone": {
75
+ * "Name": "us-east-1b"
76
+ * },
77
+ * "SubnetIdentifier": "subnet-3605751d",
78
+ * "SubnetStatus": "Active"
79
+ * },
80
+ * {
81
+ * "SubnetAvailabilityZone": {
82
+ * "Name": "us-east-1c"
83
+ * },
84
+ * "SubnetIdentifier": "subnet-c2daefb5",
85
+ * "SubnetStatus": "Active"
86
+ * },
87
+ * {
88
+ * "SubnetAvailabilityZone": {
89
+ * "Name": "us-east-1e"
90
+ * },
91
+ * "SubnetIdentifier": "subnet-85e90cb8",
92
+ * "SubnetStatus": "Active"
93
+ * }
94
+ * ],
95
+ * "VpcId": "vpc-6741a603"
96
+ * }
97
+ * }
98
+ * }
99
+ * *\/
100
+ * // example id: delete-replication-instance-1481752552839
101
+ * ```
102
+ *
37
103
  */
38
104
  export declare class DeleteReplicationInstanceCommand extends $Command<DeleteReplicationInstanceCommandInput, DeleteReplicationInstanceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
105
  readonly input: DeleteReplicationInstanceCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteReplicationSubnetGroupCommandOutput extends DeleteReplica
29
29
  * @see {@link DeleteReplicationSubnetGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Delete Replication Subnet Group
33
+ * ```javascript
34
+ * // Deletes a replication subnet group.
35
+ * const input = {
36
+ * "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366"
37
+ * };
38
+ * const command = new DeleteReplicationSubnetGroupCommand(input);
39
+ * await client.send(command);
40
+ * // example id: delete-replication-subnet-group-1481752728597
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteReplicationSubnetGroupCommand extends $Command<DeleteReplicationSubnetGroupCommandInput, DeleteReplicationSubnetGroupCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
45
  readonly input: DeleteReplicationSubnetGroupCommandInput;
@@ -29,6 +29,33 @@ export interface DeleteReplicationTaskCommandOutput extends DeleteReplicationTas
29
29
  * @see {@link DeleteReplicationTaskCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Delete Replication Task
33
+ * ```javascript
34
+ * // Deletes the specified replication task.
35
+ * const input = {
36
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
37
+ * };
38
+ * const command = new DeleteReplicationTaskCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "ReplicationTask": {
43
+ * "MigrationType": "full-load",
44
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
45
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
46
+ * "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
47
+ * "ReplicationTaskIdentifier": "task1",
48
+ * "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
49
+ * "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
50
+ * "Status": "creating",
51
+ * "TableMappings": "file://mappingfile.json",
52
+ * "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
53
+ * }
54
+ * }
55
+ * *\/
56
+ * // example id: delete-replication-task-1481752903506
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class DeleteReplicationTaskCommand extends $Command<DeleteReplicationTaskCommandInput, DeleteReplicationTaskCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
61
  readonly input: DeleteReplicationTaskCommandInput;
@@ -35,6 +35,36 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
35
35
  * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape.
36
36
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
37
37
  *
38
+ * @example Describe acount attributes
39
+ * ```javascript
40
+ * // Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.
41
+ * const input = {};
42
+ * const command = new DescribeAccountAttributesCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "AccountQuotas": [
47
+ * {
48
+ * "AccountQuotaName": "ReplicationInstances",
49
+ * "Max": 20,
50
+ * "Used": 0
51
+ * },
52
+ * {
53
+ * "AccountQuotaName": "AllocatedStorage",
54
+ * "Max": 20,
55
+ * "Used": 0
56
+ * },
57
+ * {
58
+ * "AccountQuotaName": "Endpoints",
59
+ * "Max": 20,
60
+ * "Used": 0
61
+ * }
62
+ * ]
63
+ * }
64
+ * *\/
65
+ * // example id: describe-acount-attributes-1481753085663
66
+ * ```
67
+ *
38
68
  */
39
69
  export declare class DescribeAccountAttributesCommand extends $Command<DescribeAccountAttributesCommandInput, DescribeAccountAttributesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
40
70
  readonly input: DescribeAccountAttributesCommandInput;
@@ -29,6 +29,33 @@ export interface DescribeCertificatesCommandOutput extends DescribeCertificatesR
29
29
  * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Describe certificates
33
+ * ```javascript
34
+ * // Provides a description of the certificate.
35
+ * const input = {
36
+ * "Filters": [
37
+ * {
38
+ * "Name": "string",
39
+ * "Values": [
40
+ * "string",
41
+ * "string"
42
+ * ]
43
+ * }
44
+ * ],
45
+ * "Marker": "",
46
+ * "MaxRecords": 123
47
+ * };
48
+ * const command = new DescribeCertificatesCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Certificates": [],
53
+ * "Marker": ""
54
+ * }
55
+ * *\/
56
+ * // example id: describe-certificates-1481753186244
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class DescribeCertificatesCommand extends $Command<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
61
  readonly input: DescribeCertificatesCommandInput;
@@ -30,6 +30,41 @@ export interface DescribeConnectionsCommandOutput extends DescribeConnectionsRes
30
30
  * @see {@link DescribeConnectionsCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @example Describe connections
34
+ * ```javascript
35
+ * // Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
36
+ * const input = {
37
+ * "Filters": [
38
+ * {
39
+ * "Name": "string",
40
+ * "Values": [
41
+ * "string",
42
+ * "string"
43
+ * ]
44
+ * }
45
+ * ],
46
+ * "Marker": "",
47
+ * "MaxRecords": 123
48
+ * };
49
+ * const command = new DescribeConnectionsCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "Connections": [
54
+ * {
55
+ * "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
56
+ * "EndpointIdentifier": "testsrc1",
57
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
58
+ * "ReplicationInstanceIdentifier": "test",
59
+ * "Status": "successful"
60
+ * }
61
+ * ],
62
+ * "Marker": ""
63
+ * }
64
+ * *\/
65
+ * // example id: describe-connections-1481754477953
66
+ * ```
67
+ *
33
68
  */
34
69
  export declare class DescribeConnectionsCommand extends $Command<DescribeConnectionsCommandInput, DescribeConnectionsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
70
  readonly input: DescribeConnectionsCommandInput;
@@ -29,6 +29,33 @@ export interface DescribeEndpointTypesCommandOutput extends DescribeEndpointType
29
29
  * @see {@link DescribeEndpointTypesCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Describe endpoint types
33
+ * ```javascript
34
+ * // Returns information about the type of endpoints available.
35
+ * const input = {
36
+ * "Filters": [
37
+ * {
38
+ * "Name": "string",
39
+ * "Values": [
40
+ * "string",
41
+ * "string"
42
+ * ]
43
+ * }
44
+ * ],
45
+ * "Marker": "",
46
+ * "MaxRecords": 123
47
+ * };
48
+ * const command = new DescribeEndpointTypesCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Marker": "",
53
+ * "SupportedEndpointTypes": []
54
+ * }
55
+ * *\/
56
+ * // example id: describe-endpoint-types-1481754742591
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class DescribeEndpointTypesCommand extends $Command<DescribeEndpointTypesCommandInput, DescribeEndpointTypesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
61
  readonly input: DescribeEndpointTypesCommandInput;
@@ -29,6 +29,33 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
29
29
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Describe endpoints
33
+ * ```javascript
34
+ * // Returns information about the endpoints for your account in the current region.
35
+ * const input = {
36
+ * "Filters": [
37
+ * {
38
+ * "Name": "string",
39
+ * "Values": [
40
+ * "string",
41
+ * "string"
42
+ * ]
43
+ * }
44
+ * ],
45
+ * "Marker": "",
46
+ * "MaxRecords": 123
47
+ * };
48
+ * const command = new DescribeEndpointsCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Endpoints": [],
53
+ * "Marker": ""
54
+ * }
55
+ * *\/
56
+ * // example id: describe-endpoints-1481754926060
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
61
  readonly input: DescribeEndpointsCommandInput;
@@ -30,6 +30,24 @@ export interface DescribeOrderableReplicationInstancesCommandOutput extends Desc
30
30
  * @see {@link DescribeOrderableReplicationInstancesCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @example Describe orderable replication instances
34
+ * ```javascript
35
+ * // Returns information about the replication instance types that can be created in the specified region.
36
+ * const input = {
37
+ * "Marker": "",
38
+ * "MaxRecords": 123
39
+ * };
40
+ * const command = new DescribeOrderableReplicationInstancesCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "Marker": "",
45
+ * "OrderableReplicationInstances": []
46
+ * }
47
+ * *\/
48
+ * // example id: describe-orderable-replication-instances-1481755123669
49
+ * ```
50
+ *
33
51
  */
34
52
  export declare class DescribeOrderableReplicationInstancesCommand extends $Command<DescribeOrderableReplicationInstancesCommandInput, DescribeOrderableReplicationInstancesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
53
  readonly input: DescribeOrderableReplicationInstancesCommandInput;
@@ -29,6 +29,22 @@ export interface DescribeRefreshSchemasStatusCommandOutput extends DescribeRefre
29
29
  * @see {@link DescribeRefreshSchemasStatusCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Describe refresh schema status
33
+ * ```javascript
34
+ * // Returns the status of the refresh-schemas operation.
35
+ * const input = {
36
+ * "EndpointArn": ""
37
+ * };
38
+ * const command = new DescribeRefreshSchemasStatusCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "RefreshSchemasStatus": {}
43
+ * }
44
+ * *\/
45
+ * // example id: describe-refresh-schema-status-1481755303497
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DescribeRefreshSchemasStatusCommand extends $Command<DescribeRefreshSchemasStatusCommandInput, DescribeRefreshSchemasStatusCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
50
  readonly input: DescribeRefreshSchemasStatusCommandInput;
@@ -30,6 +30,33 @@ export interface DescribeReplicationInstancesCommandOutput extends DescribeRepli
30
30
  * @see {@link DescribeReplicationInstancesCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @example Describe replication instances
34
+ * ```javascript
35
+ * // Returns the status of the refresh-schemas operation.
36
+ * const input = {
37
+ * "Filters": [
38
+ * {
39
+ * "Name": "string",
40
+ * "Values": [
41
+ * "string",
42
+ * "string"
43
+ * ]
44
+ * }
45
+ * ],
46
+ * "Marker": "",
47
+ * "MaxRecords": 123
48
+ * };
49
+ * const command = new DescribeReplicationInstancesCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "Marker": "",
54
+ * "ReplicationInstances": []
55
+ * }
56
+ * *\/
57
+ * // example id: describe-replication-instances-1481755443952
58
+ * ```
59
+ *
33
60
  */
34
61
  export declare class DescribeReplicationInstancesCommand extends $Command<DescribeReplicationInstancesCommandInput, DescribeReplicationInstancesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
62
  readonly input: DescribeReplicationInstancesCommandInput;
@@ -29,6 +29,33 @@ export interface DescribeReplicationSubnetGroupsCommandOutput extends DescribeRe
29
29
  * @see {@link DescribeReplicationSubnetGroupsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Describe replication subnet groups
33
+ * ```javascript
34
+ * // Returns information about the replication subnet groups.
35
+ * const input = {
36
+ * "Filters": [
37
+ * {
38
+ * "Name": "string",
39
+ * "Values": [
40
+ * "string",
41
+ * "string"
42
+ * ]
43
+ * }
44
+ * ],
45
+ * "Marker": "",
46
+ * "MaxRecords": 123
47
+ * };
48
+ * const command = new DescribeReplicationSubnetGroupsCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Marker": "",
53
+ * "ReplicationSubnetGroups": []
54
+ * }
55
+ * *\/
56
+ * // example id: describe-replication-subnet-groups-1481755621284
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class DescribeReplicationSubnetGroupsCommand extends $Command<DescribeReplicationSubnetGroupsCommandInput, DescribeReplicationSubnetGroupsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
61
  readonly input: DescribeReplicationSubnetGroupsCommandInput;
@@ -30,6 +30,33 @@ export interface DescribeReplicationTasksCommandOutput extends DescribeReplicati
30
30
  * @see {@link DescribeReplicationTasksCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @example Describe replication tasks
34
+ * ```javascript
35
+ * // Returns information about replication tasks for your account in the current region.
36
+ * const input = {
37
+ * "Filters": [
38
+ * {
39
+ * "Name": "string",
40
+ * "Values": [
41
+ * "string",
42
+ * "string"
43
+ * ]
44
+ * }
45
+ * ],
46
+ * "Marker": "",
47
+ * "MaxRecords": 123
48
+ * };
49
+ * const command = new DescribeReplicationTasksCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "Marker": "",
54
+ * "ReplicationTasks": []
55
+ * }
56
+ * *\/
57
+ * // example id: describe-replication-tasks-1481755777563
58
+ * ```
59
+ *
33
60
  */
34
61
  export declare class DescribeReplicationTasksCommand extends $Command<DescribeReplicationTasksCommandInput, DescribeReplicationTasksCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
62
  readonly input: DescribeReplicationTasksCommandInput;
@@ -30,6 +30,25 @@ export interface DescribeSchemasCommandOutput extends DescribeSchemasResponse, _
30
30
  * @see {@link DescribeSchemasCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @example Describe schemas
34
+ * ```javascript
35
+ * // Returns information about the schema for the specified endpoint.
36
+ * const input = {
37
+ * "EndpointArn": "",
38
+ * "Marker": "",
39
+ * "MaxRecords": 123
40
+ * };
41
+ * const command = new DescribeSchemasCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "Marker": "",
46
+ * "Schemas": []
47
+ * }
48
+ * *\/
49
+ * // example id: describe-schemas-1481755933924
50
+ * ```
51
+ *
33
52
  */
34
53
  export declare class DescribeSchemasCommand extends $Command<DescribeSchemasCommandInput, DescribeSchemasCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
54
  readonly input: DescribeSchemasCommandInput;
@@ -33,6 +33,26 @@ export interface DescribeTableStatisticsCommandOutput extends DescribeTableStati
33
33
  * @see {@link DescribeTableStatisticsCommandOutput} for command's `response` shape.
34
34
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
35
35
  *
36
+ * @example Describe table statistics
37
+ * ```javascript
38
+ * // Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
39
+ * const input = {
40
+ * "Marker": "",
41
+ * "MaxRecords": 123,
42
+ * "ReplicationTaskArn": ""
43
+ * };
44
+ * const command = new DescribeTableStatisticsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Marker": "",
49
+ * "ReplicationTaskArn": "",
50
+ * "TableStatistics": []
51
+ * }
52
+ * *\/
53
+ * // example id: describe-table-statistics-1481756071890
54
+ * ```
55
+ *
36
56
  */
37
57
  export declare class DescribeTableStatisticsCommand extends $Command<DescribeTableStatisticsCommandInput, DescribeTableStatisticsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
38
58
  readonly input: DescribeTableStatisticsCommandInput;
@@ -29,6 +29,23 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
29
29
  * @see {@link ImportCertificateCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Import certificate
33
+ * ```javascript
34
+ * // Uploads the specified certificate.
35
+ * const input = {
36
+ * "CertificateIdentifier": "",
37
+ * "CertificatePem": ""
38
+ * };
39
+ * const command = new ImportCertificateCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Certificate": {}
44
+ * }
45
+ * *\/
46
+ * // example id: import-certificate-1481756197206
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class ImportCertificateCommand extends $Command<ImportCertificateCommandInput, ImportCertificateCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
51
  readonly input: ImportCertificateCommandInput;
@@ -33,6 +33,22 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
33
33
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
34
34
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
35
35
  *
36
+ * @example List tags for resource
37
+ * ```javascript
38
+ * // Lists all tags for an AWS DMS resource.
39
+ * const input = {
40
+ * "ResourceArn": ""
41
+ * };
42
+ * const command = new ListTagsForResourceCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "TagList": []
47
+ * }
48
+ * *\/
49
+ * // example id: list-tags-for-resource-1481761095501
50
+ * ```
51
+ *
36
52
  */
37
53
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
38
54
  readonly input: ListTagsForResourceCommandInput;
@@ -36,6 +36,33 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M
36
36
  * @see {@link ModifyEndpointCommandOutput} for command's `response` shape.
37
37
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
38
38
  *
39
+ * @example Modify endpoint
40
+ * ```javascript
41
+ * // Modifies the specified endpoint.
42
+ * const input = {
43
+ * "CertificateArn": "",
44
+ * "DatabaseName": "",
45
+ * "EndpointArn": "",
46
+ * "EndpointIdentifier": "",
47
+ * "EndpointType": "source",
48
+ * "EngineName": "",
49
+ * "ExtraConnectionAttributes": "",
50
+ * "Password": "",
51
+ * "Port": 123,
52
+ * "ServerName": "",
53
+ * "SslMode": "require",
54
+ * "Username": ""
55
+ * };
56
+ * const command = new ModifyEndpointCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "Endpoint": {}
61
+ * }
62
+ * *\/
63
+ * // example id: modify-endpoint-1481761649937
64
+ * ```
65
+ *
39
66
  */
40
67
  export declare class ModifyEndpointCommand extends $Command<ModifyEndpointCommandInput, ModifyEndpointCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
41
68
  readonly input: ModifyEndpointCommandInput;
@@ -32,6 +32,80 @@ export interface ModifyReplicationInstanceCommandOutput extends ModifyReplicatio
32
32
  * @see {@link ModifyReplicationInstanceCommandOutput} for command's `response` shape.
33
33
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
34
34
  *
35
+ * @example Modify replication instance
36
+ * ```javascript
37
+ * // Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
38
+ * const input = {
39
+ * "AllocatedStorage": 123,
40
+ * "AllowMajorVersionUpgrade": true,
41
+ * "ApplyImmediately": true,
42
+ * "AutoMinorVersionUpgrade": true,
43
+ * "EngineVersion": "1.5.0",
44
+ * "MultiAZ": true,
45
+ * "PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
46
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
47
+ * "ReplicationInstanceClass": "dms.t2.micro",
48
+ * "ReplicationInstanceIdentifier": "test-rep-1",
49
+ * "VpcSecurityGroupIds": []
50
+ * };
51
+ * const command = new ModifyReplicationInstanceCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ReplicationInstance": {
56
+ * "AllocatedStorage": 5,
57
+ * "AutoMinorVersionUpgrade": true,
58
+ * "EngineVersion": "1.5.0",
59
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
60
+ * "PendingModifiedValues": {},
61
+ * "PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
62
+ * "PubliclyAccessible": true,
63
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
64
+ * "ReplicationInstanceClass": "dms.t2.micro",
65
+ * "ReplicationInstanceIdentifier": "test-rep-1",
66
+ * "ReplicationInstanceStatus": "available",
67
+ * "ReplicationSubnetGroup": {
68
+ * "ReplicationSubnetGroupDescription": "default",
69
+ * "ReplicationSubnetGroupIdentifier": "default",
70
+ * "SubnetGroupStatus": "Complete",
71
+ * "Subnets": [
72
+ * {
73
+ * "SubnetAvailabilityZone": {
74
+ * "Name": "us-east-1d"
75
+ * },
76
+ * "SubnetIdentifier": "subnet-f6dd91af",
77
+ * "SubnetStatus": "Active"
78
+ * },
79
+ * {
80
+ * "SubnetAvailabilityZone": {
81
+ * "Name": "us-east-1b"
82
+ * },
83
+ * "SubnetIdentifier": "subnet-3605751d",
84
+ * "SubnetStatus": "Active"
85
+ * },
86
+ * {
87
+ * "SubnetAvailabilityZone": {
88
+ * "Name": "us-east-1c"
89
+ * },
90
+ * "SubnetIdentifier": "subnet-c2daefb5",
91
+ * "SubnetStatus": "Active"
92
+ * },
93
+ * {
94
+ * "SubnetAvailabilityZone": {
95
+ * "Name": "us-east-1e"
96
+ * },
97
+ * "SubnetIdentifier": "subnet-85e90cb8",
98
+ * "SubnetStatus": "Active"
99
+ * }
100
+ * ],
101
+ * "VpcId": "vpc-6741a603"
102
+ * }
103
+ * }
104
+ * }
105
+ * *\/
106
+ * // example id: modify-replication-instance-1481761784746
107
+ * ```
108
+ *
35
109
  */
36
110
  export declare class ModifyReplicationInstanceCommand extends $Command<ModifyReplicationInstanceCommandInput, ModifyReplicationInstanceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
37
111
  readonly input: ModifyReplicationInstanceCommandInput;
@@ -29,6 +29,24 @@ export interface ModifyReplicationSubnetGroupCommandOutput extends ModifyReplica
29
29
  * @see {@link ModifyReplicationSubnetGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Modify replication subnet group
33
+ * ```javascript
34
+ * // Modifies the settings for the specified replication subnet group.
35
+ * const input = {
36
+ * "ReplicationSubnetGroupDescription": "",
37
+ * "ReplicationSubnetGroupIdentifier": "",
38
+ * "SubnetIds": []
39
+ * };
40
+ * const command = new ModifyReplicationSubnetGroupCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ReplicationSubnetGroup": {}
45
+ * }
46
+ * *\/
47
+ * // example id: modify-replication-subnet-group-1481762275392
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class ModifyReplicationSubnetGroupCommand extends $Command<ModifyReplicationSubnetGroupCommandInput, ModifyReplicationSubnetGroupCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
52
  readonly input: ModifyReplicationSubnetGroupCommandInput;
@@ -31,6 +31,23 @@ export interface RefreshSchemasCommandOutput extends RefreshSchemasResponse, __M
31
31
  * @see {@link RefreshSchemasCommandOutput} for command's `response` shape.
32
32
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
33
33
  *
34
+ * @example Refresh schema
35
+ * ```javascript
36
+ * // Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.
37
+ * const input = {
38
+ * "EndpointArn": "",
39
+ * "ReplicationInstanceArn": ""
40
+ * };
41
+ * const command = new RefreshSchemasCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "RefreshSchemasStatus": {}
46
+ * }
47
+ * *\/
48
+ * // example id: refresh-schema-1481762399111
49
+ * ```
50
+ *
34
51
  */
35
52
  export declare class RefreshSchemasCommand extends $Command<RefreshSchemasCommandInput, RefreshSchemasCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
36
53
  readonly input: RefreshSchemasCommandInput;
@@ -34,6 +34,18 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou
34
34
  * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @example Remove tags from resource
38
+ * ```javascript
39
+ * // Removes metadata tags from an AWS DMS resource.
40
+ * const input = {
41
+ * "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E",
42
+ * "TagKeys": []
43
+ * };
44
+ * const command = new RemoveTagsFromResourceCommand(input);
45
+ * await client.send(command);
46
+ * // example id: remove-tags-from-resource-1481762571330
47
+ * ```
48
+ *
37
49
  */
38
50
  export declare class RemoveTagsFromResourceCommand extends $Command<RemoveTagsFromResourceCommandInput, RemoveTagsFromResourceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
51
  readonly input: RemoveTagsFromResourceCommandInput;
@@ -32,6 +32,35 @@ export interface StartReplicationTaskCommandOutput extends StartReplicationTaskR
32
32
  * @see {@link StartReplicationTaskCommandOutput} for command's `response` shape.
33
33
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
34
34
  *
35
+ * @example Start replication task
36
+ * ```javascript
37
+ * // Starts the replication task.
38
+ * const input = {
39
+ * "CdcStartTime": "2016-12-14T13:33:20Z",
40
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
41
+ * "StartReplicationTaskType": "start-replication"
42
+ * };
43
+ * const command = new StartReplicationTaskCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "ReplicationTask": {
48
+ * "MigrationType": "full-load",
49
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
50
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
51
+ * "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
52
+ * "ReplicationTaskIdentifier": "task1",
53
+ * "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
54
+ * "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
55
+ * "Status": "creating",
56
+ * "TableMappings": "file://mappingfile.json",
57
+ * "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
58
+ * }
59
+ * }
60
+ * *\/
61
+ * // example id: start-replication-task-1481762706778
62
+ * ```
63
+ *
35
64
  */
36
65
  export declare class StartReplicationTaskCommand extends $Command<StartReplicationTaskCommandInput, StartReplicationTaskCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
37
66
  readonly input: StartReplicationTaskCommandInput;
@@ -29,6 +29,33 @@ export interface StopReplicationTaskCommandOutput extends StopReplicationTaskRes
29
29
  * @see {@link StopReplicationTaskCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Stop replication task
33
+ * ```javascript
34
+ * // Stops the replication task.
35
+ * const input = {
36
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
37
+ * };
38
+ * const command = new StopReplicationTaskCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "ReplicationTask": {
43
+ * "MigrationType": "full-load",
44
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
45
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
46
+ * "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
47
+ * "ReplicationTaskIdentifier": "task1",
48
+ * "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
49
+ * "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
50
+ * "Status": "creating",
51
+ * "TableMappings": "file://mappingfile.json",
52
+ * "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
53
+ * }
54
+ * }
55
+ * *\/
56
+ * // example id: stop-replication-task-1481762924947
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class StopReplicationTaskCommand extends $Command<StopReplicationTaskCommandInput, StopReplicationTaskCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
61
  readonly input: StopReplicationTaskCommandInput;
@@ -29,6 +29,23 @@ export interface TestConnectionCommandOutput extends TestConnectionResponse, __M
29
29
  * @see {@link TestConnectionCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @example Test conection
33
+ * ```javascript
34
+ * // Tests the connection between the replication instance and the endpoint.
35
+ * const input = {
36
+ * "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
37
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
38
+ * };
39
+ * const command = new TestConnectionCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Connection": {}
44
+ * }
45
+ * *\/
46
+ * // example id: test-conection-1481763017636
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class TestConnectionCommand extends $Command<TestConnectionCommandInput, TestConnectionCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
51
  readonly input: TestConnectionCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-database-migration-service",
3
3
  "description": "AWS SDK for JavaScript Database Migration Service Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
- "@aws-sdk/util-waiter": "3.272.0",
55
+ "@aws-sdk/util-waiter": "3.289.0",
56
56
  "tslib": "^2.3.1"
57
57
  },
58
58
  "devDependencies": {