AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

DMS was denied access to the endpoint. Check that the role is correctly configured.

Class AccountQuota

Describes a quota for an Amazon Web Services account, for example the number of replication instances allowed.

Class AddTagsToResourceRequest

Container for the parameters to the AddTagsToResource operation. Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.

Class AddTagsToResourceResponse

Class ApplyPendingMaintenanceActionRequest

Container for the parameters to the ApplyPendingMaintenanceAction operation. Applies a pending maintenance action to a resource (for example, to a replication instance).

Class ApplyPendingMaintenanceActionResponse

Class AvailabilityZone

The name of an Availability Zone for use during database migration. AvailabilityZone is an optional parameter to the CreateReplicationInstance operation, and it’s value relates to the Amazon Web Services Region of an endpoint. For example, the availability zone of an endpoint in the us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

Class BatchStartRecommendationsErrorEntry

Provides information about the errors that occurred during the analysis of the source database.

Class BatchStartRecommendationsRequest

Container for the parameters to the BatchStartRecommendations operation. Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecommendations.

The result of analysis of each source database is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Class BatchStartRecommendationsResponse

This is the response object from the BatchStartRecommendations operation.

Class CancelReplicationTaskAssessmentRunRequest

Container for the parameters to the CancelReplicationTaskAssessmentRun operation. Cancels a single premigration assessment run.

This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.

Class CancelReplicationTaskAssessmentRunResponse

Class Certificate

The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

Class CollectorHealthCheck

Describes the last Fleet Advisor collector health check.

Class CollectorNotFoundException

The specified collector doesn't exist.

Class CollectorResponse

Describes a Fleet Advisor collector.

Class CollectorShortInfoResponse

Briefly describes a Fleet Advisor collector.

Class ComputeConfig

Configuration parameters for provisioning an DMS Serverless replication.

Class Connection

Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

Class CreateDataProviderRequest

Container for the parameters to the CreateDataProvider operation. Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.

Class CreateDataProviderResponse

This is the response object from the CreateDataProvider operation.

Class CreateEndpointRequest

Container for the parameters to the CreateEndpoint operation. Creates an endpoint using the provided settings.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

Class CreateEndpointResponse

Class CreateEventSubscriptionRequest

Container for the parameters to the CreateEventSubscription operation. Creates an DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account.

For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
Class CreateEventSubscriptionResponse

Class CreateFleetAdvisorCollectorRequest

Container for the parameters to the CreateFleetAdvisorCollector operation. Creates a Fleet Advisor collector using the specified parameters.

Class CreateFleetAdvisorCollectorResponse

This is the response object from the CreateFleetAdvisorCollector operation.

Class CreateInstanceProfileRequest

Container for the parameters to the CreateInstanceProfile operation. Creates the instance profile using the specified parameters.

Class CreateInstanceProfileResponse

This is the response object from the CreateInstanceProfile operation.

Class CreateMigrationProjectRequest

Container for the parameters to the CreateMigrationProject operation. Creates the migration project using the specified parameters.

You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.

Class CreateMigrationProjectResponse

This is the response object from the CreateMigrationProject operation.

Class CreateReplicationConfigRequest

Container for the parameters to the CreateReplicationConfig operation. Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

Class CreateReplicationConfigResponse

Class CreateReplicationInstanceRequest

Container for the parameters to the CreateReplicationInstance operation. Creates the replication instance using the specified parameters.

DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.

If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see Release Notes.

Class CreateReplicationInstanceResponse

Class CreateReplicationSubnetGroupRequest

Container for the parameters to the CreateReplicationSubnetGroup operation. Creates a replication subnet group given a list of the subnet IDs in a VPC.

The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.

If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action returns the following error message: The Replication Subnet Group already exists. In this case, delete the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, then choose your subnet group. Next, choose Delete from Actions.

Class CreateReplicationSubnetGroupResponse

Class CreateReplicationTaskRequest

Container for the parameters to the CreateReplicationTask operation. Creates a replication task using the specified parameters.

Class CreateReplicationTaskResponse

Class DatabaseInstanceSoftwareDetailsResponse

Describes an inventory database instance for a Fleet Advisor collector.

Class DatabaseMigrationServicePaginatorFactory

Paginators for the DatabaseMigrationService service

Class DatabaseResponse

Describes a database in a Fleet Advisor collector inventory.

Class DatabaseShortInfoResponse

Describes a database in a Fleet Advisor collector inventory.

Class DataProvider

Provides information that defines a data provider.

Class DataProviderDescriptor

Information about a data provider.

Class DataProviderDescriptorDefinition

Information about a data provider.

Class DataProviderSettings

Provides information that defines a data provider.

Class DefaultErrorDetails

Provides error information about a schema conversion operation.

Class DeleteCertificateRequest

Container for the parameters to the DeleteCertificate operation. Deletes the specified certificate.

