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

Diff for: ‎clients/client-database-migration-service/src/commands/AddTagsToResourceCommand.ts

+2-1
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

Diff for: ‎clients/client-database-migration-service/src/commands/ApplyPendingMaintenanceActionCommand.ts

+2-1
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

Diff for: ‎clients/client-database-migration-service/src/commands/CreateDataProviderCommand.ts

+2-2
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

Diff for: ‎clients/client-database-migration-service/src/commands/CreateEndpointCommand.ts

+5-4
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.

Diff for: ‎clients/client-database-migration-service/src/commands/CreateEventSubscriptionCommand.ts

+1-2
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.

Diff for: ‎clients/client-database-migration-service/src/commands/CreateReplicationConfigCommand.ts

+3-3
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

Diff for: ‎clients/client-database-migration-service/src/commands/CreateReplicationInstanceCommand.ts

+7-8
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.

Diff for: ‎clients/client-database-migration-service/src/commands/CreateReplicationSubnetGroupCommand.ts

+8-6
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

Diff for: ‎clients/client-database-migration-service/src/commands/DeleteInstanceProfileCommand.ts

+2-2
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.

Diff for: ‎clients/client-database-migration-service/src/commands/DeleteReplicationConfigCommand.ts

+4-3
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

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeApplicableIndividualAssessmentsCommand.ts

