JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.databasemigrationservice

Interface AWSDatabaseMigrationService

    • Method Detail

      • setEndpoint

        @Deprecated
void setEndpoint(String endpoint)
        Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
        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 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.

        Parameters:
        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.

      • addTagsToResource

        AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

        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.

        Parameters:
        addTagsToResourceRequest - Associates a set of tags with an DMS resource.
        Returns:
        Result of the AddTagsToResource operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Add tags to resource
          Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
AddTagsToResourceRequest request = new AddTagsToResourceRequest()
//Required. Use the ARN of the resource you want to tag.
 .withResourceArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E")//Required. Use the Key/Value pair format.
 .withTags(new Tag().withKey("Acount").withValue("1633456"));
AddTagsToResourceResult response = client.addTagsToResource(request);

      • batchStartRecommendations

        BatchStartRecommendationsResult batchStartRecommendations(BatchStartRecommendationsRequest batchStartRecommendationsRequest)

        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.

        Parameters:
        batchStartRecommendationsRequest -
        Returns:
        Result of the BatchStartRecommendations operation returned by the service.
        Throws:
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

      • cancelReplicationTaskAssessmentRun

        CancelReplicationTaskAssessmentRunResult cancelReplicationTaskAssessmentRun(CancelReplicationTaskAssessmentRunRequest cancelReplicationTaskAssessmentRunRequest)

        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.

        Parameters:
        cancelReplicationTaskAssessmentRunRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • createEndpoint

        CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)

        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.

        Parameters:
        createEndpointRequest -
        Returns:
        Result of the CreateEndpoint operation returned by the service.
        Throws:
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        S3AccessDeniedException - Insufficient privileges are preventing access to an Amazon S3 object.
        See Also:
        AWS API Documentation

        Samples:
        • Create endpoint
          Creates an endpoint using the provided settings.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateEndpointRequest request = new CreateEndpointRequest().withEndpointIdentifier("test-endpoint-1").withEndpointType("source")
 .withEngineName("mysql").withUsername("username").withPassword("pasword").withServerName("mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com")
 .withPort(3306).withDatabaseName("testdb").withExtraConnectionAttributes("")
 .withKmsKeyId("arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd")
 .withTags(new Tag().withKey("Acount").withValue("143327655")).withCertificateArn("").withSslMode("require");
CreateEndpointResult response = client.createEndpoint(request);

      • createEventSubscription

        CreateEventSubscriptionResult createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)

        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.

        Parameters:
        createEventSubscriptionRequest -
        Returns:
        Result of the CreateEventSubscription operation returned by the service.
        Throws:
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        ResourceNotFoundException - The resource could not be found.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        SNSInvalidTopicException - The SNS topic is invalid.
        SNSNoAuthorizationException - You are not authorized for the SNS subscription.
        KMSAccessDeniedException - The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.
        KMSDisabledException - The specified KMS key isn't enabled.
        KMSInvalidStateException - The state of the specified KMS resource isn't valid for this request.
        KMSNotFoundException - The specified KMS entity or resource can't be found.
        KMSThrottlingException - This request triggered KMS request throttling.
        See Also:
        AWS API Documentation

      • createReplicationInstance

        CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest createReplicationInstanceRequest)

        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.

        Parameters:
        createReplicationInstanceRequest -
        Returns:
        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.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        InsufficientResourceCapacityException - There are not enough resources allocated to the database migration.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        StorageQuotaExceededException - The storage quota has been exceeded.
        ResourceNotFoundException - The resource could not be found.
        ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        InvalidSubnetException - The subnet provided isn't valid.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        See Also:
        AWS API Documentation

        Samples:
        • Create replication instance
          Creates the replication instance using the specified parameters.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateReplicationInstanceRequest request = new CreateReplicationInstanceRequest().withReplicationInstanceIdentifier("").withAllocatedStorage(123)
 .withReplicationInstanceClass("").withVpcSecurityGroupIds(new ArrayList()).withAvailabilityZone("").withReplicationSubnetGroupIdentifier("")
 .withPreferredMaintenanceWindow("").withMultiAZ(true).withEngineVersion("").withAutoMinorVersionUpgrade(true)
 .withTags(new Tag().withKey("string").withValue("string")).withKmsKeyId("").withPubliclyAccessible(true);