Class DeleteCertificateResponse

This is the response object from the DeleteCertificate operation.

Class DeleteConnectionRequest

Container for the parameters to the DeleteConnection operation. Deletes the connection between a replication instance and an endpoint.

Class DeleteConnectionResponse

Class DeleteDataProviderRequest

Container for the parameters to the DeleteDataProvider operation. Deletes the specified data provider.

All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.

Class DeleteDataProviderResponse

This is the response object from the DeleteDataProvider operation.

Class DeleteEndpointRequest

Container for the parameters to the DeleteEndpoint operation. Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

Class DeleteEndpointResponse

Class DeleteEventSubscriptionRequest

Container for the parameters to the DeleteEventSubscription operation. Deletes an DMS event subscription.

Class DeleteEventSubscriptionResponse

Class DeleteFleetAdvisorCollectorRequest

Container for the parameters to the DeleteFleetAdvisorCollector operation. Deletes the specified Fleet Advisor collector.

Class DeleteFleetAdvisorCollectorResponse

This is the response object from the DeleteFleetAdvisorCollector operation.

Class DeleteFleetAdvisorDatabasesRequest

Container for the parameters to the DeleteFleetAdvisorDatabases operation. Deletes the specified Fleet Advisor collector databases.

Class DeleteFleetAdvisorDatabasesResponse

This is the response object from the DeleteFleetAdvisorDatabases operation.

Class DeleteInstanceProfileRequest

Container for the parameters to the DeleteInstanceProfile operation. Deletes the specified instance profile.

All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.

Class DeleteInstanceProfileResponse

This is the response object from the DeleteInstanceProfile operation.

Class DeleteMigrationProjectRequest

Container for the parameters to the DeleteMigrationProject operation. Deletes the specified migration project.

The migration project must be closed before you can delete it.

Class DeleteMigrationProjectResponse

This is the response object from the DeleteMigrationProject operation.

Class DeleteReplicationConfigRequest

Container for the parameters to the DeleteReplicationConfig operation. Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.

Class DeleteReplicationConfigResponse

Class DeleteReplicationInstanceRequest

Container for the parameters to the DeleteReplicationInstance operation. Deletes the specified replication instance.

You must delete any migration tasks that are associated with the replication instance before you can delete it.

Class DeleteReplicationInstanceResponse

Class DeleteReplicationSubnetGroupRequest

Container for the parameters to the DeleteReplicationSubnetGroup operation. Deletes a subnet group.

Class DeleteReplicationSubnetGroupResponse

Class DeleteReplicationTaskAssessmentRunRequest

Container for the parameters to the DeleteReplicationTaskAssessmentRun operation. Deletes the record of a single premigration assessment run.

This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.

Class DeleteReplicationTaskAssessmentRunResponse

Class DeleteReplicationTaskRequest

Container for the parameters to the DeleteReplicationTask operation. Deletes the specified replication task.

Class DeleteReplicationTaskResponse

Class DescribeAccountAttributesRequest

Container for the parameters to the DescribeAccountAttributes operation. Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.

This command does not take any parameters.

Class DescribeAccountAttributesResponse

Class DescribeApplicableIndividualAssessmentsRequest

Container for the parameters to the DescribeApplicableIndividualAssessments operation. Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.

If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.

To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.

If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.

Class DescribeApplicableIndividualAssessmentsResponse

Class DescribeCertificatesRequest

Container for the parameters to the DescribeCertificates operation. Provides a description of the certificate.

Class DescribeCertificatesResponse

This is the response object from the DescribeCertificates operation.

Class DescribeConnectionsRequest

Container for the parameters to the DescribeConnections operation. 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.

Class DescribeConnectionsResponse

Class DescribeConversionConfigurationRequest

Container for the parameters to the DescribeConversionConfiguration operation. Returns configuration parameters for a schema conversion project.

Class DescribeConversionConfigurationResponse

This is the response object from the DescribeConversionConfiguration operation.

Class DescribeDataProvidersRequest

Container for the parameters to the DescribeDataProviders operation. Returns a paginated list of data providers for your account in the current region.

Class DescribeDataProvidersResponse

This is the response object from the DescribeDataProviders operation.

Class DescribeEndpointSettingsRequest

Container for the parameters to the DescribeEndpointSettings operation. Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Class DescribeEndpointSettingsResponse

This is the response object from the DescribeEndpointSettings operation.

Class DescribeEndpointsRequest

Container for the parameters to the DescribeEndpoints operation. Returns information about the endpoints for your account in the current region.

Class DescribeEndpointsResponse

Class DescribeEndpointTypesRequest

Container for the parameters to the DescribeEndpointTypes operation. Returns information about the type of endpoints available.

Class DescribeEndpointTypesResponse

Class DescribeEngineVersionsRequest

Container for the parameters to the DescribeEngineVersions operation. Returns information about the replication instance versions used in the project.

