Skip to content

Commit fd40a1f

Browse files
author
awstools
committed
feat(client-database-migration-service): Introduces premigration assessment feature to DMS Serverless API for start-replication and describe-replications
1 parent a6db26e commit fd40a1f

File tree

46 files changed

+2317
-1846
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2317
-1846
lines changed

clients/client-database-migration-service/src/commands/AddTagsToResourceCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceRespons
3737
* reporting to track cost associated with DMS resources, or used in a Condition statement in
3838
* an IAM policy for DMS. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html">
3939
* <code>Tag</code>
40-
* </a> data type description.</p>
40+
* </a> data type
41+
* description.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

clients/client-database-migration-service/src/commands/ApplyPendingMaintenanceActionCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface ApplyPendingMaintenanceActionCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Applies a pending maintenance action to a resource (for example, to a replication instance).</p>
40+
* <p>Applies a pending maintenance action to a resource (for example, to a replication
41+
* instance).</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

clients/client-database-migration-service/src/commands/CreateDataProviderCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export interface CreateDataProviderCommandInput extends CreateDataProviderMessag
3232
export interface CreateDataProviderCommandOutput extends CreateDataProviderResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Creates a data provider using the provided settings. A data provider stores
36-
* a data store type and location information about your database. </p>
35+
* <p>Creates a data provider using the provided settings. A data provider stores a data store
36+
* type and location information about your database. </p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

clients/client-database-migration-service/src/commands/CreateEndpointCommand.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
4040
* <p>Creates an endpoint using the provided settings.</p>
4141
* <note>
4242
* <p>For a MySQL source or target endpoint, don't explicitly specify the database using
43-
* the <code>DatabaseName</code> request parameter on the <code>CreateEndpoint</code> API call.
44-
* Specifying <code>DatabaseName</code> when you create a MySQL endpoint replicates all the
45-
* task tables to this single database. For MySQL endpoints, you specify the database only when
46-
* you specify the schema in the table-mapping rules of the DMS task.</p>
43+
* the <code>DatabaseName</code> request parameter on the <code>CreateEndpoint</code> API
44+
* call. Specifying <code>DatabaseName</code> when you create a MySQL endpoint replicates
45+
* all the task tables to this single database. For MySQL endpoints, you specify the
46+
* database only when you specify the schema in the table-mapping rules of the DMS
47+
* task.</p>
4748
* </note>
4849
* @example
4950
* Use a bare-bones client and the command you need to make an API call.

clients/client-database-migration-service/src/commands/CreateEventSubscriptionCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
4545
* <code>SourceIdentifier</code>, you will be notified of events generated from all DMS
4646
* sources belonging to your customer account.</p>
4747
* <p>For more information about DMS events, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and
48-
* Notifications</a> in the <i>Database Migration Service User
49-
* Guide.</i>
48+
* Notifications</a> in the <i>Database Migration Service User Guide.</i>
5049
* </p>
5150
* @example
5251
* Use a bare-bones client and the command you need to make an API call.

clients/client-database-migration-service/src/commands/CreateReplicationConfigCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ export interface CreateReplicationConfigCommandInput extends CreateReplicationCo
3232
export interface CreateReplicationConfigCommandOutput extends CreateReplicationConfigResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Creates a configuration that you can later provide to configure and start an DMS Serverless
36-
* replication. You can also provide options to validate the configuration inputs before you start the
37-
* replication.</p>
35+
* <p>Creates a configuration that you can later provide to configure and start an DMS
36+
* Serverless replication. You can also provide options to validate the configuration inputs
37+
* before you start the replication.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

clients/client-database-migration-service/src/commands/CreateReplicationInstanceCommand.ts

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,14 @@ export interface CreateReplicationInstanceCommandOutput extends CreateReplicatio
3333

