/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.databasemigrationservice; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.databasemigrationservice.model.*; import com.amazonaws.services.databasemigrationservice.waiters.AWSDatabaseMigrationServiceWaiters; /** * Interface for accessing AWS Database Migration Service. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.databasemigrationservice.AbstractAWSDatabaseMigrationService} instead. *
*
*
* Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source * databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP * Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as * heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL. *
** For more information about DMS, see What Is * Database Migration Service? in the Database Migration Service User Guide. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSDatabaseMigrationService { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "dms"; /** * Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com"). Callers can use this method to * control which AWS region they want to work with. ** Callers can pass in just the endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol * (ex: "dms.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this * client's {@link ClientConfiguration} will be used, which by default is HTTPS. *
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available * endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *
* This method is not threadsafe. An endpoint should be configured when the client is created and before any * service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param endpoint * The endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: * "dms.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AWSDatabaseMigrationService#setEndpoint(String)}, sets the regional endpoint for this * client's service calls. Callers can use this method to control which AWS region they want to work with. *
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the * {@link ClientConfiguration} supplied at construction. *
* This method is not threadsafe. A region should be configured when the client is created and before any service * requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit * or retrying. * * @param region * The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)} * for accessing a given region. Must not be null and must be a region where the service is available. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *
* 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.
*
* Applies a pending maintenance action to a resource (for example, to a replication instance). *
* * @param applyPendingMaintenanceActionRequest * @return Result of the ApplyPendingMaintenanceAction operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.ApplyPendingMaintenanceAction * @see AWS API Documentation */ ApplyPendingMaintenanceActionResult applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest); /** ** 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
.
*
* 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. *
* * @param cancelReplicationTaskAssessmentRunRequest * @return Result of the CancelReplicationTaskAssessmentRun operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.CancelReplicationTaskAssessmentRun * @see AWS API Documentation */ CancelReplicationTaskAssessmentRunResult cancelReplicationTaskAssessmentRun( CancelReplicationTaskAssessmentRunRequest cancelReplicationTaskAssessmentRunRequest); /** ** 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.
*
* 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. *
* * @param createEventSubscriptionRequest * @return Result of the CreateEventSubscription operation returned by the service. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @throws ResourceNotFoundException * The resource could not be found. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws SNSInvalidTopicException * The SNS topic is invalid. * @throws SNSNoAuthorizationException * You are not authorized for the SNS subscription. * @throws KMSAccessDeniedException * The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to. * @throws KMSDisabledException * The specified KMS key isn't enabled. * @throws KMSInvalidStateException * The state of the specified KMS resource isn't valid for this request. * @throws KMSNotFoundException * The specified KMS entity or resource can't be found. * @throws KMSThrottlingException * This request triggered KMS request throttling. * @sample AWSDatabaseMigrationService.CreateEventSubscription * @see AWS * API Documentation */ CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest); /** ** Creates a Fleet Advisor collector using the specified parameters. *
* * @param createFleetAdvisorCollectorRequest * @return Result of the CreateFleetAdvisorCollector operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws S3AccessDeniedException * Insufficient privileges are preventing access to an Amazon S3 object. * @throws S3ResourceNotFoundException * A specified Amazon S3 bucket, bucket folder, or other object can't be found. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @sample AWSDatabaseMigrationService.CreateFleetAdvisorCollector * @see AWS API Documentation */ CreateFleetAdvisorCollectorResult createFleetAdvisorCollector(CreateFleetAdvisorCollectorRequest createFleetAdvisorCollectorRequest); /** ** 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. *
* * @param createReplicationConfigRequest * @return Result of the CreateReplicationConfig operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ReplicationSubnetGroupDoesNotCoverEnoughAZsException * The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet * group and add more AZs. * @throws InvalidSubnetException * The subnet provided isn't valid. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @sample AWSDatabaseMigrationService.CreateReplicationConfig * @see AWS * API Documentation */ CreateReplicationConfigResult createReplicationConfig(CreateReplicationConfigRequest createReplicationConfigRequest); /** ** 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. *
* * @param createReplicationInstanceRequest * @return Result of the CreateReplicationInstance operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws InsufficientResourceCapacityException * There are not enough resources allocated to the database migration. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @throws StorageQuotaExceededException * The storage quota has been exceeded. * @throws ResourceNotFoundException * The resource could not be found. * @throws ReplicationSubnetGroupDoesNotCoverEnoughAZsException * The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet * group and add more AZs. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws InvalidSubnetException * The subnet provided isn't valid. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @sample AWSDatabaseMigrationService.CreateReplicationInstance * @see AWS * API Documentation */ CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest); /** ** 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. *
* * @param createReplicationSubnetGroupRequest * @return Result of the CreateReplicationSubnetGroup operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws ResourceNotFoundException * The resource could not be found. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @throws ReplicationSubnetGroupDoesNotCoverEnoughAZsException * The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet * group and add more AZs. * @throws InvalidSubnetException * The subnet provided isn't valid. * @sample AWSDatabaseMigrationService.CreateReplicationSubnetGroup * @see AWS API Documentation */ CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest); /** ** Creates a replication task using the specified parameters. *
* * @param createReplicationTaskRequest * @return Result of the CreateReplicationTask operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws ResourceNotFoundException * The resource could not be found. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @sample AWSDatabaseMigrationService.CreateReplicationTask * @see AWS API * Documentation */ CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest); /** ** Deletes the specified certificate. *
* * @param deleteCertificateRequest * @return Result of the DeleteCertificate operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DeleteCertificate * @see AWS API * Documentation */ DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest); /** ** Deletes the connection between a replication instance and an endpoint. *
* * @param deleteConnectionRequest * @return Result of the DeleteConnection operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DeleteConnection * @see AWS API * Documentation */ DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest); /** ** Deletes the specified endpoint. *
** All tasks associated with the endpoint must be deleted before you can delete the endpoint. *
** Deletes an DMS event subscription. *
* * @param deleteEventSubscriptionRequest * @return Result of the DeleteEventSubscription operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DeleteEventSubscription * @see AWS * API Documentation */ DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest); /** ** Deletes the specified Fleet Advisor collector. *
* * @param deleteFleetAdvisorCollectorRequest * @return Result of the DeleteFleetAdvisorCollector operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws CollectorNotFoundException * The specified collector doesn't exist. * @sample AWSDatabaseMigrationService.DeleteFleetAdvisorCollector * @see AWS API Documentation */ DeleteFleetAdvisorCollectorResult deleteFleetAdvisorCollector(DeleteFleetAdvisorCollectorRequest deleteFleetAdvisorCollectorRequest); /** ** Deletes the specified Fleet Advisor collector databases. *
* * @param deleteFleetAdvisorDatabasesRequest * @return Result of the DeleteFleetAdvisorDatabases operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidOperationException * The action or operation requested isn't valid. * @sample AWSDatabaseMigrationService.DeleteFleetAdvisorDatabases * @see AWS API Documentation */ DeleteFleetAdvisorDatabasesResult deleteFleetAdvisorDatabases(DeleteFleetAdvisorDatabasesRequest deleteFleetAdvisorDatabasesRequest); /** ** 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. *
* * @param deleteReplicationConfigRequest * @return Result of the DeleteReplicationConfig operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DeleteReplicationConfig * @see AWS * API Documentation */ DeleteReplicationConfigResult deleteReplicationConfig(DeleteReplicationConfigRequest deleteReplicationConfigRequest); /** ** Deletes the specified replication instance. *
** You must delete any migration tasks that are associated with the replication instance before you can delete it. *
** Deletes a subnet group. *
* * @param deleteReplicationSubnetGroupRequest * @return Result of the DeleteReplicationSubnetGroup operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DeleteReplicationSubnetGroup * @see AWS API Documentation */ DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest); /** ** Deletes the specified replication task. *
* * @param deleteReplicationTaskRequest * @return Result of the DeleteReplicationTask operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DeleteReplicationTask * @see AWS API * Documentation */ DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest); /** ** 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. *
* * @param deleteReplicationTaskAssessmentRunRequest * @return Result of the DeleteReplicationTaskAssessmentRun operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DeleteReplicationTaskAssessmentRun * @see AWS API Documentation */ DeleteReplicationTaskAssessmentRunResult deleteReplicationTaskAssessmentRun( DeleteReplicationTaskAssessmentRunRequest deleteReplicationTaskAssessmentRunRequest); /** ** 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. *
* * @param describeAccountAttributesRequest * @return Result of the DescribeAccountAttributes operation returned by the service. * @sample AWSDatabaseMigrationService.DescribeAccountAttributes * @see AWS * API Documentation */ DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest); /** ** 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. *
* * @param describeApplicableIndividualAssessmentsRequest * @return Result of the DescribeApplicableIndividualAssessments operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeApplicableIndividualAssessments * @see AWS API Documentation */ DescribeApplicableIndividualAssessmentsResult describeApplicableIndividualAssessments( DescribeApplicableIndividualAssessmentsRequest describeApplicableIndividualAssessmentsRequest); /** ** Provides a description of the certificate. *
* * @param describeCertificatesRequest * @return Result of the DescribeCertificates operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeCertificates * @see AWS API * Documentation */ DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest); /** ** 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. *
* * @param describeConnectionsRequest * @return Result of the DescribeConnections operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeConnections * @see AWS API * Documentation */ DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest); /** ** Returns information about the possible endpoint settings available when you create an endpoint for a specific * database engine. *
* * @param describeEndpointSettingsRequest * @return Result of the DescribeEndpointSettings operation returned by the service. * @sample AWSDatabaseMigrationService.DescribeEndpointSettings * @see AWS * API Documentation */ DescribeEndpointSettingsResult describeEndpointSettings(DescribeEndpointSettingsRequest describeEndpointSettingsRequest); /** ** Returns information about the type of endpoints available. *
* * @param describeEndpointTypesRequest * @return Result of the DescribeEndpointTypes operation returned by the service. * @sample AWSDatabaseMigrationService.DescribeEndpointTypes * @see AWS API * Documentation */ DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest); /** ** Returns information about the endpoints for your account in the current region. *
* * @param describeEndpointsRequest * @return Result of the DescribeEndpoints operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeEndpoints * @see AWS API * Documentation */ DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest); /** ** 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. *
* * @param describeEventCategoriesRequest * @return Result of the DescribeEventCategories operation returned by the service. * @sample AWSDatabaseMigrationService.DescribeEventCategories * @see AWS * API Documentation */ DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest); /** *
* 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.
*
* 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. *
* * @param describeEventsRequest * @return Result of the DescribeEvents operation returned by the service. * @sample AWSDatabaseMigrationService.DescribeEvents * @see AWS API * Documentation */ DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest); /** ** Returns a list of the Fleet Advisor collectors in your account. *
* * @param describeFleetAdvisorCollectorsRequest * @return Result of the DescribeFleetAdvisorCollectors operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeFleetAdvisorCollectors * @see AWS API Documentation */ DescribeFleetAdvisorCollectorsResult describeFleetAdvisorCollectors(DescribeFleetAdvisorCollectorsRequest describeFleetAdvisorCollectorsRequest); /** ** Returns a list of Fleet Advisor databases in your account. *
* * @param describeFleetAdvisorDatabasesRequest * @return Result of the DescribeFleetAdvisorDatabases operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeFleetAdvisorDatabases * @see AWS API Documentation */ DescribeFleetAdvisorDatabasesResult describeFleetAdvisorDatabases(DescribeFleetAdvisorDatabasesRequest describeFleetAdvisorDatabasesRequest); /** ** Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors. *
* * @param describeFleetAdvisorLsaAnalysisRequest * @return Result of the DescribeFleetAdvisorLsaAnalysis operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeFleetAdvisorLsaAnalysis * @see AWS API Documentation */ DescribeFleetAdvisorLsaAnalysisResult describeFleetAdvisorLsaAnalysis(DescribeFleetAdvisorLsaAnalysisRequest describeFleetAdvisorLsaAnalysisRequest); /** ** Provides descriptions of the schemas discovered by your Fleet Advisor collectors. *
* * @param describeFleetAdvisorSchemaObjectSummaryRequest * @return Result of the DescribeFleetAdvisorSchemaObjectSummary operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeFleetAdvisorSchemaObjectSummary * @see AWS API Documentation */ DescribeFleetAdvisorSchemaObjectSummaryResult describeFleetAdvisorSchemaObjectSummary( DescribeFleetAdvisorSchemaObjectSummaryRequest describeFleetAdvisorSchemaObjectSummaryRequest); /** ** Returns a list of schemas detected by Fleet Advisor Collectors in your account. *
* * @param describeFleetAdvisorSchemasRequest * @return Result of the DescribeFleetAdvisorSchemas operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeFleetAdvisorSchemas * @see AWS API Documentation */ DescribeFleetAdvisorSchemasResult describeFleetAdvisorSchemas(DescribeFleetAdvisorSchemasRequest describeFleetAdvisorSchemasRequest); /** ** Returns information about the replication instance types that can be created in the specified region. *
* * @param describeOrderableReplicationInstancesRequest * @return Result of the DescribeOrderableReplicationInstances operation returned by the service. * @sample AWSDatabaseMigrationService.DescribeOrderableReplicationInstances * @see AWS API Documentation */ DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances( DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest); /** ** For internal use only *
* * @param describePendingMaintenanceActionsRequest * @return Result of the DescribePendingMaintenanceActions operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribePendingMaintenanceActions * @see AWS API Documentation */ DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest); /** ** Returns a paginated list of limitations for recommendations of target Amazon Web Services engines. *
* * @param describeRecommendationLimitationsRequest * @return Result of the DescribeRecommendationLimitations operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @sample AWSDatabaseMigrationService.DescribeRecommendationLimitations * @see AWS API Documentation */ DescribeRecommendationLimitationsResult describeRecommendationLimitations(DescribeRecommendationLimitationsRequest describeRecommendationLimitationsRequest); /** ** Returns a paginated list of target engine recommendations for your source databases. *
* * @param describeRecommendationsRequest * @return Result of the DescribeRecommendations operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @sample AWSDatabaseMigrationService.DescribeRecommendations * @see AWS * API Documentation */ DescribeRecommendationsResult describeRecommendations(DescribeRecommendationsRequest describeRecommendationsRequest); /** ** Returns the status of the RefreshSchemas operation. *
* * @param describeRefreshSchemasStatusRequest * @return Result of the DescribeRefreshSchemasStatus operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeRefreshSchemasStatus * @see AWS API Documentation */ DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest); /** ** Returns one or more existing DMS Serverless replication configurations as a list of structures. *
* * @param describeReplicationConfigsRequest * @return Result of the DescribeReplicationConfigs operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplicationConfigs * @see AWS * API Documentation */ DescribeReplicationConfigsResult describeReplicationConfigs(DescribeReplicationConfigsRequest describeReplicationConfigsRequest); /** ** Returns information about the task logs for the specified task. *
* * @param describeReplicationInstanceTaskLogsRequest * @return Result of the DescribeReplicationInstanceTaskLogs operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeReplicationInstanceTaskLogs * @see AWS API Documentation */ DescribeReplicationInstanceTaskLogsResult describeReplicationInstanceTaskLogs( DescribeReplicationInstanceTaskLogsRequest describeReplicationInstanceTaskLogsRequest); /** ** Returns information about replication instances for your account in the current region. *
* * @param describeReplicationInstancesRequest * @return Result of the DescribeReplicationInstances operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplicationInstances * @see AWS API Documentation */ DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest); /** ** Returns information about the replication subnet groups. *
* * @param describeReplicationSubnetGroupsRequest * @return Result of the DescribeReplicationSubnetGroups operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplicationSubnetGroups * @see AWS API Documentation */ DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest); /** ** Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless * replication configuration. *
* * @param describeReplicationTableStatisticsRequest * @return Result of the DescribeReplicationTableStatistics operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeReplicationTableStatistics * @see AWS API Documentation */ DescribeReplicationTableStatisticsResult describeReplicationTableStatistics( DescribeReplicationTableStatisticsRequest describeReplicationTableStatisticsRequest); /** ** 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. *
* * @param describeReplicationTaskAssessmentResultsRequest * @return Result of the DescribeReplicationTaskAssessmentResults operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplicationTaskAssessmentResults * @see AWS API Documentation */ DescribeReplicationTaskAssessmentResultsResult describeReplicationTaskAssessmentResults( DescribeReplicationTaskAssessmentResultsRequest describeReplicationTaskAssessmentResultsRequest); /** ** 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.
*
* 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. *
* * @param describeReplicationTaskIndividualAssessmentsRequest * @return Result of the DescribeReplicationTaskIndividualAssessments operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplicationTaskIndividualAssessments * @see AWS API Documentation */ DescribeReplicationTaskIndividualAssessmentsResult describeReplicationTaskIndividualAssessments( DescribeReplicationTaskIndividualAssessmentsRequest describeReplicationTaskIndividualAssessmentsRequest); /** ** Returns information about replication tasks for your account in the current region. *
* * @param describeReplicationTasksRequest * @return Result of the DescribeReplicationTasks operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplicationTasks * @see AWS * API Documentation */ DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest); /** ** Provides details on replication progress by returning status information for one or more provisioned DMS * Serverless replications. *
* * @param describeReplicationsRequest * @return Result of the DescribeReplications operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeReplications * @see AWS API * Documentation */ DescribeReplicationsResult describeReplications(DescribeReplicationsRequest describeReplicationsRequest); /** ** Returns information about the schema for the specified endpoint. *
* * * @param describeSchemasRequest * @return Result of the DescribeSchemas operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.DescribeSchemas * @see AWS API * Documentation */ DescribeSchemasResult describeSchemas(DescribeSchemasRequest describeSchemasRequest); /** ** 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. *
* * @param describeTableStatisticsRequest * @return Result of the DescribeTableStatistics operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.DescribeTableStatistics * @see AWS * API Documentation */ DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest); /** ** Uploads the specified certificate. *
* * @param importCertificateRequest * @return Result of the ImportCertificate operation returned by the service. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws InvalidCertificateException * The certificate was not valid. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @sample AWSDatabaseMigrationService.ImportCertificate * @see AWS API * Documentation */ ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest); /** *
* 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.
*
* 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.
*
* Modifies an existing DMS event notification subscription. *
* * @param modifyEventSubscriptionRequest * @return Result of the ModifyEventSubscription operation returned by the service. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @throws ResourceNotFoundException * The resource could not be found. * @throws SNSInvalidTopicException * The SNS topic is invalid. * @throws SNSNoAuthorizationException * You are not authorized for the SNS subscription. * @throws KMSAccessDeniedException * The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to. * @throws KMSDisabledException * The specified KMS key isn't enabled. * @throws KMSInvalidStateException * The state of the specified KMS resource isn't valid for this request. * @throws KMSNotFoundException * The specified KMS entity or resource can't be found. * @throws KMSThrottlingException * This request triggered KMS request throttling. * @sample AWSDatabaseMigrationService.ModifyEventSubscription * @see AWS * API Documentation */ ModifyEventSubscriptionResult modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest); /** ** 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. *
* * @param modifyReplicationConfigRequest * @return Result of the ModifyReplicationConfig operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws ReplicationSubnetGroupDoesNotCoverEnoughAZsException * The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet * group and add more AZs. * @throws InvalidSubnetException * The subnet provided isn't valid. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.ModifyReplicationConfig * @see AWS * API Documentation */ ModifyReplicationConfigResult modifyReplicationConfig(ModifyReplicationConfigRequest modifyReplicationConfigRequest); /** ** 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. *
* * * @param modifyReplicationInstanceRequest * @return Result of the ModifyReplicationInstance operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws ResourceNotFoundException * The resource could not be found. * @throws InsufficientResourceCapacityException * There are not enough resources allocated to the database migration. * @throws StorageQuotaExceededException * The storage quota has been exceeded. * @throws UpgradeDependencyFailureException * An upgrade dependency is preventing the database migration. * @sample AWSDatabaseMigrationService.ModifyReplicationInstance * @see AWS * API Documentation */ ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest); /** ** Modifies the settings for the specified replication subnet group. *
* * @param modifyReplicationSubnetGroupRequest * @return Result of the ModifyReplicationSubnetGroup operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @throws SubnetAlreadyInUseException * The specified subnet is already in use. * @throws ReplicationSubnetGroupDoesNotCoverEnoughAZsException * The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet * group and add more AZs. * @throws InvalidSubnetException * The subnet provided isn't valid. * @sample AWSDatabaseMigrationService.ModifyReplicationSubnetGroup * @see AWS API Documentation */ ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest); /** ** 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. *
* * @param modifyReplicationTaskRequest * @return Result of the ModifyReplicationTask operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @sample AWSDatabaseMigrationService.ModifyReplicationTask * @see AWS API * Documentation */ ModifyReplicationTaskResult modifyReplicationTask(ModifyReplicationTaskRequest modifyReplicationTaskRequest); /** ** 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. *
* * @param moveReplicationTaskRequest * @return Result of the MoveReplicationTask operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @sample AWSDatabaseMigrationService.MoveReplicationTask * @see AWS API * Documentation */ MoveReplicationTaskResult moveReplicationTask(MoveReplicationTaskRequest moveReplicationTaskRequest); /** ** Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes * available again. *
* * @param rebootReplicationInstanceRequest * @return Result of the RebootReplicationInstance operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.RebootReplicationInstance * @see AWS * API Documentation */ RebootReplicationInstanceResult rebootReplicationInstance(RebootReplicationInstanceRequest rebootReplicationInstanceRequest); /** ** 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. *
* * @param refreshSchemasRequest * @return Result of the RefreshSchemas operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @sample AWSDatabaseMigrationService.RefreshSchemas * @see AWS API * Documentation */ RefreshSchemasResult refreshSchemas(RefreshSchemasRequest refreshSchemasRequest); /** ** 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.
*
* 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.
*
* Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration
* task. For more information, see
* Tag
data type description.
*
* Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account. *
* * @param runFleetAdvisorLsaAnalysisRequest * @return Result of the RunFleetAdvisorLsaAnalysis operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.RunFleetAdvisorLsaAnalysis * @see AWS * API Documentation */ RunFleetAdvisorLsaAnalysisResult runFleetAdvisorLsaAnalysis(RunFleetAdvisorLsaAnalysisRequest runFleetAdvisorLsaAnalysisRequest); /** ** Starts the analysis of your source database to provide recommendations of target engines. *
** You can create recommendations for multiple source databases using BatchStartRecommendations. *
* * @param startRecommendationsRequest * @return Result of the StartRecommendations operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.StartRecommendations * @see AWS API * Documentation */ StartRecommendationsResult startRecommendations(StartRecommendationsRequest startRecommendationsRequest); /** ** 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. *
* * @param startReplicationRequest * @return Result of the StartReplication operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @sample AWSDatabaseMigrationService.StartReplication * @see AWS API * Documentation */ StartReplicationResult startReplication(StartReplicationRequest startReplicationRequest); /** ** Starts the replication task. *
** For more information about DMS tasks, see Working with Migration Tasks in the * Database Migration Service User Guide. *
* * @param startReplicationTaskRequest * @return Result of the StartReplicationTask operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @sample AWSDatabaseMigrationService.StartReplicationTask * @see AWS API * Documentation */ StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest); /** ** 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. *
* * @param startReplicationTaskAssessmentRequest * @return Result of the StartReplicationTaskAssessment operation returned by the service. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws ResourceNotFoundException * The resource could not be found. * @sample AWSDatabaseMigrationService.StartReplicationTaskAssessment * @see AWS API Documentation */ StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest startReplicationTaskAssessmentRequest); /** ** 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. *
* * @param startReplicationTaskAssessmentRunRequest * @return Result of the StartReplicationTaskAssessmentRun operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws KMSAccessDeniedException * The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to. * @throws KMSDisabledException * The specified KMS key isn't enabled. * @throws KMSException * An Key Management Service (KMS) error is preventing access to KMS. * @throws KMSInvalidStateException * The state of the specified KMS resource isn't valid for this request. * @throws KMSNotFoundException * The specified KMS entity or resource can't be found. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws S3AccessDeniedException * Insufficient privileges are preventing access to an Amazon S3 object. * @throws S3ResourceNotFoundException * A specified Amazon S3 bucket, bucket folder, or other object can't be found. * @throws ResourceAlreadyExistsException * The resource you are attempting to create already exists. * @sample AWSDatabaseMigrationService.StartReplicationTaskAssessmentRun * @see AWS API Documentation */ StartReplicationTaskAssessmentRunResult startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest startReplicationTaskAssessmentRunRequest); /** ** For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. * This command doesn't deprovision the stopped replications. *
* * @param stopReplicationRequest * @return Result of the StopReplication operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @sample AWSDatabaseMigrationService.StopReplication * @see AWS API * Documentation */ StopReplicationResult stopReplication(StopReplicationRequest stopReplicationRequest); /** ** Stops the replication task. *
* * @param stopReplicationTaskRequest * @return Result of the StopReplicationTask operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.StopReplicationTask * @see AWS API * Documentation */ StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest); /** ** Tests the connection between the replication instance and the endpoint. *
* * @param testConnectionRequest * @return Result of the TestConnection operation returned by the service. * @throws ResourceNotFoundException * The resource could not be found. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @throws KMSKeyNotAccessibleException * DMS cannot access the KMS key. * @throws ResourceQuotaExceededException * The quota for this resource quota has been exceeded. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @sample AWSDatabaseMigrationService.TestConnection * @see AWS API * Documentation */ TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest); /** *
* 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.6 or higher. If any replication instances are from versions earlier than 3.4.6, the operation
* raises an error and tells you to upgrade these instances to version 3.4.6 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.6, 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. *
* * @param updateSubscriptionsToEventBridgeRequest * @return Result of the UpdateSubscriptionsToEventBridge operation returned by the service. * @throws AccessDeniedException * DMS was denied access to the endpoint. Check that the role is correctly configured. * @throws InvalidResourceStateException * The resource is in a state that prevents it from being used for database migration. * @sample AWSDatabaseMigrationService.UpdateSubscriptionsToEventBridge * @see AWS API Documentation */ UpdateSubscriptionsToEventBridgeResult updateSubscriptionsToEventBridge(UpdateSubscriptionsToEventBridgeRequest updateSubscriptionsToEventBridgeRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. ** Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); AWSDatabaseMigrationServiceWaiters waiters(); }