Class DescribeEngineVersionsResponse

This is the response object from the DescribeEngineVersions operation.

Class DescribeEventCategoriesRequest

Container for the parameters to the DescribeEventCategories operation. Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide.
Class DescribeEventCategoriesResponse

Class DescribeEventsRequest

Container for the parameters to the DescribeEvents operation. Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
Class DescribeEventsResponse

Class DescribeEventSubscriptionsRequest

Container for the parameters to the DescribeEventSubscriptions operation. Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

Class DescribeEventSubscriptionsResponse

Class DescribeExtensionPackAssociationsRequest

Container for the parameters to the DescribeExtensionPackAssociations operation. Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.

Class DescribeExtensionPackAssociationsResponse

This is the response object from the DescribeExtensionPackAssociations operation.

Class DescribeFleetAdvisorCollectorsRequest

Container for the parameters to the DescribeFleetAdvisorCollectors operation. Returns a list of the Fleet Advisor collectors in your account.

Class DescribeFleetAdvisorCollectorsResponse

This is the response object from the DescribeFleetAdvisorCollectors operation.

Class DescribeFleetAdvisorDatabasesRequest

Container for the parameters to the DescribeFleetAdvisorDatabases operation. Returns a list of Fleet Advisor databases in your account.

Class DescribeFleetAdvisorDatabasesResponse

This is the response object from the DescribeFleetAdvisorDatabases operation.

Class DescribeFleetAdvisorLsaAnalysisRequest

Container for the parameters to the DescribeFleetAdvisorLsaAnalysis operation. Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.

Class DescribeFleetAdvisorLsaAnalysisResponse

This is the response object from the DescribeFleetAdvisorLsaAnalysis operation.

Class DescribeFleetAdvisorSchemaObjectSummaryRequest

Container for the parameters to the DescribeFleetAdvisorSchemaObjectSummary operation. Provides descriptions of the schemas discovered by your Fleet Advisor collectors.

Class DescribeFleetAdvisorSchemaObjectSummaryResponse

This is the response object from the DescribeFleetAdvisorSchemaObjectSummary operation.

Class DescribeFleetAdvisorSchemasRequest

Container for the parameters to the DescribeFleetAdvisorSchemas operation. Returns a list of schemas detected by Fleet Advisor Collectors in your account.

Class DescribeFleetAdvisorSchemasResponse

This is the response object from the DescribeFleetAdvisorSchemas operation.

Class DescribeInstanceProfilesRequest

Container for the parameters to the DescribeInstanceProfiles operation. Returns a paginated list of instance profiles for your account in the current region.

Class DescribeInstanceProfilesResponse

This is the response object from the DescribeInstanceProfiles operation.

Class DescribeMetadataModelAssessmentsRequest

Container for the parameters to the DescribeMetadataModelAssessments operation. Returns a paginated list of metadata model assessments for your account in the current region.

Class DescribeMetadataModelAssessmentsResponse

This is the response object from the DescribeMetadataModelAssessments operation.

Class DescribeMetadataModelConversionsRequest

Container for the parameters to the DescribeMetadataModelConversions operation. Returns a paginated list of metadata model conversions for a migration project.

Class DescribeMetadataModelConversionsResponse

This is the response object from the DescribeMetadataModelConversions operation.

Class DescribeMetadataModelExportsAsScriptRequest

Container for the parameters to the DescribeMetadataModelExportsAsScript operation. Returns a paginated list of metadata model exports.

Class DescribeMetadataModelExportsAsScriptResponse

This is the response object from the DescribeMetadataModelExportsAsScript operation.

Class DescribeMetadataModelExportsToTargetRequest

Container for the parameters to the DescribeMetadataModelExportsToTarget operation. Returns a paginated list of metadata model exports.

Class DescribeMetadataModelExportsToTargetResponse

This is the response object from the DescribeMetadataModelExportsToTarget operation.

Class DescribeMetadataModelImportsRequest

Container for the parameters to the DescribeMetadataModelImports operation. Returns a paginated list of metadata model imports.

Class DescribeMetadataModelImportsResponse

This is the response object from the DescribeMetadataModelImports operation.

Class DescribeMigrationProjectsRequest

Container for the parameters to the DescribeMigrationProjects operation. Returns a paginated list of migration projects for your account in the current region.

Class DescribeMigrationProjectsResponse

This is the response object from the DescribeMigrationProjects operation.

Class DescribeOrderableReplicationInstancesRequest

Container for the parameters to the DescribeOrderableReplicationInstances operation. Returns information about the replication instance types that can be created in the specified region.

Class DescribeOrderableReplicationInstancesResponse

Class DescribePendingMaintenanceActionsRequest

Container for the parameters to the DescribePendingMaintenanceActions operation. For internal use only

Class DescribePendingMaintenanceActionsResponse

Class DescribeRecommendationLimitationsRequest

