import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DatabaseMigrationServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DatabaseMigrationServiceClient"; import type { StartReplicationTaskMessage, StartReplicationTaskResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartReplicationTaskCommand}. */ export interface StartReplicationTaskCommandInput extends StartReplicationTaskMessage { } /** * @public * * The output of {@link StartReplicationTaskCommand}. */ export interface StartReplicationTaskCommandOutput extends StartReplicationTaskResponse, __MetadataBearer { } declare const StartReplicationTaskCommand_base: { new (input: StartReplicationTaskCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartReplicationTaskCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Starts the replication task.

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DatabaseMigrationServiceClient, StartReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import * // const { DatabaseMigrationServiceClient, StartReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import * // import type { DatabaseMigrationServiceClientConfig } from "@aws-sdk/client-database-migration-service"; * const config = {}; // type is DatabaseMigrationServiceClientConfig * const client = new DatabaseMigrationServiceClient(config); * const input = { // StartReplicationTaskMessage * ReplicationTaskArn: "STRING_VALUE", // required * StartReplicationTaskType: "start-replication" || "resume-processing" || "reload-target", // required * CdcStartTime: new Date("TIMESTAMP"), * CdcStartPosition: "STRING_VALUE", * CdcStopPosition: "STRING_VALUE", * }; * const command = new StartReplicationTaskCommand(input); * const response = await client.send(command); * // { // StartReplicationTaskResponse * // ReplicationTask: { // ReplicationTask * // ReplicationTaskIdentifier: "STRING_VALUE", * // SourceEndpointArn: "STRING_VALUE", * // TargetEndpointArn: "STRING_VALUE", * // ReplicationInstanceArn: "STRING_VALUE", * // MigrationType: "full-load" || "cdc" || "full-load-and-cdc", * // TableMappings: "STRING_VALUE", * // ReplicationTaskSettings: "STRING_VALUE", * // Status: "STRING_VALUE", * // LastFailureMessage: "STRING_VALUE", * // StopReason: "STRING_VALUE", * // ReplicationTaskCreationDate: new Date("TIMESTAMP"), * // ReplicationTaskStartDate: new Date("TIMESTAMP"), * // CdcStartPosition: "STRING_VALUE", * // CdcStopPosition: "STRING_VALUE", * // RecoveryCheckpoint: "STRING_VALUE", * // ReplicationTaskArn: "STRING_VALUE", * // ReplicationTaskStats: { // ReplicationTaskStats * // FullLoadProgressPercent: Number("int"), * // ElapsedTimeMillis: Number("long"), * // TablesLoaded: Number("int"), * // TablesLoading: Number("int"), * // TablesQueued: Number("int"), * // TablesErrored: Number("int"), * // FreshStartDate: new Date("TIMESTAMP"), * // StartDate: new Date("TIMESTAMP"), * // StopDate: new Date("TIMESTAMP"), * // FullLoadStartDate: new Date("TIMESTAMP"), * // FullLoadFinishDate: new Date("TIMESTAMP"), * // }, * // TaskData: "STRING_VALUE", * // TargetReplicationInstanceArn: "STRING_VALUE", * // }, * // }; * * ``` * * @param StartReplicationTaskCommandInput - {@link StartReplicationTaskCommandInput} * @returns {@link StartReplicationTaskCommandOutput} * @see {@link StartReplicationTaskCommandInput} for command's `input` shape. * @see {@link StartReplicationTaskCommandOutput} for command's `response` shape. * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. * * @throws {@link AccessDeniedFault} (client fault) *

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

* * @throws {@link InvalidResourceStateFault} (client fault) *

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

* * @throws {@link ResourceNotFoundFault} (client fault) *

The resource could not be found.

* * @throws {@link DatabaseMigrationServiceServiceException} *

Base exception class for all service exceptions from DatabaseMigrationService service.

* * * @example Start replication task * ```javascript * // Starts the replication task. * const input = { * CdcStartTime: "2016-12-14T13:33:20Z", * ReplicationTaskArn: "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", * StartReplicationTaskType: "start-replication" * }; * const command = new StartReplicationTaskCommand(input); * const response = await client.send(command); * /* response is * { * ReplicationTask: { * MigrationType: "full-load", * ReplicationInstanceArn: "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", * ReplicationTaskArn: "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", * ReplicationTaskCreationDate: "2016-12-14T18:25:43Z", * ReplicationTaskIdentifier: "task1", * ReplicationTaskSettings: `{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}`, * SourceEndpointArn: "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", * Status: "creating", * TableMappings: "file://mappingfile.json", * TargetEndpointArn: "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" * } * } * *\/ * ``` * * @public */ export declare class StartReplicationTaskCommand extends StartReplicationTaskCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartReplicationTaskMessage; output: StartReplicationTaskResponse; }; sdk: { input: StartReplicationTaskCommandInput; output: StartReplicationTaskCommandOutput; }; }; }