CreateReplicationInstanceResult response = client.createReplicationInstance(request);

      • createReplicationSubnetGroup

        CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest createReplicationSubnetGroupRequest)

        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.

        Parameters:
        createReplicationSubnetGroupRequest -
        Returns:
        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.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        ResourceNotFoundException - The resource could not be found.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
        InvalidSubnetException - The subnet provided isn't valid.
        See Also:
        AWS API Documentation

        Samples:
        • Create replication subnet group
          Creates a replication subnet group given a list of the subnet IDs in a VPC.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateReplicationSubnetGroupRequest request = new CreateReplicationSubnetGroupRequest()
 .withReplicationSubnetGroupIdentifier("us-west-2ab-vpc-215ds366").withReplicationSubnetGroupDescription("US West subnet group")
 .withSubnetIds("subnet-e145356n", "subnet-58f79200").withTags(new Tag().withKey("Acount").withValue("145235"));
CreateReplicationSubnetGroupResult response = client.createReplicationSubnetGroup(request);

      • createReplicationTask

        CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest createReplicationTaskRequest)

        Creates a replication task using the specified parameters.

        Parameters:
        createReplicationTaskRequest -
        Returns:
        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.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        ResourceNotFoundException - The resource could not be found.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        See Also:
        AWS API Documentation

        Samples:
        • Create replication task
          Creates a replication task using the specified parameters.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
CreateReplicationTaskRequest request = new CreateReplicationTaskRequest().withReplicationTaskIdentifier("task1")
 .withSourceEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE")
 .withTargetEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E")
 .withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withMigrationType("full-load")
 .withTableMappings("file://mappingfile.json").withReplicationTaskSettings("").withCdcStartTime(new Date("2016-12-14T18:25:43Z"))
 .withTags(new Tag().withKey("Acount").withValue("24352226"));
CreateReplicationTaskResult response = client.createReplicationTask(request);

      • deleteCertificate

        DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

        Deletes the specified certificate.

        Parameters:
        deleteCertificateRequest -
        Returns:
        Result of the DeleteCertificate operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

        Samples:
        • Delete Certificate
          Deletes the specified certificate.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteCertificateRequest request = new DeleteCertificateRequest().withCertificateArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ");
DeleteCertificateResult response = client.deleteCertificate(request);

      • deleteEndpoint

        DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

        Deletes the specified endpoint.

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

        Parameters:
        deleteEndpointRequest -
        Returns:
        Result of the DeleteEndpoint operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

        Samples:
        • Delete Endpoint
          Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteEndpointRequest request = new DeleteEndpointRequest().withEndpointArn("arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM");
DeleteEndpointResult response = client.deleteEndpoint(request);

      • deleteReplicationConfig

        DeleteReplicationConfigResult deleteReplicationConfig(DeleteReplicationConfigRequest deleteReplicationConfigRequest)

        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.

        Parameters:
        deleteReplicationConfigRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • deleteReplicationInstance

        DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest deleteReplicationInstanceRequest)

        Deletes the specified replication instance.

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

        Parameters:
        deleteReplicationInstanceRequest -
        Returns:
        Result of the DeleteReplicationInstance operation returned by the service.
        Throws:
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Delete Replication Instance
          Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteReplicationInstanceRequest request = new DeleteReplicationInstanceRequest()
 .withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ");
DeleteReplicationInstanceResult response = client.deleteReplicationInstance(request);

      • deleteReplicationSubnetGroup

        DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest deleteReplicationSubnetGroupRequest)

        Deletes a subnet group.

        Parameters:
        deleteReplicationSubnetGroupRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Delete Replication Subnet Group
          Deletes a replication subnet group.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteReplicationSubnetGroupRequest request = new DeleteReplicationSubnetGroupRequest()
 .withReplicationSubnetGroupIdentifier("us-west-2ab-vpc-215ds366");
DeleteReplicationSubnetGroupResult response = client.deleteReplicationSubnetGroup(request);

      • deleteReplicationTask

        DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest deleteReplicationTaskRequest)

        Deletes the specified replication task.

        Parameters:
        deleteReplicationTaskRequest -
        Returns:
        Result of the DeleteReplicationTask operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

        Samples:
        • Delete Replication Task
          Deletes the specified replication task.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DeleteReplicationTaskRequest request = new DeleteReplicationTaskRequest()
 .withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ");