Container for the parameters to the DescribeRecommendationLimitations operation. Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.

Class DescribeRecommendationLimitationsResponse

This is the response object from the DescribeRecommendationLimitations operation.

Class DescribeRecommendationsRequest

Container for the parameters to the DescribeRecommendations operation. Returns a paginated list of target engine recommendations for your source databases.

Class DescribeRecommendationsResponse

This is the response object from the DescribeRecommendations operation.

Class DescribeRefreshSchemasStatusRequest

Container for the parameters to the DescribeRefreshSchemasStatus operation. Returns the status of the RefreshSchemas operation.

Class DescribeRefreshSchemasStatusResponse

Class DescribeReplicationConfigsRequest

Container for the parameters to the DescribeReplicationConfigs operation. Returns one or more existing DMS Serverless replication configurations as a list of structures.

Class DescribeReplicationConfigsResponse

Class DescribeReplicationInstancesRequest

Container for the parameters to the DescribeReplicationInstances operation. Returns information about replication instances for your account in the current region.

Class DescribeReplicationInstancesResponse

Class DescribeReplicationInstanceTaskLogsRequest

Container for the parameters to the DescribeReplicationInstanceTaskLogs operation. Returns information about the task logs for the specified task.

Class DescribeReplicationInstanceTaskLogsResponse

This is the response object from the DescribeReplicationInstanceTaskLogs operation.

Class DescribeReplicationsRequest

Container for the parameters to the DescribeReplications operation. Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.

Class DescribeReplicationsResponse

Class DescribeReplicationSubnetGroupsRequest

Container for the parameters to the DescribeReplicationSubnetGroups operation. Returns information about the replication subnet groups.

Class DescribeReplicationSubnetGroupsResponse

Class DescribeReplicationTableStatisticsRequest

Container for the parameters to the DescribeReplicationTableStatistics operation. Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.

Class DescribeReplicationTableStatisticsResponse

Class DescribeReplicationTaskAssessmentResultsRequest

Container for the parameters to the DescribeReplicationTaskAssessmentResults operation. Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.

For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.

Class DescribeReplicationTaskAssessmentResultsResponse

Class DescribeReplicationTaskAssessmentRunsRequest

Container for the parameters to the DescribeReplicationTaskAssessmentRuns operation. Returns a paginated list of premigration assessment runs based on filter settings.

These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.

This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.

Class DescribeReplicationTaskAssessmentRunsResponse

Class DescribeReplicationTaskIndividualAssessmentsRequest

Container for the parameters to the DescribeReplicationTaskIndividualAssessments operation. Returns a paginated list of individual assessments based on filter settings.

These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.

Class DescribeReplicationTaskIndividualAssessmentsResponse

Class DescribeReplicationTasksRequest

Container for the parameters to the DescribeReplicationTasks operation. Returns information about replication tasks for your account in the current region.

Class DescribeReplicationTasksResponse

Class DescribeSchemasRequest

Container for the parameters to the DescribeSchemas operation. Returns information about the schema for the specified endpoint.

Class DescribeSchemasResponse

Class DescribeTableStatisticsRequest

Container for the parameters to the DescribeTableStatistics operation. Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.

Class DescribeTableStatisticsResponse

Class DMSEvent

Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the DMS resource type.

Class DmsTransferSettings

The settings in JSON format for the DMS Transfer type source endpoint.

Class DocDbDataProviderSettings

Provides information that defines a DocumentDB data provider.

Class DocDbSettings

Provides information that defines a DocumentDB endpoint.

Class DynamoDbSettings

Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.

Class ElasticsearchSettings

Provides information that defines an OpenSearch endpoint.

Class Endpoint

Describes an endpoint of a database instance in response to operations such as the following:

  • CreateEndpoint

  • DescribeEndpoint

  • ModifyEndpoint
Class EndpointSetting

Endpoint settings.

Class EngineVersion

Provides information about a replication instance version.

Class ErrorDetails

Provides error information about a project.

Class EventCategoryGroup

Lists categories of events subscribed to, and generated by, the applicable DMS resource type. This data type appears in response to the DescribeEventCategories action.

Class EventSubscription

Describes an event notification subscription created by the CreateEventSubscription operation.

Class ExportMetadataModelAssessmentRequest

Container for the parameters to the ExportMetadataModelAssessment operation. Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.

Class ExportMetadataModelAssessmentResponse

This is the response object from the ExportMetadataModelAssessment operation.

Class ExportMetadataModelAssessmentResultEntry

Provides information about an exported metadata model assessment.

Class ExportSqlDetails

Provides information about a metadata model assessment exported to SQL.

Class Filter

Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

Class FleetAdvisorLsaAnalysisResponse

Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.

Class FleetAdvisorSchemaObjectResponse

Describes a schema object in a Fleet Advisor collector inventory.

Class GcpMySQLSettings