+14-13
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,20 @@ export interface DescribeApplicableIndividualAssessmentsCommandOutput
4343
/**
4444
* <p>Provides a list of individual assessments that you can specify for a new premigration
4545
* assessment run, given one or more parameters.</p>
46-
* <p>If you specify an existing migration task, this operation provides the default individual
47-
* assessments you can specify for that task. Otherwise, the specified parameters model elements
48-
* of a possible migration task on which to base a premigration assessment run.</p>
49-
* <p>To use these migration task modeling parameters, you must specify an existing replication instance,
50-
* a source database engine, a target database engine, and a migration type. This combination of
51-
* parameters potentially limits the default individual assessments available for an assessment run
52-
* created for a corresponding migration task.</p>
53-
* <p>If you specify no parameters, this operation provides a list of all possible individual assessments
54-
* that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must
55-
* specify all of them or the operation cannot provide a list of individual assessments.
56-
* The only parameter that you can specify alone is for an existing migration task. The specified task
57-
* definition then determines the default list of individual assessments that you can specify in an
58-
* assessment run for the task.</p>
46+
* <p>If you specify an existing migration task, this operation provides the default
47+
* individual assessments you can specify for that task. Otherwise, the specified parameters
48+
* model elements of a possible migration task on which to base a premigration assessment
49+
* run.</p>
50+
* <p>To use these migration task modeling parameters, you must specify an existing
51+
* replication instance, a source database engine, a target database engine, and a migration
52+
* type. This combination of parameters potentially limits the default individual assessments
53+
* available for an assessment run created for a corresponding migration task.</p>
54+
* <p>If you specify no parameters, this operation provides a list of all possible individual
55+
* assessments that you can specify for an assessment run. If you specify any one of the task
56+
* modeling parameters, you must specify all of them or the operation cannot provide a list of
57+
* individual assessments. The only parameter that you can specify alone is for an existing
58+
* migration task. The specified task definition then determines the default list of
59+
* individual assessments that you can specify in an assessment run for the task.</p>
5960
* @example
6061
* Use a bare-bones client and the command you need to make an API call.
6162
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeDataProvidersCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface DescribeDataProvidersCommandInput extends DescribeDataProviders
3232
export interface DescribeDataProvidersCommandOutput extends DescribeDataProvidersResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns a paginated list of data providers for your account in the current region.</p>
35+
* <p>Returns a paginated list of data providers for your account in the current
36+
* region.</p>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeEndpointSettingsCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export interface DescribeEndpointSettingsCommandInput extends DescribeEndpointSe
3232
export interface DescribeEndpointSettingsCommandOutput extends DescribeEndpointSettingsResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns information about the possible endpoint settings available
36-
* when you create an endpoint for a specific database engine.</p>
35+
* <p>Returns information about the possible endpoint settings available when you create an
36+
* endpoint for a specific database engine.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeEventCategoriesCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ export interface DescribeEventCategoriesCommandOutput extends DescribeEventCateg
3434
/**
3535
* <p>Lists categories for all event source types, or, if specified, for a specified source
3636
* type. You can see a list of the event categories and source types in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events
37-
* and Notifications</a> in the <i>Database Migration Service User
38-
* Guide.</i>
37+
* and Notifications</a> in the <i>Database Migration Service User Guide.</i>
3938
* </p>
4039
* @example
4140
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeEventsCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
3434
/**
3535
* <p> Lists events for a given source identifier and source type. You can also specify a
3636
* start and end time. For more information on DMS events, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and
37-
* Notifications</a> in the <i>Database Migration Service User
38-
* Guide.</i>
37+
* Notifications</a> in the <i>Database Migration Service User Guide.</i>
3938
* </p>
4039
* @example
4140
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeExtensionPackAssociationsCommand.ts

+3-4
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,9 @@ export interface DescribeExtensionPackAssociationsCommandOutput
4040
__MetadataBearer {}
4141

4242
/**
43-
* <p>Returns a paginated list of extension pack associations for the specified migration project.
44-
* An extension pack is an add-on module
45-
* that emulates functions present in a source database that are required when converting objects
46-
* to the target database.</p>
43+
* <p>Returns a paginated list of extension pack associations for the specified migration
44+
* project. An extension pack is an add-on module that emulates functions present in a source
45+
* database that are required when converting objects to the target database.</p>
4746
* @example
4847
* Use a bare-bones client and the command you need to make an API call.
4948
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeInstanceProfilesCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface DescribeInstanceProfilesCommandInput extends DescribeInstancePr
3232
export interface DescribeInstanceProfilesCommandOutput extends DescribeInstanceProfilesResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns a paginated list of instance profiles for your account in the current region.</p>
35+
* <p>Returns a paginated list of instance profiles for your account in the current
36+
* region.</p>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeMetadataModelAssessmentsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface DescribeMetadataModelAssessmentsCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Returns a paginated list of metadata model assessments for your account in the current region.</p>
40+
* <p>Returns a paginated list of metadata model assessments for your account in the current
41+
* region.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeMigrationProjectsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface DescribeMigrationProjectsCommandInput extends DescribeMigration
3232
export interface DescribeMigrationProjectsCommandOutput extends DescribeMigrationProjectsResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns a paginated list of migration projects for your account in the current region.</p>
35+
* <p>Returns a paginated list of migration projects for your account in the current
36+
* region.</p>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribePendingMaintenanceActionsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ export interface DescribePendingMaintenanceActionsCommandOutput
4040
__MetadataBearer {}
4141

4242
/**
43-
* <p>Returns a list of upcoming maintenance events for replication instances in your account in the current Region.</p>
43+
* <p>Returns a list of upcoming maintenance events for replication instances in your account
44+
* in the current Region.</p>
4445
* @example
4546
* Use a bare-bones client and the command you need to make an API call.
4647
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeReplicationConfigsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface DescribeReplicationConfigsCommandInput extends DescribeReplicat
3232
export interface DescribeReplicationConfigsCommandOutput extends DescribeReplicationConfigsResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns one or more existing DMS Serverless replication configurations as a list of structures.</p>
35+
* <p>Returns one or more existing DMS Serverless replication configurations as a list of
36+
* structures.</p>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

Diff for: ‎clients/client-database-migration-service/src/commands/DescribeReplicationTaskAssessmentResultsCommand.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,9 @@ export interface DescribeReplicationTaskAssessmentResultsCommandOutput
4343

4444
/**
4545
* <p>Returns the task assessment results from the Amazon S3 bucket that DMS creates in your
46-
* Amazon Web Services account. This action always returns the
47-
* latest results.</p>
48-
* <p>For more information about DMS task assessments, see
49-
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment report</a>
50-
* in the <i>Database Migration Service User Guide</i>.</p>
46+
* Amazon Web Services account. This action always returns the latest results.</p>
47+
* <p>For more information about DMS task assessments, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment
48+
* report</a> in the <i>Database Migration Service User Guide</i>.</p>
5149
* @example
5250
* Use a bare-bones client and the command you need to make an API call.
5351
* ```javascript

0 commit comments

Comments
 (0)