DatabaseMigrationServiceClient Class

Member Function Documentation

DatabaseMigrationServiceClient::DatabaseMigrationServiceClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a DatabaseMigrationServiceClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

DatabaseMigrationServiceClient::DatabaseMigrationServiceClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads DatabaseMigrationServiceClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddTagsToResourceResponse *DatabaseMigrationServiceClient::addTagsToResource(const AddTagsToResourceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an AddTagsToResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 DMS resources, or used in a Condition statement in an IAM policy for

[slot] CreateEndpointResponse *DatabaseMigrationServiceClient::createEndpoint(const CreateEndpointRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an CreateEndpointResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an endpoint using the provided

[slot] CreateEventSubscriptionResponse *DatabaseMigrationServiceClient::createEventSubscription(const CreateEventSubscriptionRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an CreateEventSubscriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an AWS DMS event notification subscription.

</p

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

account>

For more information about AWS DMS events, see <a href="http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html"> Working with Events and Notifications </a> in the AWS Database MIgration Service User

[slot] CreateReplicationInstanceResponse *DatabaseMigrationServiceClient::createReplicationInstance(const CreateReplicationInstanceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an CreateReplicationInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates the replication instance using the specified

[slot] CreateReplicationSubnetGroupResponse *DatabaseMigrationServiceClient::createReplicationSubnetGroup(const CreateReplicationSubnetGroupRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an CreateReplicationSubnetGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a replication subnet group given a list of the subnet IDs in a

[slot] CreateReplicationTaskResponse *DatabaseMigrationServiceClient::createReplicationTask(const CreateReplicationTaskRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an CreateReplicationTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a replication task using the specified

[slot] DeleteCertificateResponse *DatabaseMigrationServiceClient::deleteCertificate(const DeleteCertificateRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DeleteCertificateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified certificate.

[slot] DeleteEndpointResponse *DatabaseMigrationServiceClient::deleteEndpoint(const DeleteEndpointRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DeleteEndpointResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified

endpoint> <note>

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

[slot] DeleteEventSubscriptionResponse *DatabaseMigrationServiceClient::deleteEventSubscription(const DeleteEventSubscriptionRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DeleteEventSubscriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an AWS DMS event subscription.

[slot] DeleteReplicationInstanceResponse *DatabaseMigrationServiceClient::deleteReplicationInstance(const DeleteReplicationInstanceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DeleteReplicationInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified replication

instance> <note>

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

[slot] DeleteReplicationSubnetGroupResponse *DatabaseMigrationServiceClient::deleteReplicationSubnetGroup(const DeleteReplicationSubnetGroupRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DeleteReplicationSubnetGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a subnet

[slot] DeleteReplicationTaskResponse *DatabaseMigrationServiceClient::deleteReplicationTask(const DeleteReplicationTaskRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DeleteReplicationTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified replication

[slot] DescribeAccountAttributesResponse *DatabaseMigrationServiceClient::describeAccountAttributes(const DescribeAccountAttributesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeAccountAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 command does not take any

[slot] DescribeCertificatesResponse *DatabaseMigrationServiceClient::describeCertificates(const DescribeCertificatesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeCertificatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides a description of the

[slot] DescribeConnectionsResponse *DatabaseMigrationServiceClient::describeConnections(const DescribeConnectionsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeConnectionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an

[slot] DescribeEndpointTypesResponse *DatabaseMigrationServiceClient::describeEndpointTypes(const DescribeEndpointTypesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeEndpointTypesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the type of endpoints

[slot] DescribeEndpointsResponse *DatabaseMigrationServiceClient::describeEndpoints(const DescribeEndpointsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeEndpointsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the endpoints for your account in the current

[slot] DescribeEventCategoriesResponse *DatabaseMigrationServiceClient::describeEventCategories(const DescribeEventCategoriesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeEventCategoriesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html"> Working with Events and Notifications </a> in the AWS Database Migration Service User Guide.

[slot] DescribeEventSubscriptionsResponse *DatabaseMigrationServiceClient::describeEventSubscriptions(const DescribeEventSubscriptionsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeEventSubscriptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all the event subscriptions for a customer account. The description of a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>.

</p

If you specify <code>SubscriptionName</code>, this action lists the description for that

[slot] DescribeEventsResponse *DatabaseMigrationServiceClient::describeEvents(const DescribeEventsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see <a href="http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html"> Working with Events and Notifications </a>.

[slot] DescribeOrderableReplicationInstancesResponse *DatabaseMigrationServiceClient::describeOrderableReplicationInstances(const DescribeOrderableReplicationInstancesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeOrderableReplicationInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeRefreshSchemasStatusResponse *DatabaseMigrationServiceClient::describeRefreshSchemasStatus(const DescribeRefreshSchemasStatusRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeRefreshSchemasStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the status of the RefreshSchemas

[slot] DescribeReplicationInstanceTaskLogsResponse *DatabaseMigrationServiceClient::describeReplicationInstanceTaskLogs(const DescribeReplicationInstanceTaskLogsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeReplicationInstanceTaskLogsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the task logs for the specified

[slot] DescribeReplicationInstancesResponse *DatabaseMigrationServiceClient::describeReplicationInstances(const DescribeReplicationInstancesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeReplicationInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about replication instances for your account in the current

[slot] DescribeReplicationSubnetGroupsResponse *DatabaseMigrationServiceClient::describeReplicationSubnetGroups(const DescribeReplicationSubnetGroupsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeReplicationSubnetGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the replication subnet

[slot] DescribeReplicationTaskAssessmentResultsResponse *DatabaseMigrationServiceClient::describeReplicationTaskAssessmentResults(const DescribeReplicationTaskAssessmentResultsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeReplicationTaskAssessmentResultsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the task assessment results from Amazon S3. This action always returns the latest

[slot] DescribeReplicationTasksResponse *DatabaseMigrationServiceClient::describeReplicationTasks(const DescribeReplicationTasksRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeReplicationTasksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about replication tasks for your account in the current

[slot] DescribeSchemasResponse *DatabaseMigrationServiceClient::describeSchemas(const DescribeSchemasRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeSchemasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the schema for the specified

[slot] DescribeTableStatisticsResponse *DatabaseMigrationServiceClient::describeTableStatistics(const DescribeTableStatisticsRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an DescribeTableStatisticsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the

[slot] ImportCertificateResponse *DatabaseMigrationServiceClient::importCertificate(const ImportCertificateRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ImportCertificateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Uploads the specified

[slot] ListTagsForResourceResponse *DatabaseMigrationServiceClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all tags for an AWS DMS

[slot] ModifyEndpointResponse *DatabaseMigrationServiceClient::modifyEndpoint(const ModifyEndpointRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ModifyEndpointResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies the specified

[slot] ModifyEventSubscriptionResponse *DatabaseMigrationServiceClient::modifyEventSubscription(const ModifyEventSubscriptionRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ModifyEventSubscriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies an existing AWS DMS event notification subscription.

[slot] ModifyReplicationInstanceResponse *DatabaseMigrationServiceClient::modifyReplicationInstance(const ModifyReplicationInstanceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ModifyReplicationInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ModifyReplicationSubnetGroupResponse *DatabaseMigrationServiceClient::modifyReplicationSubnetGroup(const ModifyReplicationSubnetGroupRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ModifyReplicationSubnetGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies the settings for the specified replication subnet

[slot] ModifyReplicationTaskResponse *DatabaseMigrationServiceClient::modifyReplicationTask(const ModifyReplicationTaskRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ModifyReplicationTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies the specified replication

task>

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

</p

For more information about AWS DMS tasks, see the AWS DMS user guide at <a href="http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html"> Working with Migration Tasks </a>

[slot] RebootReplicationInstanceResponse *DatabaseMigrationServiceClient::rebootReplicationInstance(const RebootReplicationInstanceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an RebootReplicationInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available

[slot] RefreshSchemasResponse *DatabaseMigrationServiceClient::refreshSchemas(const RefreshSchemasRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an RefreshSchemasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ReloadTablesResponse *DatabaseMigrationServiceClient::reloadTables(const ReloadTablesRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an ReloadTablesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Reloads the target database table with the source data.

[slot] RemoveTagsFromResourceResponse *DatabaseMigrationServiceClient::removeTagsFromResource(const RemoveTagsFromResourceRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an RemoveTagsFromResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes metadata tags from a DMS

[slot] StartReplicationTaskResponse *DatabaseMigrationServiceClient::startReplicationTask(const StartReplicationTaskRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an StartReplicationTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the replication

task>

For more information about AWS DMS tasks, see the AWS DMS user guide at <a href="http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html"> Working with Migration Tasks </a>

[slot] StartReplicationTaskAssessmentResponse *DatabaseMigrationServiceClient::startReplicationTaskAssessment(const StartReplicationTaskAssessmentRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an StartReplicationTaskAssessmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the replication task assessment for unsupported data types in the source database.

[slot] StopReplicationTaskResponse *DatabaseMigrationServiceClient::stopReplicationTask(const StopReplicationTaskRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an StopReplicationTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the replication

[slot] TestConnectionResponse *DatabaseMigrationServiceClient::testConnection(const TestConnectionRequest &request)

Sends request to the DatabaseMigrationServiceClient service, and returns a pointer to an TestConnectionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Tests the connection between the replication instance and the