Settings in JSON format for the source GCP MySQL endpoint.

Class IBMDb2Settings

Provides information that defines an IBM Db2 LUW endpoint.

Class ImportCertificateRequest

Container for the parameters to the ImportCertificate operation. Uploads the specified certificate.

Class ImportCertificateResponse

This is the response object from the ImportCertificate operation.

Class InstanceProfile

Provides information that defines an instance profile.

Class InsufficientResourceCapacityException

There are not enough resources allocated to the database migration.

Class InvalidCertificateException

The certificate was not valid.

Class InvalidOperationException

The action or operation requested isn't valid.

Class InvalidResourceStateException

The resource is in a state that prevents it from being used for database migration.

Class InvalidSubnetException

The subnet provided isn't valid.

Class InventoryData

Describes a Fleet Advisor collector inventory.

Class KafkaSettings

Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

Class KinesisSettings

Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

Class KMSAccessDeniedException

The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.

Class KMSDisabledException

The specified KMS key isn't enabled.

Class KMSException

An Key Management Service (KMS) error is preventing access to KMS.

Class KMSInvalidStateException

The state of the specified KMS resource isn't valid for this request.

Class KMSKeyNotAccessibleException

DMS cannot access the KMS key.

Class KMSNotFoundException

The specified KMS entity or resource can't be found.

Class KMSThrottlingException

This request triggered KMS request throttling.

Class Limitation

Provides information about the limitations of target Amazon Web Services engines.

Your source database might include features that the target Amazon Web Services engine doesn't support. Fleet Advisor lists these features as limitations. You should consider these limitations during database migration. For each limitation, Fleet Advisor recommends an action that you can take to address or avoid this limitation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.

Class ListTagsForResourceResponse

Class MariaDbDataProviderSettings

Provides information that defines a MariaDB data provider.

Class MicrosoftSqlServerDataProviderSettings

Provides information that defines a Microsoft SQL Server data provider.

Class MicrosoftSQLServerSettings

Provides information that defines a Microsoft SQL Server endpoint.

Class MigrationProject

Provides information that defines a migration project.

Class ModifyConversionConfigurationRequest

Container for the parameters to the ModifyConversionConfiguration operation. Modifies the specified schema conversion configuration using the provided parameters.

Class ModifyConversionConfigurationResponse

This is the response object from the ModifyConversionConfiguration operation.

Class ModifyDataProviderRequest

Container for the parameters to the ModifyDataProvider operation. Modifies the specified data provider using the provided settings.

You must remove the data provider from all migration projects before you can modify it.

Class ModifyDataProviderResponse

This is the response object from the ModifyDataProvider operation.

Class ModifyEndpointRequest

Container for the parameters to the ModifyEndpoint operation. Modifies the specified endpoint.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

Class ModifyEndpointResponse

Class ModifyEventSubscriptionRequest

Container for the parameters to the ModifyEventSubscription operation. Modifies an existing DMS event notification subscription.

Class ModifyEventSubscriptionResponse

Class ModifyInstanceProfileRequest

Container for the parameters to the ModifyInstanceProfile operation. Modifies the specified instance profile using the provided parameters.

All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.

Class ModifyInstanceProfileResponse

This is the response object from the ModifyInstanceProfile operation.

Class ModifyMigrationProjectRequest

Container for the parameters to the ModifyMigrationProject operation. Modifies the specified migration project using the provided parameters.

The migration project must be closed before you can modify it.

Class ModifyMigrationProjectResponse

This is the response object from the ModifyMigrationProject operation.

Class ModifyReplicationConfigRequest

Container for the parameters to the ModifyReplicationConfig operation. Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it.

Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.

Class ModifyReplicationConfigResponse

This is the response object from the ModifyReplicationConfig operation.

Class ModifyReplicationInstanceRequest

Container for the parameters to the ModifyReplicationInstance operation. 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.

Class ModifyReplicationInstanceResponse

Class ModifyReplicationSubnetGroupRequest

Container for the parameters to the ModifyReplicationSubnetGroup operation. Modifies the settings for the specified replication subnet group.

Class ModifyReplicationSubnetGroupResponse

Class ModifyReplicationTaskRequest

Container for the parameters to the ModifyReplicationTask operation. Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

Class ModifyReplicationTaskResponse

Class MongoDbDataProviderSettings

Provides information that defines a MongoDB data provider.

Class MongoDbSettings

Provides information that defines a MongoDB endpoint.

Class MoveReplicationTaskRequest

Container for the parameters to the MoveReplicationTask operation. Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.

Class MoveReplicationTaskResponse

Class MySqlDataProviderSettings

Provides information that defines a MySQL data provider.

Class MySQLSettings

Provides information that defines a MySQL endpoint.

Class NeptuneSettings

Provides information that defines an Amazon Neptune endpoint.

Class OracleDataProviderSettings

Provides information that defines an Oracle data provider.