DeleteReplicationTaskResult response = client.deleteReplicationTask(request);

      • deleteReplicationTaskAssessmentRun

        DeleteReplicationTaskAssessmentRunResult deleteReplicationTaskAssessmentRun(DeleteReplicationTaskAssessmentRunRequest deleteReplicationTaskAssessmentRunRequest)

        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.

        Parameters:
        deleteReplicationTaskAssessmentRunRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • describeAccountAttributes

        DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)

        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.

        Parameters:
        describeAccountAttributesRequest -
        Returns:
        Result of the DescribeAccountAttributes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • Describe acount attributes
          Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest();
DescribeAccountAttributesResult response = client.describeAccountAttributes(request);

      • describeApplicableIndividualAssessments

        DescribeApplicableIndividualAssessmentsResult describeApplicableIndividualAssessments(DescribeApplicableIndividualAssessmentsRequest describeApplicableIndividualAssessmentsRequest)

        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.

        Parameters:
        describeApplicableIndividualAssessmentsRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • describeCertificates

        DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)

        Provides a description of the certificate.

        Parameters:
        describeCertificatesRequest -
        Returns:
        Result of the DescribeCertificates operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe certificates
          Provides a description of the certificate.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeCertificatesRequest request = new DescribeCertificatesRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
 .withMaxRecords(123).withMarker("");
DescribeCertificatesResult response = client.describeCertificates(request);

      • describeConnections

        DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest)

        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.

        Parameters:
        describeConnectionsRequest -
        Returns:
        Result of the DescribeConnections operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe connections
          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.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeConnectionsRequest request = new DescribeConnectionsRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
 .withMaxRecords(123).withMarker("");
DescribeConnectionsResult response = client.describeConnections(request);

      • describeEndpointSettings

        DescribeEndpointSettingsResult describeEndpointSettings(DescribeEndpointSettingsRequest describeEndpointSettingsRequest)

        Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

        Parameters:
        describeEndpointSettingsRequest -
        Returns:
        Result of the DescribeEndpointSettings operation returned by the service.
        See Also:
        AWS API Documentation

      • describeEndpointTypes

        DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest describeEndpointTypesRequest)

        Returns information about the type of endpoints available.

        Parameters:
        describeEndpointTypesRequest -
        Returns:
        Result of the DescribeEndpointTypes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • Describe endpoint types
          Returns information about the type of endpoints available.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeEndpointTypesRequest request = new DescribeEndpointTypesRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
 .withMaxRecords(123).withMarker("");
DescribeEndpointTypesResult response = client.describeEndpointTypes(request);

      • describeEndpoints

        DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)

        Returns information about the endpoints for your account in the current region.

        Parameters:
        describeEndpointsRequest -
        Returns:
        Result of the DescribeEndpoints operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe endpoints
          Returns information about the endpoints for your account in the current region.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeEndpointsRequest request = new DescribeEndpointsRequest().withFilters(new Filter().withName("string").withValues("string", "string"))
 .withMaxRecords(123).withMarker("");
DescribeEndpointsResult response = client.describeEndpoints(request);

      • describeEventSubscriptions

        DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)

        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.

        Parameters:
        describeEventSubscriptionsRequest -
        Returns:
        Result of the DescribeEventSubscriptions operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

      • describeExtensionPackAssociations

        DescribeExtensionPackAssociationsResult describeExtensionPackAssociations(DescribeExtensionPackAssociationsRequest describeExtensionPackAssociationsRequest)

        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.

        Parameters:
        describeExtensionPackAssociationsRequest -
        Returns:
        Result of the DescribeExtensionPackAssociations operation returned by the service.
        See Also:
        AWS API Documentation

      • describeOrderableReplicationInstances

        DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest describeOrderableReplicationInstancesRequest)

        Returns information about the replication instance types that can be created in the specified region.

        Parameters:
        describeOrderableReplicationInstancesRequest -
        Returns:
        Result of the DescribeOrderableReplicationInstances operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • Describe orderable replication instances
          Returns information about the replication instance types that can be created in the specified region.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeOrderableReplicationInstancesRequest request = new DescribeOrderableReplicationInstancesRequest().withMaxRecords(123).withMarker("");
DescribeOrderableReplicationInstancesResult response = client.describeOrderableReplicationInstances(request);

      • describeRefreshSchemasStatus

        DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest describeRefreshSchemasStatusRequest)

        Returns the status of the RefreshSchemas operation.

        Parameters:
        describeRefreshSchemasStatusRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe refresh schema status
          Returns the status of the refresh-schemas operation.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeRefreshSchemasStatusRequest request = new DescribeRefreshSchemasStatusRequest().withEndpointArn("");