3434
/**
3535
* <p>Creates the replication instance using the specified parameters.</p>
36-
* <p>DMS requires that your account have certain roles with appropriate permissions
37-
* before you can create a replication instance. For information on the required roles, see
38-
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole">Creating the IAM Roles to Use With the CLI and DMS API</a>. For
39-
* information on the required permissions, see
40-
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions">IAM Permissions Needed to Use DMS</a>.</p>
36+
* <p>DMS requires that your account have certain roles with appropriate permissions before
37+
* you can create a replication instance. For information on the required roles, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole">Creating the IAM Roles to Use With the CLI and DMS API</a>. For information on
38+
* the required permissions, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions">IAM
39+
* Permissions Needed to Use DMS</a>.</p>
4140
* <note>
42-
* <p>If you don't specify a version when creating a replication instance, DMS will create the instance using the
43-
* default engine version. For information about the default engine version, see
44-
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html">Release Notes</a>.</p>
41+
* <p>If you don't specify a version when creating a replication instance, DMS will
42+
* create the instance using the default engine version. For information about the default
43+
* engine version, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html">Release Notes</a>.</p>
4544
* </note>
4645
* @example
4746
* Use a bare-bones client and the command you need to make an API call.

clients/client-database-migration-service/src/commands/CreateReplicationSubnetGroupCommand.ts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,14 @@ export interface CreateReplicationSubnetGroupCommandOutput
3838

3939
/**
4040
* <p>Creates a replication subnet group given a list of the subnet IDs in a VPC.</p>
41-
* <p>The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the
42-
* service will throw a <code>ReplicationSubnetGroupDoesNotCoverEnoughAZs</code> exception.</p>
43-
* <p>If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action
44-
* returns the following error message: The Replication Subnet Group already exists. In this case, delete
45-
* the existing replication subnet group. To do so, use the <a href="https://docs.aws.amazon.com/en_us/dms/latest/APIReference/API_DeleteReplicationSubnetGroup.html">DeleteReplicationSubnetGroup</a> action. Optionally, choose Subnet groups in the DMS console,
46-
* then choose your subnet group. Next, choose Delete from Actions.</p>
41+
* <p>The VPC needs to have at least one subnet in at least two availability zones in the
42+
* Amazon Web Services Region, otherwise the service will throw a
43+
* <code>ReplicationSubnetGroupDoesNotCoverEnoughAZs</code> exception.</p>
44+
* <p>If a replication subnet group exists in your Amazon Web Services account, the
45+
* CreateReplicationSubnetGroup action returns the following error message: The Replication
46+
* Subnet Group already exists. In this case, delete the existing replication subnet group. To
47+
* do so, use the <a href="https://docs.aws.amazon.com/en_us/dms/latest/APIReference/API_DeleteReplicationSubnetGroup.html">DeleteReplicationSubnetGroup</a> action. Optionally, choose Subnet groups in the
48+
* DMS console, then choose your subnet group. Next, choose Delete from Actions.</p>
4749
* @example
4850
* Use a bare-bones client and the command you need to make an API call.
4951
* ```javascript

clients/client-database-migration-service/src/commands/DeleteInstanceProfileCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ export interface DeleteInstanceProfileCommandOutput extends DeleteInstanceProfil
3434
/**
3535
* <p>Deletes the specified instance profile.</p>
3636
* <note>
37-
* <p>All migration projects associated with the instance profile must be deleted or modified
38-
* before you can delete the instance profile.</p>
37+
* <p>All migration projects associated with the instance profile must be deleted or
38+
* modified before you can delete the instance profile.</p>
3939
* </note>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.

clients/client-database-migration-service/src/commands/DeleteReplicationConfigCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,10 @@ export interface DeleteReplicationConfigCommandInput extends DeleteReplicationCo
3232
export interface DeleteReplicationConfigCommandOutput extends DeleteReplicationConfigResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all
36-
* replications that use this configuration. You can't delete the configuration for an DMS Serverless replication
37-
* that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.</p>
35+
* <p>Deletes an DMS Serverless replication configuration. This effectively deprovisions any
36+
* and all replications that use this configuration. You can't delete the configuration for an
37+
* DMS Serverless replication that is ongoing. You can delete the configuration when the
38+
* replication is in a non-RUNNING and non-STARTING state.</p>
3839
* @example
3940
* Use a bare-bones client and the command you need to make an API call.
4041
* ```javascript

0 commit comments

Comments
 (0)