Class OracleSettings

Provides information that defines an Oracle endpoint.

Class OrderableReplicationInstance

In response to the DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.

Class PendingMaintenanceAction

Describes a maintenance action pending for an DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.

Class PostgreSqlDataProviderSettings

Provides information that defines a PostgreSQL data provider.

Class PostgreSQLSettings

Provides information that defines a PostgreSQL endpoint.

Class ProvisionData

Information about provisioning resources for an DMS serverless replication.

Class RdsConfiguration

Provides information that describes the configuration of the recommended target engine on Amazon RDS.

Class RdsRecommendation

Provides information that describes a recommendation of a target engine on Amazon RDS.

Class RdsRequirements

Provides information that describes the requirements to the target engine on Amazon RDS.

Class RebootReplicationInstanceRequest

Container for the parameters to the RebootReplicationInstance operation. Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.

Class RebootReplicationInstanceResponse

This is the response object from the RebootReplicationInstance operation.

Class Recommendation

Provides information that describes a recommendation of a target engine.

A recommendation is a set of possible Amazon Web Services target engines that you can choose to migrate your source on-premises database. In this set, Fleet Advisor suggests a single target engine as the right sized migration destination. To determine this rightsized migration destination, Fleet Advisor uses the inventory metadata and metrics from data collector. You can use recommendations before the start of migration to save costs and reduce risks.

With recommendations, you can explore different target options and compare metrics, so you can make an informed decision when you choose the migration target.

Class RecommendationData

Provides information about the target engine for the specified source database.

Class RecommendationSettings

Provides information about the required target engine settings.

Class RedisSettings

Provides information that defines a Redis target endpoint.

Class RedshiftDataProviderSettings

Provides information that defines an Amazon Redshift data provider.

Class RedshiftSettings

Provides information that defines an Amazon Redshift endpoint.

Class RefreshSchemasRequest

Container for the parameters to the RefreshSchemas operation. 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 DescribeRefreshSchemasStatus operation.

Class RefreshSchemasResponse

Class RefreshSchemasStatus

Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.

Class ReloadReplicationTablesRequest

Container for the parameters to the ReloadReplicationTables operation. Reloads the target database table with the source data for a given DMS Serverless replication configuration.

You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.

Class ReloadReplicationTablesResponse

Class ReloadTablesRequest

Container for the parameters to the ReloadTables operation. Reloads the target database table with the source data.

You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.

Class ReloadTablesResponse

This is the response object from the ReloadTables operation.

Class RemoveTagsFromResourceRequest

Container for the parameters to the RemoveTagsFromResource operation. Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.

Class RemoveTagsFromResourceResponse

Class Replication

Provides information that describes a serverless replication created by the CreateReplication operation.

Class ReplicationConfig

This object provides configuration information about a serverless replication.

Class ReplicationInstance

Provides information that defines a replication instance.

Class ReplicationInstanceTaskLog

Contains metadata for a replication instance task log.

Class ReplicationPendingModifiedValues

Provides information about the values of pending modifications to a replication instance. This data type is an object of the ReplicationInstance user-defined data type.

Class ReplicationStats

This object provides a collection of statistics about a serverless replication.

Class ReplicationSubnetGroup

Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.

Class ReplicationSubnetGroupDoesNotCoverEnoughAZsException

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

Class ReplicationTask

Provides information that describes a replication task created by the CreateReplicationTask operation.

Class ReplicationTaskAssessmentResult

The task assessment report in JSON format.

Class ReplicationTaskAssessmentRun

Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.

Some of the information appears based on other operations that can return the ReplicationTaskAssessmentRun object.

Class ReplicationTaskAssessmentRunProgress

The progress values reported by the AssessmentProgress response element.

Class ReplicationTaskIndividualAssessment

Provides information that describes an individual assessment from a premigration assessment run.

Class ReplicationTaskStats

In response to a request by the DescribeReplicationTasks operation, this object provides a collection of statistics about a replication task.

Class ResourceAlreadyExistsException

The resource you are attempting to create already exists.

Class ResourceNotFoundException

The resource could not be found.

Class ResourcePendingMaintenanceActions

Identifies an DMS resource and any pending actions for it.

Class ResourceQuotaExceededException

The quota for this resource quota has been exceeded.

Class RunFleetAdvisorLsaAnalysisRequest

Container for the parameters to the RunFleetAdvisorLsaAnalysis operation. Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.

Class RunFleetAdvisorLsaAnalysisResponse

This is the response object from the RunFleetAdvisorLsaAnalysis operation.

Class S3AccessDeniedException

Insufficient privileges are preventing access to an Amazon S3 object.

Class S3ResourceNotFoundException

A specified Amazon S3 bucket, bucket folder, or other object can't be found.

Class S3Settings

Settings for exporting data to Amazon S3.

Class SCApplicationAttributes

Provides information that defines a schema conversion application.

Class SchemaConversionRequest

Provides information about a schema conversion action.

Class SchemaResponse

Describes a schema in a Fleet Advisor collector inventory.

Class SchemaShortInfoResponse

Describes a schema in a Fleet Advisor collector inventory.

Class ServerShortInfoResponse

Describes a server in a Fleet Advisor collector inventory.

Class SNSInvalidTopicException

The SNS topic is invalid.

Class SNSNoAuthorizationException

You are not authorized for the SNS subscription.

Class StartExtensionPackAssociationRequest

Container for the parameters to the StartExtensionPackAssociation operation. Applies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.

Class StartExtensionPackAssociationResponse

This is the response object from the StartExtensionPackAssociation operation.

Class StartMetadataModelAssessmentRequest

Container for the parameters to the StartMetadataModelAssessment operation. Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.

Class StartMetadataModelAssessmentResponse

This is the response object from the StartMetadataModelAssessment operation.

Class StartMetadataModelConversionRequest

Container for the parameters to the StartMetadataModelConversion operation. Converts your source database objects to a format compatible with the target database.

Class StartMetadataModelConversionResponse

This is the response object from the StartMetadataModelConversion operation.

Class StartMetadataModelExportAsScriptRequest

Container for the parameters to the StartMetadataModelExportAsScript operation. Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.

Class StartMetadataModelExportAsScriptResponse

This is the response object from the StartMetadataModelExportAsScript operation.

Class StartMetadataModelExportToTargetRequest

Container for the parameters to the StartMetadataModelExportToTarget operation. Applies converted database objects to your target database.

Class StartMetadataModelExportToTargetResponse

This is the response object from the StartMetadataModelExportToTarget operation.

Class StartMetadataModelImportRequest

Container for the parameters to the StartMetadataModelImport operation. Loads the metadata for all the dependent database objects of the parent object.

This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.

Class StartMetadataModelImportResponse

This is the response object from the StartMetadataModelImport operation.

Class StartRecommendationsRequest

Container for the parameters to the StartRecommendations operation. Starts the analysis of your source database to provide recommendations of target engines.

You can create recommendations for multiple source databases using BatchStartRecommendations.

Class StartRecommendationsRequestEntry

Provides information about the source database to analyze and provide target recommendations according to the specified requirements.

Class StartRecommendationsResponse

This is the response object from the StartRecommendations operation.

Class StartReplicationRequest

Container for the parameters to the StartReplication operation. For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.

Class StartReplicationResponse

Class StartReplicationTaskAssessmentRequest

Container for the parameters to the StartReplicationTaskAssessment operation. Starts the replication task assessment for unsupported data types in the source database.

You can only use this operation for a task if the following conditions are true:

  • The task must be in the stopped state.

  • The task must have successful connections to the source and target.

If either of these conditions are not met, an InvalidResourceStateFault error will result.

For information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.

Class StartReplicationTaskAssessmentResponse

Class StartReplicationTaskAssessmentRunRequest

Container for the parameters to the StartReplicationTaskAssessmentRun operation. Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

Class StartReplicationTaskAssessmentRunResponse

Class StartReplicationTaskRequest

Container for the parameters to the StartReplicationTask operation. Starts the replication task.

For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
Class StartReplicationTaskResponse

Class StopReplicationRequest

Container for the parameters to the StopReplication operation. For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.

Class StopReplicationResponse

This is the response object from the StopReplication operation.

Class StopReplicationTaskRequest

Container for the parameters to the StopReplicationTask operation. Stops the replication task.

Class StopReplicationTaskResponse

Class StorageQuotaExceededException

The storage quota has been exceeded.

Class Subnet

In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.

Class SubnetAlreadyInUseException

The specified subnet is already in use.

Class SupportedEndpointType

Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

Class SybaseSettings

Provides information that defines a SAP ASE endpoint.

Class TableStatistics

Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.

Class TableToReload

Provides the name of the schema and table to be reloaded.

Class Tag

A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

  • AddTagsToResource

  • ListTagsForResource

  • RemoveTagsFromResource
Class TestConnectionRequest

Container for the parameters to the TestConnection operation. Tests the connection between the replication instance and the endpoint.

Class TestConnectionResponse

Class TimestreamSettings

Provides information that defines an Amazon Timestream endpoint.

Class UpdateSubscriptionsToEventBridgeRequest

Container for the parameters to the UpdateSubscriptionsToEventBridge operation. Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.5 or higher. If any replication instances are from versions earlier than 3.4.5, the operation raises an error and tells you to upgrade these instances to version 3.4.5 or higher. To enable migration regardless of version, set the Force option to true. However, if you don't upgrade instances earlier than version 3.4.5, some types of events might not be available when you use Amazon EventBridge.

To call this operation, make sure that you have certain permissions added to your user account. For more information, see Migrating event subscriptions to Amazon EventBridge in the Amazon Web Services Database Migration Service User Guide.