DescribeRefreshSchemasStatusResult response = client.describeRefreshSchemasStatus(request);

      • describeReplicationInstances

        DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest describeReplicationInstancesRequest)

        Returns information about replication instances for your account in the current region.

        Parameters:
        describeReplicationInstancesRequest -
        Returns:
        Result of the DescribeReplicationInstances operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe replication instances
          Returns the status of the refresh-schemas operation.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeReplicationInstancesRequest request = new DescribeReplicationInstancesRequest()
 .withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker("");
DescribeReplicationInstancesResult response = client.describeReplicationInstances(request);

      • describeReplicationSubnetGroups

        DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest describeReplicationSubnetGroupsRequest)

        Returns information about the replication subnet groups.

        Parameters:
        describeReplicationSubnetGroupsRequest -
        Returns:
        Result of the DescribeReplicationSubnetGroups operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe replication subnet groups
          Returns information about the replication subnet groups.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeReplicationSubnetGroupsRequest request = new DescribeReplicationSubnetGroupsRequest()
 .withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker("");
DescribeReplicationSubnetGroupsResult response = client.describeReplicationSubnetGroups(request);

      • describeReplicationTaskAssessmentRuns

        DescribeReplicationTaskAssessmentRunsResult describeReplicationTaskAssessmentRuns(DescribeReplicationTaskAssessmentRunsRequest describeReplicationTaskAssessmentRunsRequest)

        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.

        Parameters:
        describeReplicationTaskAssessmentRunsRequest -
        Returns:
        Result of the DescribeReplicationTaskAssessmentRuns operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

      • describeReplicationTasks

        DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest describeReplicationTasksRequest)

        Returns information about replication tasks for your account in the current region.

        Parameters:
        describeReplicationTasksRequest -
        Returns:
        Result of the DescribeReplicationTasks operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe replication tasks
          Returns information about replication tasks for your account in the current region.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeReplicationTasksRequest request = new DescribeReplicationTasksRequest()
 .withFilters(new Filter().withName("string").withValues("string", "string")).withMaxRecords(123).withMarker("");
DescribeReplicationTasksResult response = client.describeReplicationTasks(request);

      • describeSchemas

        DescribeSchemasResult describeSchemas(DescribeSchemasRequest describeSchemasRequest)

        Returns information about the schema for the specified endpoint.

        Parameters:
        describeSchemasRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Describe schemas
          Returns information about the schema for the specified endpoint.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeSchemasRequest request = new DescribeSchemasRequest().withEndpointArn("").withMaxRecords(123).withMarker("");
DescribeSchemasResult response = client.describeSchemas(request);

      • describeTableStatistics

        DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest describeTableStatisticsRequest)

        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.

        Parameters:
        describeTableStatisticsRequest -
        Returns:
        Result of the DescribeTableStatistics operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

        Samples:
        • Describe table statistics
          Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
DescribeTableStatisticsRequest request = new DescribeTableStatisticsRequest().withReplicationTaskArn("").withMaxRecords(123).withMarker("");
DescribeTableStatisticsResult response = client.describeTableStatistics(request);

      • importCertificate

        ImportCertificateResult importCertificate(ImportCertificateRequest importCertificateRequest)

        Uploads the specified certificate.

        Parameters:
        importCertificateRequest -
        Returns:
        Result of the ImportCertificate operation returned by the service.
        Throws:
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        InvalidCertificateException - The certificate was not valid.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        See Also:
        AWS API Documentation

        Samples:
        • Import certificate
          Uploads the specified certificate.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ImportCertificateRequest request = new ImportCertificateRequest().withCertificateIdentifier("").withCertificatePem("");
ImportCertificateResult response = client.importCertificate(request);

      • listTagsForResource

        ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

        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.

        Parameters:
        listTagsForResourceRequest -
        Returns:
        Result of the ListTagsForResource operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • List tags for resource
          Lists all tags for an AWS DMS resource.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ListTagsForResourceRequest request = new ListTagsForResourceRequest().withResourceArn("");