Class UpdateSubscriptionsToEventBridgeResponse

Class UpgradeDependencyFailureException

An upgrade dependency is preventing the database migration.

Class VpcSecurityGroupMembership

Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.

Interfaces

NameDescription
Interface IDatabaseMigrationServicePaginatorFactory

Paginators for the DatabaseMigrationService service

Interface IDescribeApplicableIndividualAssessmentsPaginator

Paginator for the DescribeApplicableIndividualAssessments operation

Interface IDescribeCertificatesPaginator

Paginator for the DescribeCertificates operation

Interface IDescribeConnectionsPaginator

Paginator for the DescribeConnections operation

Interface IDescribeDataProvidersPaginator

Paginator for the DescribeDataProviders operation

Interface IDescribeEndpointSettingsPaginator

Paginator for the DescribeEndpointSettings operation

Interface IDescribeEndpointsPaginator

Paginator for the DescribeEndpoints operation

Interface IDescribeEndpointTypesPaginator

Paginator for the DescribeEndpointTypes operation

Interface IDescribeEngineVersionsPaginator

Paginator for the DescribeEngineVersions operation

Interface IDescribeEventsPaginator

Paginator for the DescribeEvents operation

Interface IDescribeEventSubscriptionsPaginator

Paginator for the DescribeEventSubscriptions operation

Interface IDescribeExtensionPackAssociationsPaginator

Paginator for the DescribeExtensionPackAssociations operation

Interface IDescribeFleetAdvisorCollectorsPaginator

Paginator for the DescribeFleetAdvisorCollectors operation

Interface IDescribeFleetAdvisorDatabasesPaginator

Paginator for the DescribeFleetAdvisorDatabases operation

Interface IDescribeFleetAdvisorLsaAnalysisPaginator

Paginator for the DescribeFleetAdvisorLsaAnalysis operation

Interface IDescribeFleetAdvisorSchemaObjectSummaryPaginator

Paginator for the DescribeFleetAdvisorSchemaObjectSummary operation

Interface IDescribeFleetAdvisorSchemasPaginator

Paginator for the DescribeFleetAdvisorSchemas operation

Interface IDescribeInstanceProfilesPaginator

Paginator for the DescribeInstanceProfiles operation

Interface IDescribeMetadataModelAssessmentsPaginator

Paginator for the DescribeMetadataModelAssessments operation

Interface IDescribeMetadataModelConversionsPaginator

Paginator for the DescribeMetadataModelConversions operation

Interface IDescribeMetadataModelExportsAsScriptPaginator

Paginator for the DescribeMetadataModelExportsAsScript operation

Interface IDescribeMetadataModelExportsToTargetPaginator

Paginator for the DescribeMetadataModelExportsToTarget operation

Interface IDescribeMetadataModelImportsPaginator

Paginator for the DescribeMetadataModelImports operation

Interface IDescribeMigrationProjectsPaginator

Paginator for the DescribeMigrationProjects operation

Interface IDescribeOrderableReplicationInstancesPaginator

Paginator for the DescribeOrderableReplicationInstances operation

Interface IDescribePendingMaintenanceActionsPaginator

Paginator for the DescribePendingMaintenanceActions operation

Interface IDescribeRecommendationLimitationsPaginator

Paginator for the DescribeRecommendationLimitations operation

Interface IDescribeRecommendationsPaginator

Paginator for the DescribeRecommendations operation

Interface IDescribeReplicationConfigsPaginator

Paginator for the DescribeReplicationConfigs operation

Interface IDescribeReplicationInstancesPaginator

Paginator for the DescribeReplicationInstances operation

Interface IDescribeReplicationInstanceTaskLogsPaginator

Paginator for the DescribeReplicationInstanceTaskLogs operation

Interface IDescribeReplicationsPaginator

Paginator for the DescribeReplications operation

Interface IDescribeReplicationSubnetGroupsPaginator

Paginator for the DescribeReplicationSubnetGroups operation

Interface IDescribeReplicationTableStatisticsPaginator

Paginator for the DescribeReplicationTableStatistics operation

Interface IDescribeReplicationTaskAssessmentResultsPaginator

Paginator for the DescribeReplicationTaskAssessmentResults operation

Interface IDescribeReplicationTaskAssessmentRunsPaginator

Paginator for the DescribeReplicationTaskAssessmentRuns operation

Interface IDescribeReplicationTaskIndividualAssessmentsPaginator

Paginator for the DescribeReplicationTaskIndividualAssessments operation

Interface IDescribeReplicationTasksPaginator

Paginator for the DescribeReplicationTasks operation

Interface IDescribeSchemasPaginator

Paginator for the DescribeSchemas operation

Interface IDescribeTableStatisticsPaginator

Paginator for the DescribeTableStatistics operation