ListTagsForResourceResult response = client.listTagsForResource(request);

      • modifyEndpoint

        ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest modifyEndpointRequest)

        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.

        Parameters:
        modifyEndpointRequest -
        Returns:
        Result of the ModifyEndpoint operation returned by the service.
        Throws:
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        ResourceNotFoundException - The resource could not be found.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        See Also:
        AWS API Documentation

        Samples:
        • Modify endpoint
          Modifies the specified endpoint.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ModifyEndpointRequest request = new ModifyEndpointRequest().withEndpointArn("").withEndpointIdentifier("").withEndpointType("source")
 .withEngineName("").withUsername("").withPassword("").withServerName("").withPort(123).withDatabaseName("").withExtraConnectionAttributes("")
 .withCertificateArn("").withSslMode("require");
ModifyEndpointResult response = client.modifyEndpoint(request);

      • modifyReplicationConfig

        ModifyReplicationConfigResult modifyReplicationConfig(ModifyReplicationConfigRequest modifyReplicationConfigRequest)

        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.

        Parameters:
        modifyReplicationConfigRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
        InvalidSubnetException - The subnet provided isn't valid.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • modifyReplicationInstance

        ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest modifyReplicationInstanceRequest)

        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.

        Parameters:
        modifyReplicationInstanceRequest -
        Returns:
        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.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        ResourceNotFoundException - The resource could not be found.
        InsufficientResourceCapacityException - There are not enough resources allocated to the database migration.
        StorageQuotaExceededException - The storage quota has been exceeded.
        UpgradeDependencyFailureException - An upgrade dependency is preventing the database migration.
        See Also:
        AWS API Documentation

        Samples:
        • Modify replication instance
          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.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ModifyReplicationInstanceRequest request = new ModifyReplicationInstanceRequest()
 .withReplicationInstanceArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withAllocatedStorage(123)
 .withApplyImmediately(true).withReplicationInstanceClass("dms.t2.micro").withVpcSecurityGroupIds(new ArrayList())
 .withPreferredMaintenanceWindow("sun:06:00-sun:14:00").withMultiAZ(true).withEngineVersion("1.5.0").withAllowMajorVersionUpgrade(true)
 .withAutoMinorVersionUpgrade(true).withReplicationInstanceIdentifier("test-rep-1");
ModifyReplicationInstanceResult response = client.modifyReplicationInstance(request);

      • modifyReplicationSubnetGroup

        ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest modifyReplicationSubnetGroupRequest)

        Modifies the settings for the specified replication subnet group.

        Parameters:
        modifyReplicationSubnetGroupRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        SubnetAlreadyInUseException - The specified subnet is already in use.
        ReplicationSubnetGroupDoesNotCoverEnoughAZsException - The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
        InvalidSubnetException - The subnet provided isn't valid.
        See Also:
        AWS API Documentation

        Samples:
        • Modify replication subnet group
          Modifies the settings for the specified replication subnet group.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
ModifyReplicationSubnetGroupRequest request = new ModifyReplicationSubnetGroupRequest().withReplicationSubnetGroupIdentifier("")
 .withReplicationSubnetGroupDescription("").withSubnetIds(new ArrayList());
ModifyReplicationSubnetGroupResult response = client.modifyReplicationSubnetGroup(request);

      • refreshSchemas

        RefreshSchemasResult refreshSchemas(RefreshSchemasRequest refreshSchemasRequest)

        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.

        Parameters:
        refreshSchemasRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        See Also:
        AWS API Documentation

        Samples:
        • Refresh schema
          Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
RefreshSchemasRequest request = new RefreshSchemasRequest().withEndpointArn("").withReplicationInstanceArn("");
RefreshSchemasResult response = client.refreshSchemas(request);

      • reloadReplicationTables

        ReloadReplicationTablesResult reloadReplicationTables(ReloadReplicationTablesRequest reloadReplicationTablesRequest)

        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.

        Parameters:
        reloadReplicationTablesRequest -
        Returns:
        Result of the ReloadReplicationTables operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • reloadTables

        ReloadTablesResult reloadTables(ReloadTablesRequest reloadTablesRequest)

        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.

        Parameters:
        reloadTablesRequest -
        Returns:
        Result of the ReloadTables operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • removeTagsFromResource

        RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

        Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.

        Parameters:
        removeTagsFromResourceRequest - Removes one or more tags from an DMS resource.
        Returns:
        Result of the RemoveTagsFromResource operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • Remove tags from resource
          Removes metadata tags from an AWS DMS resource.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
RemoveTagsFromResourceRequest request = new RemoveTagsFromResourceRequest().withResourceArn(
 "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E").withTagKeys(new ArrayList());
RemoveTagsFromResourceResult response = client.removeTagsFromResource(request);

      • startReplication

        StartReplicationResult startReplication(StartReplicationRequest startReplicationRequest)

        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.

        Parameters:
        startReplicationRequest -
        Returns:
        Result of the StartReplication operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        See Also:
        AWS API Documentation

      • startReplicationTask

        StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest startReplicationTaskRequest)

        Starts the replication task.

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

        Parameters:
        startReplicationTaskRequest -
        Returns:
        Result of the StartReplicationTask operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        See Also:
        AWS API Documentation

        Samples:
        • Start replication task
          Starts the replication task.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
StartReplicationTaskRequest request = new StartReplicationTaskRequest()
 .withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withStartReplicationTaskType("start-replication")
 .withCdcStartTime(new Date("2016-12-14T13:33:20Z"));
StartReplicationTaskResult response = client.startReplicationTask(request);

      • startReplicationTaskAssessment

        StartReplicationTaskAssessmentResult startReplicationTaskAssessment(StartReplicationTaskAssessmentRequest startReplicationTaskAssessmentRequest)

        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.

        Parameters:
        startReplicationTaskAssessmentRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

      • startReplicationTaskAssessmentRun

        StartReplicationTaskAssessmentRunResult startReplicationTaskAssessmentRun(StartReplicationTaskAssessmentRunRequest startReplicationTaskAssessmentRunRequest)

        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.

        Parameters:
        startReplicationTaskAssessmentRunRequest -
        Returns:
        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.
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        KMSAccessDeniedException - The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.
        KMSDisabledException - The specified KMS key isn't enabled.
        KMSException - An Key Management Service (KMS) error is preventing access to KMS.
        KMSInvalidStateException - The state of the specified KMS resource isn't valid for this request.
        KMSNotFoundException - The specified KMS entity or resource can't be found.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        S3AccessDeniedException - Insufficient privileges are preventing access to an Amazon S3 object.
        S3ResourceNotFoundException - A specified Amazon S3 bucket, bucket folder, or other object can't be found.
        ResourceAlreadyExistsException - The resource you are attempting to create already exists.
        See Also:
        AWS API Documentation

      • stopReplication

        StopReplicationResult stopReplication(StopReplicationRequest stopReplicationRequest)

        For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.

        Parameters:
        stopReplicationRequest -
        Returns:
        Result of the StopReplication operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        See Also:
        AWS API Documentation

      • stopReplicationTask

        StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest stopReplicationTaskRequest)

        Stops the replication task.

        Parameters:
        stopReplicationTaskRequest -
        Returns:
        Result of the StopReplicationTask operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

        Samples:
        • Stop replication task
          Stops the replication task.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
StopReplicationTaskRequest request = new StopReplicationTaskRequest()
 .withReplicationTaskArn("arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E");
StopReplicationTaskResult response = client.stopReplicationTask(request);

      • testConnection

        TestConnectionResult testConnection(TestConnectionRequest testConnectionRequest)

        Tests the connection between the replication instance and the endpoint.

        Parameters:
        testConnectionRequest -
        Returns:
        Result of the TestConnection operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource could not be found.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        KMSKeyNotAccessibleException - DMS cannot access the KMS key.
        ResourceQuotaExceededException - The quota for this resource quota has been exceeded.
        AccessDeniedException - DMS was denied access to the endpoint. Check that the role is correctly configured.
        See Also:
        AWS API Documentation

        Samples:
        • Test conection
          Tests the connection between the replication instance and the endpoint.
          AWSDatabaseMigrationService client = AWSDatabaseMigrationServiceClientBuilder.standard().build();
TestConnectionRequest request = new TestConnectionRequest().withReplicationInstanceArn(
 "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ").withEndpointArn(
 "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM");
TestConnectionResult response = client.testConnection(request);

      • updateSubscriptionsToEventBridge

        UpdateSubscriptionsToEventBridgeResult updateSubscriptionsToEventBridge(UpdateSubscriptionsToEventBridgeRequest updateSubscriptionsToEventBridgeRequest)

        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.

        Parameters:
        updateSubscriptionsToEventBridgeRequest -
        Returns:
        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.
        InvalidResourceStateException - The resource is in a state that prevents it from being used for database migration.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        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.

      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        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.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /