Creates a configuration that you can later provide to configure and start an DMS Serverless + * replication. You can also provide options to validate the configuration inputs before you start the + * replication.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CreateReplicationConfigCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CreateReplicationConfigCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // CreateReplicationConfigMessage + * ReplicationConfigIdentifier: "STRING_VALUE", // required + * SourceEndpointArn: "STRING_VALUE", // required + * TargetEndpointArn: "STRING_VALUE", // required + * ComputeConfig: { // ComputeConfig + * AvailabilityZone: "STRING_VALUE", + * DnsNameServers: "STRING_VALUE", + * KmsKeyId: "STRING_VALUE", + * MaxCapacityUnits: Number("int"), + * MinCapacityUnits: Number("int"), + * MultiAZ: true || false, + * PreferredMaintenanceWindow: "STRING_VALUE", + * ReplicationSubnetGroupId: "STRING_VALUE", + * VpcSecurityGroupIds: [ // StringList + * "STRING_VALUE", + * ], + * }, + * ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", // required + * TableMappings: "STRING_VALUE", // required + * ReplicationSettings: "STRING_VALUE", + * SupplementalSettings: "STRING_VALUE", + * ResourceIdentifier: "STRING_VALUE", + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", + * Value: "STRING_VALUE", + * ResourceArn: "STRING_VALUE", + * }, + * ], + * }; + * const command = new CreateReplicationConfigCommand(input); + * const response = await client.send(command); + * // { // CreateReplicationConfigResponse + * // ReplicationConfig: { // ReplicationConfig + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // ComputeConfig: { // ComputeConfig + * // AvailabilityZone: "STRING_VALUE", + * // DnsNameServers: "STRING_VALUE", + * // KmsKeyId: "STRING_VALUE", + * // MaxCapacityUnits: Number("int"), + * // MinCapacityUnits: Number("int"), + * // MultiAZ: true || false, + * // PreferredMaintenanceWindow: "STRING_VALUE", + * // ReplicationSubnetGroupId: "STRING_VALUE", + * // VpcSecurityGroupIds: [ // StringList + * // "STRING_VALUE", + * // ], + * // }, + * // ReplicationSettings: "STRING_VALUE", + * // SupplementalSettings: "STRING_VALUE", + * // TableMappings: "STRING_VALUE", + * // ReplicationConfigCreateTime: new Date("TIMESTAMP"), + * // ReplicationConfigUpdateTime: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param CreateReplicationConfigCommandInput - {@link CreateReplicationConfigCommandInput} + * @returns {@link CreateReplicationConfigCommandOutput} + * @see {@link CreateReplicationConfigCommandInput} for command's `input` shape. + * @see {@link CreateReplicationConfigCommandOutput} 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 InvalidSubnet} (client fault) + *The subnet provided isn't valid.
+ * + * @throws {@link KMSKeyNotAccessibleFault} (client fault) + *DMS cannot access the KMS key.
+ * + * @throws {@link ReplicationSubnetGroupDoesNotCoverEnoughAZs} (client fault) + *The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
+ * + * @throws {@link ResourceAlreadyExistsFault} (client fault) + *The resource you are attempting to create already exists.
+ * + * @throws {@link ResourceNotFoundFault} (client fault) + *The resource could not be found.
+ * + * @throws {@link ResourceQuotaExceededFault} (client fault) + *The quota for this resource quota has been exceeded.
+ * + * @throws {@link DatabaseMigrationServiceServiceException} + *Base exception class for all service exceptions from DatabaseMigrationService service.
+ * + */ +export class CreateReplicationConfigCommand extends $Command< + CreateReplicationConfigCommandInput, + CreateReplicationConfigCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateReplicationConfigCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe resource is in a state that prevents it from being used for database migration.
* * @throws {@link InvalidSubnet} (client fault) - *The subnet provided is invalid.
+ *The subnet provided isn't valid.
* * @throws {@link KMSKeyNotAccessibleFault} (client fault) *DMS cannot access the KMS key.
diff --git a/clients/client-database-migration-service/src/commands/CreateReplicationSubnetGroupCommand.ts b/clients/client-database-migration-service/src/commands/CreateReplicationSubnetGroupCommand.ts index b31ee63bdf48..abca9e86e0d3 100644 --- a/clients/client-database-migration-service/src/commands/CreateReplicationSubnetGroupCommand.ts +++ b/clients/client-database-migration-service/src/commands/CreateReplicationSubnetGroupCommand.ts @@ -48,6 +48,10 @@ export interface CreateReplicationSubnetGroupCommandOutput *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -104,7 +108,7 @@ export interface CreateReplicationSubnetGroupCommandOutput * role is correctly configured. * * @throws {@link InvalidSubnet} (client fault) - *The subnet provided is invalid.
+ *The subnet provided isn't valid.
* * @throws {@link ReplicationSubnetGroupDoesNotCoverEnoughAZs} (client fault) *The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
diff --git a/clients/client-database-migration-service/src/commands/DeleteEndpointCommand.ts b/clients/client-database-migration-service/src/commands/DeleteEndpointCommand.ts index 0eebf75e220b..d8c429d33f2b 100644 --- a/clients/client-database-migration-service/src/commands/DeleteEndpointCommand.ts +++ b/clients/client-database-migration-service/src/commands/DeleteEndpointCommand.ts @@ -145,6 +145,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * // KmsKeyId: "STRING_VALUE", * // SecretsManagerAccessRoleArn: "STRING_VALUE", * // SecretsManagerSecretId: "STRING_VALUE", + * // UseUpdateLookUp: true || false, + * // ReplicateShardCollections: true || false, * // }, * // KinesisSettings: { // KinesisSettings * // StreamArn: "STRING_VALUE", @@ -178,6 +180,7 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * // SaslPassword: "STRING_VALUE", * // NoHexPrefix: true || false, * // SaslMechanism: "scram-sha-512" || "plain", + * // SslEndpointIdentificationAlgorithm: "none" || "https", * // }, * // ElasticsearchSettings: { // ElasticsearchSettings * // ServiceAccessRoleArn: "STRING_VALUE", // required @@ -249,6 +252,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * // SecretsManagerSecretId: "STRING_VALUE", * // TrimSpaceInChar: true || false, * // MapBooleanAsBoolean: true || false, + * // MapJsonbAsClob: true || false, + * // MapLongVarcharAs: "wstring" || "clob" || "nclob", * // }, * // MySQLSettings: { // MySQLSettings * // AfterConnectScript: "STRING_VALUE", @@ -311,6 +316,7 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * // SecretsManagerOracleAsmSecretId: "STRING_VALUE", * // TrimSpaceInChar: true || false, * // ConvertTimestampWithZoneToUTC: true || false, + * // OpenTransactionWindow: Number("int"), * // }, * // SybaseSettings: { // SybaseSettings * // DatabaseName: "STRING_VALUE", @@ -364,6 +370,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * // KmsKeyId: "STRING_VALUE", * // SecretsManagerAccessRoleArn: "STRING_VALUE", * // SecretsManagerSecretId: "STRING_VALUE", + * // UseUpdateLookUp: true || false, + * // ReplicateShardCollections: true || false, * // }, * // RedisSettings: { // RedisSettings * // ServerName: "STRING_VALUE", // required @@ -390,6 +398,13 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * // SecretsManagerAccessRoleArn: "STRING_VALUE", * // SecretsManagerSecretId: "STRING_VALUE", * // }, + * // TimestreamSettings: { // TimestreamSettings + * // DatabaseName: "STRING_VALUE", // required + * // MemoryDuration: Number("int"), // required + * // MagneticDuration: Number("int"), // required + * // CdcInsertsAndUpdates: true || false, + * // EnableMagneticStoreWrites: true || false, + * // }, * // }, * // }; * diff --git a/clients/client-database-migration-service/src/commands/DeleteReplicationConfigCommand.ts b/clients/client-database-migration-service/src/commands/DeleteReplicationConfigCommand.ts new file mode 100644 index 000000000000..8869d4206981 --- /dev/null +++ b/clients/client-database-migration-service/src/commands/DeleteReplicationConfigCommand.ts @@ -0,0 +1,182 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { + DatabaseMigrationServiceClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DatabaseMigrationServiceClient"; +import { DeleteReplicationConfigMessage, DeleteReplicationConfigResponse } from "../models/models_0"; +import { de_DeleteReplicationConfigCommand, se_DeleteReplicationConfigCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DeleteReplicationConfigCommand}. + */ +export interface DeleteReplicationConfigCommandInput extends DeleteReplicationConfigMessage {} +/** + * @public + * + * The output of {@link DeleteReplicationConfigCommand}. + */ +export interface DeleteReplicationConfigCommandOutput extends DeleteReplicationConfigResponse, __MetadataBearer {} + +/** + * @public + *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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteReplicationConfigCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteReplicationConfigCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // DeleteReplicationConfigMessage + * ReplicationConfigArn: "STRING_VALUE", // required + * }; + * const command = new DeleteReplicationConfigCommand(input); + * const response = await client.send(command); + * // { // DeleteReplicationConfigResponse + * // ReplicationConfig: { // ReplicationConfig + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // ComputeConfig: { // ComputeConfig + * // AvailabilityZone: "STRING_VALUE", + * // DnsNameServers: "STRING_VALUE", + * // KmsKeyId: "STRING_VALUE", + * // MaxCapacityUnits: Number("int"), + * // MinCapacityUnits: Number("int"), + * // MultiAZ: true || false, + * // PreferredMaintenanceWindow: "STRING_VALUE", + * // ReplicationSubnetGroupId: "STRING_VALUE", + * // VpcSecurityGroupIds: [ // StringList + * // "STRING_VALUE", + * // ], + * // }, + * // ReplicationSettings: "STRING_VALUE", + * // SupplementalSettings: "STRING_VALUE", + * // TableMappings: "STRING_VALUE", + * // ReplicationConfigCreateTime: new Date("TIMESTAMP"), + * // ReplicationConfigUpdateTime: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param DeleteReplicationConfigCommandInput - {@link DeleteReplicationConfigCommandInput} + * @returns {@link DeleteReplicationConfigCommandOutput} + * @see {@link DeleteReplicationConfigCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationConfigCommandOutput} 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.
+ * + */ +export class DeleteReplicationConfigCommand extends $Command< + DeleteReplicationConfigCommandInput, + DeleteReplicationConfigCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteReplicationConfigCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns one or more existing DMS Serverless replication configurations as a list of structures.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationConfigsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationConfigsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // DescribeReplicationConfigsMessage + * Filters: [ // FilterList + * { // Filter + * Name: "STRING_VALUE", // required + * Values: [ // FilterValueList // required + * "STRING_VALUE", + * ], + * }, + * ], + * MaxRecords: Number("int"), + * Marker: "STRING_VALUE", + * }; + * const command = new DescribeReplicationConfigsCommand(input); + * const response = await client.send(command); + * // { // DescribeReplicationConfigsResponse + * // Marker: "STRING_VALUE", + * // ReplicationConfigs: [ // ReplicationConfigList + * // { // ReplicationConfig + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // ComputeConfig: { // ComputeConfig + * // AvailabilityZone: "STRING_VALUE", + * // DnsNameServers: "STRING_VALUE", + * // KmsKeyId: "STRING_VALUE", + * // MaxCapacityUnits: Number("int"), + * // MinCapacityUnits: Number("int"), + * // MultiAZ: true || false, + * // PreferredMaintenanceWindow: "STRING_VALUE", + * // ReplicationSubnetGroupId: "STRING_VALUE", + * // VpcSecurityGroupIds: [ // StringList + * // "STRING_VALUE", + * // ], + * // }, + * // ReplicationSettings: "STRING_VALUE", + * // SupplementalSettings: "STRING_VALUE", + * // TableMappings: "STRING_VALUE", + * // ReplicationConfigCreateTime: new Date("TIMESTAMP"), + * // ReplicationConfigUpdateTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeReplicationConfigsCommandInput - {@link DescribeReplicationConfigsCommandInput} + * @returns {@link DescribeReplicationConfigsCommandOutput} + * @see {@link DescribeReplicationConfigsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationConfigsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. + * + * @throws {@link ResourceNotFoundFault} (client fault) + *The resource could not be found.
+ * + * @throws {@link DatabaseMigrationServiceServiceException} + *Base exception class for all service exceptions from DatabaseMigrationService service.
+ * + */ +export class DescribeReplicationConfigsCommand extends $Command< + DescribeReplicationConfigsCommandInput, + DescribeReplicationConfigsCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeReplicationConfigsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns table and schema statistics for one or more provisioned replications that use a + * given DMS Serverless replication configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationTableStatisticsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationTableStatisticsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // DescribeReplicationTableStatisticsMessage + * ReplicationConfigArn: "STRING_VALUE", // required + * MaxRecords: Number("int"), + * Marker: "STRING_VALUE", + * Filters: [ // FilterList + * { // Filter + * Name: "STRING_VALUE", // required + * Values: [ // FilterValueList // required + * "STRING_VALUE", + * ], + * }, + * ], + * }; + * const command = new DescribeReplicationTableStatisticsCommand(input); + * const response = await client.send(command); + * // { // DescribeReplicationTableStatisticsResponse + * // ReplicationConfigArn: "STRING_VALUE", + * // Marker: "STRING_VALUE", + * // ReplicationTableStatistics: [ // ReplicationTableStatisticsList + * // { // TableStatistics + * // SchemaName: "STRING_VALUE", + * // TableName: "STRING_VALUE", + * // Inserts: Number("long"), + * // Deletes: Number("long"), + * // Updates: Number("long"), + * // Ddls: Number("long"), + * // AppliedInserts: Number("long"), + * // AppliedDeletes: Number("long"), + * // AppliedUpdates: Number("long"), + * // AppliedDdls: Number("long"), + * // FullLoadRows: Number("long"), + * // FullLoadCondtnlChkFailedRows: Number("long"), + * // FullLoadErrorRows: Number("long"), + * // FullLoadStartTime: new Date("TIMESTAMP"), + * // FullLoadEndTime: new Date("TIMESTAMP"), + * // FullLoadReloaded: true || false, + * // LastUpdateTime: new Date("TIMESTAMP"), + * // TableState: "STRING_VALUE", + * // ValidationPendingRecords: Number("long"), + * // ValidationFailedRecords: Number("long"), + * // ValidationSuspendedRecords: Number("long"), + * // ValidationState: "STRING_VALUE", + * // ValidationStateDetails: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeReplicationTableStatisticsCommandInput - {@link DescribeReplicationTableStatisticsCommandInput} + * @returns {@link DescribeReplicationTableStatisticsCommandOutput} + * @see {@link DescribeReplicationTableStatisticsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationTableStatisticsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. + * + * @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.
+ * + */ +export class DescribeReplicationTableStatisticsCommand extends $Command< + DescribeReplicationTableStatisticsCommandInput, + DescribeReplicationTableStatisticsCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeReplicationTableStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackProvides details on replication progress by returning status information for one or more + * provisioned DMS Serverless replications.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // DescribeReplicationsMessage + * Filters: [ // FilterList + * { // Filter + * Name: "STRING_VALUE", // required + * Values: [ // FilterValueList // required + * "STRING_VALUE", + * ], + * }, + * ], + * MaxRecords: Number("int"), + * Marker: "STRING_VALUE", + * }; + * const command = new DescribeReplicationsCommand(input); + * const response = await client.send(command); + * // { // DescribeReplicationsResponse + * // Marker: "STRING_VALUE", + * // Replications: [ // ReplicationList + * // { // Replication + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // Status: "STRING_VALUE", + * // ProvisionData: { // ProvisionData + * // ProvisionState: "STRING_VALUE", + * // ProvisionedCapacityUnits: Number("int"), + * // DateProvisioned: new Date("TIMESTAMP"), + * // IsNewProvisioningAvailable: true || false, + * // DateNewProvisioningDataAvailable: new Date("TIMESTAMP"), + * // ReasonForNewProvisioningData: "STRING_VALUE", + * // }, + * // StopReason: "STRING_VALUE", + * // FailureMessages: [ // StringList + * // "STRING_VALUE", + * // ], + * // ReplicationStats: { // ReplicationStats + * // 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"), + * // }, + * // StartReplicationType: "STRING_VALUE", + * // CdcStartTime: new Date("TIMESTAMP"), + * // CdcStartPosition: "STRING_VALUE", + * // CdcStopPosition: "STRING_VALUE", + * // RecoveryCheckpoint: "STRING_VALUE", + * // ReplicationCreateTime: new Date("TIMESTAMP"), + * // ReplicationUpdateTime: new Date("TIMESTAMP"), + * // ReplicationLastStopTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeReplicationsCommandInput - {@link DescribeReplicationsCommandInput} + * @returns {@link DescribeReplicationsCommandOutput} + * @see {@link DescribeReplicationsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. + * + * @throws {@link ResourceNotFoundFault} (client fault) + *The resource could not be found.
+ * + * @throws {@link DatabaseMigrationServiceServiceException} + *Base exception class for all service exceptions from DatabaseMigrationService service.
+ * + */ +export class DescribeReplicationsCommand extends $Command< + DescribeReplicationsCommandInput, + DescribeReplicationsCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeReplicationsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackModifies 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ModifyReplicationConfigCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ModifyReplicationConfigCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // ModifyReplicationConfigMessage + * ReplicationConfigArn: "STRING_VALUE", // required + * ReplicationConfigIdentifier: "STRING_VALUE", + * ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * TableMappings: "STRING_VALUE", + * ReplicationSettings: "STRING_VALUE", + * SupplementalSettings: "STRING_VALUE", + * ComputeConfig: { // ComputeConfig + * AvailabilityZone: "STRING_VALUE", + * DnsNameServers: "STRING_VALUE", + * KmsKeyId: "STRING_VALUE", + * MaxCapacityUnits: Number("int"), + * MinCapacityUnits: Number("int"), + * MultiAZ: true || false, + * PreferredMaintenanceWindow: "STRING_VALUE", + * ReplicationSubnetGroupId: "STRING_VALUE", + * VpcSecurityGroupIds: [ // StringList + * "STRING_VALUE", + * ], + * }, + * SourceEndpointArn: "STRING_VALUE", + * TargetEndpointArn: "STRING_VALUE", + * }; + * const command = new ModifyReplicationConfigCommand(input); + * const response = await client.send(command); + * // { // ModifyReplicationConfigResponse + * // ReplicationConfig: { // ReplicationConfig + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // ComputeConfig: { // ComputeConfig + * // AvailabilityZone: "STRING_VALUE", + * // DnsNameServers: "STRING_VALUE", + * // KmsKeyId: "STRING_VALUE", + * // MaxCapacityUnits: Number("int"), + * // MinCapacityUnits: Number("int"), + * // MultiAZ: true || false, + * // PreferredMaintenanceWindow: "STRING_VALUE", + * // ReplicationSubnetGroupId: "STRING_VALUE", + * // VpcSecurityGroupIds: [ // StringList + * // "STRING_VALUE", + * // ], + * // }, + * // ReplicationSettings: "STRING_VALUE", + * // SupplementalSettings: "STRING_VALUE", + * // TableMappings: "STRING_VALUE", + * // ReplicationConfigCreateTime: new Date("TIMESTAMP"), + * // ReplicationConfigUpdateTime: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param ModifyReplicationConfigCommandInput - {@link ModifyReplicationConfigCommandInput} + * @returns {@link ModifyReplicationConfigCommandOutput} + * @see {@link ModifyReplicationConfigCommandInput} for command's `input` shape. + * @see {@link ModifyReplicationConfigCommandOutput} 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 InvalidSubnet} (client fault) + *The subnet provided isn't valid.
+ * + * @throws {@link KMSKeyNotAccessibleFault} (client fault) + *DMS cannot access the KMS key.
+ * + * @throws {@link ReplicationSubnetGroupDoesNotCoverEnoughAZs} (client fault) + *The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
+ * + * @throws {@link ResourceNotFoundFault} (client fault) + *The resource could not be found.
+ * + * @throws {@link DatabaseMigrationServiceServiceException} + *Base exception class for all service exceptions from DatabaseMigrationService service.
+ * + */ +export class ModifyReplicationConfigCommand extends $Command< + ModifyReplicationConfigCommandInput, + ModifyReplicationConfigCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ModifyReplicationConfigCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe subnet provided is invalid.
+ *The subnet provided isn't valid.
* * @throws {@link ReplicationSubnetGroupDoesNotCoverEnoughAZs} (client fault) *The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
diff --git a/clients/client-database-migration-service/src/commands/ReloadReplicationTablesCommand.ts b/clients/client-database-migration-service/src/commands/ReloadReplicationTablesCommand.ts new file mode 100644 index 000000000000..4565797ec7d3 --- /dev/null +++ b/clients/client-database-migration-service/src/commands/ReloadReplicationTablesCommand.ts @@ -0,0 +1,162 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { + DatabaseMigrationServiceClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DatabaseMigrationServiceClient"; +import { ReloadReplicationTablesMessage, ReloadReplicationTablesResponse } from "../models/models_0"; +import { de_ReloadReplicationTablesCommand, se_ReloadReplicationTablesCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ReloadReplicationTablesCommand}. + */ +export interface ReloadReplicationTablesCommandInput extends ReloadReplicationTablesMessage {} +/** + * @public + * + * The output of {@link ReloadReplicationTablesCommand}. + */ +export interface ReloadReplicationTablesCommandOutput extends ReloadReplicationTablesResponse, __MetadataBearer {} + +/** + * @public + *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.
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.
+ * + */ +export class ReloadReplicationTablesCommand extends $Command< + ReloadReplicationTablesCommandInput, + ReloadReplicationTablesCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ReloadReplicationTablesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackFor 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, StartReplicationCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, StartReplicationCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // StartReplicationMessage + * ReplicationConfigArn: "STRING_VALUE", // required + * StartReplicationType: "STRING_VALUE", // required + * CdcStartTime: new Date("TIMESTAMP"), + * CdcStartPosition: "STRING_VALUE", + * CdcStopPosition: "STRING_VALUE", + * }; + * const command = new StartReplicationCommand(input); + * const response = await client.send(command); + * // { // StartReplicationResponse + * // Replication: { // Replication + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // Status: "STRING_VALUE", + * // ProvisionData: { // ProvisionData + * // ProvisionState: "STRING_VALUE", + * // ProvisionedCapacityUnits: Number("int"), + * // DateProvisioned: new Date("TIMESTAMP"), + * // IsNewProvisioningAvailable: true || false, + * // DateNewProvisioningDataAvailable: new Date("TIMESTAMP"), + * // ReasonForNewProvisioningData: "STRING_VALUE", + * // }, + * // StopReason: "STRING_VALUE", + * // FailureMessages: [ // StringList + * // "STRING_VALUE", + * // ], + * // ReplicationStats: { // ReplicationStats + * // 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"), + * // }, + * // StartReplicationType: "STRING_VALUE", + * // CdcStartTime: new Date("TIMESTAMP"), + * // CdcStartPosition: "STRING_VALUE", + * // CdcStopPosition: "STRING_VALUE", + * // RecoveryCheckpoint: "STRING_VALUE", + * // ReplicationCreateTime: new Date("TIMESTAMP"), + * // ReplicationUpdateTime: new Date("TIMESTAMP"), + * // ReplicationLastStopTime: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param StartReplicationCommandInput - {@link StartReplicationCommandInput} + * @returns {@link StartReplicationCommandOutput} + * @see {@link StartReplicationCommandInput} for command's `input` shape. + * @see {@link StartReplicationCommandOutput} 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.
+ * + */ +export class StartReplicationCommand extends $Command< + StartReplicationCommandInput, + StartReplicationCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartReplicationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackFor a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. + * This command doesn't deprovision the stopped replications.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, StopReplicationCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, StopReplicationCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const input = { // StopReplicationMessage + * ReplicationConfigArn: "STRING_VALUE", // required + * }; + * const command = new StopReplicationCommand(input); + * const response = await client.send(command); + * // { // StopReplicationResponse + * // Replication: { // Replication + * // ReplicationConfigIdentifier: "STRING_VALUE", + * // ReplicationConfigArn: "STRING_VALUE", + * // SourceEndpointArn: "STRING_VALUE", + * // TargetEndpointArn: "STRING_VALUE", + * // ReplicationType: "full-load" || "cdc" || "full-load-and-cdc", + * // Status: "STRING_VALUE", + * // ProvisionData: { // ProvisionData + * // ProvisionState: "STRING_VALUE", + * // ProvisionedCapacityUnits: Number("int"), + * // DateProvisioned: new Date("TIMESTAMP"), + * // IsNewProvisioningAvailable: true || false, + * // DateNewProvisioningDataAvailable: new Date("TIMESTAMP"), + * // ReasonForNewProvisioningData: "STRING_VALUE", + * // }, + * // StopReason: "STRING_VALUE", + * // FailureMessages: [ // StringList + * // "STRING_VALUE", + * // ], + * // ReplicationStats: { // ReplicationStats + * // 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"), + * // }, + * // StartReplicationType: "STRING_VALUE", + * // CdcStartTime: new Date("TIMESTAMP"), + * // CdcStartPosition: "STRING_VALUE", + * // CdcStopPosition: "STRING_VALUE", + * // RecoveryCheckpoint: "STRING_VALUE", + * // ReplicationCreateTime: new Date("TIMESTAMP"), + * // ReplicationUpdateTime: new Date("TIMESTAMP"), + * // ReplicationLastStopTime: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param StopReplicationCommandInput - {@link StopReplicationCommandInput} + * @returns {@link StopReplicationCommandOutput} + * @see {@link StopReplicationCommandInput} for command's `input` shape. + * @see {@link StopReplicationCommandOutput} 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.
+ * + */ +export class StopReplicationCommand extends $Command< + StopReplicationCommandInput, + StopReplicationCommandOutput, + DatabaseMigrationServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StopReplicationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackIf true, DMS retrieves the entire document from the DocumentDB source during migration.
+ * This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates
+ * and deletes during migration, set this parameter to false.
If true, DMS replicates data to shard collections. DMS only uses this setting if
+ * the target endpoint is a DocumentDB elastic cluster.
When this setting is true, note the following:
You must set TargetTablePrepMode to nothing.
DMS automatically sets useUpdateLookup to false.
Provides information that describes an Apache Kafka endpoint. This @@ -1090,6 +1127,12 @@ export interface KafkaSettings { *
*/ SaslMechanism?: KafkaSaslMechanism | string; + + /** + *Sets hostname verification + * for the certificate. This setting is supported in DMS version 3.5.1 and later.
+ */ + SslEndpointIdentificationAlgorithm?: KafkaSslEndpointIdentificationAlgorithm | string; } /** @@ -1482,6 +1525,28 @@ export interface MongoDbSettings { *The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
If true, DMS retrieves the entire document from the MongoDB source during migration.
+ * This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates
+ * and deletes during migration, set this parameter to false.
If true, DMS replicates data to shard collections. DMS only uses this setting if
+ * the target endpoint is a DocumentDB elastic cluster.
When this setting is true, note the following:
You must set TargetTablePrepMode to nothing.
DMS automatically sets useUpdateLookup to false.
When true, converts timestamps with the timezone datatype to their UTC value.
The timeframe in minutes to check for open transactions for a CDC-only task.
+ *You can + * specify an integer value between 0 (the default) and 240 (the maximum).
+ *This parameter is only valid in DMS version 3.5.0 and later. DMS supports
+ * a window of up to 9.5 hours including the value for OpenTransactionWindow.
CdcStartPosition setting, DMS raises an
* error.
* For more information about setting the CdcStartPosition request parameter,
- * see Determining a CDC native start point in the Database Migration Service User
+ * see Determining a CDC native start point in the Database Migration Service User
* Guide. For more information about using CdcStartPosition, see
* CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
varchar(5).
*/
MapBooleanAsBoolean?: boolean;
+
+ /**
+ * When true, DMS migrates JSONB values as CLOB.
+ */ + MapJsonbAsClob?: boolean; + + /** + *When true, DMS migrates LONG values as VARCHAR.
+ */ + MapLongVarcharAs?: LongVarcharMappingType | string; } /** @@ -2945,10 +3046,12 @@ export interface S3Settings { /** *A value that enables a full load to write INSERT operations to the comma-separated value - * (.csv) output files only to indicate how the rows were added to the source database.
+ * (.csv) or .parquet output files only to indicate how the rows were added to the source database. *DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and
* later.
DMS supports the use of the .parquet files with the IncludeOpForFullLoad
+ * parameter in versions 3.4.7 and later.
For full load, records can only be inserted. By default (the false
* setting), no information is recorded in these output files for a full load to indicate that
@@ -3050,8 +3153,11 @@ export interface S3Settings {
* operations to .csv or .parquet (columnar storage) output files. The default setting is
* false, but when CdcInsertsAndUpdates is set to
* true or y, only INSERTs and UPDATEs from the source database
- * are migrated to the .csv or .parquet file.
For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the + * are migrated to the .csv or .parquet file.
+ *DMS supports the use of the .parquet files in versions 3.4.7 and later.
+ *How these INSERTs and UPDATEs are recorded depends on the
* value of the IncludeOpForFullLoad parameter. If
* IncludeOpForFullLoad is set to true, the first field of every
* CDC record is set to either I or U to indicate INSERT and UPDATE
@@ -3367,6 +3473,50 @@ export interface SybaseSettings {
SecretsManagerSecretId?: string;
}
+/**
+ * @public
+ *
Provides information that defines an Amazon Timestream endpoint.
+ */ +export interface TimestreamSettings { + /** + *Database name for the endpoint.
+ */ + DatabaseName: string | undefined; + + /** + *Set this attribute to specify the length of time to store all of the tables in memory + * that are migrated into Amazon Timestream from the source database. Time is measured in units + * of hours. When Timestream data comes in, it first resides in memory for the specified duration, + * which allows quick access to it.
+ */ + MemoryDuration: number | undefined; + + /** + *Set this attribute to specify the default magnetic duration applied to the Amazon Timestream + * tables in days. This is the number of days that records remain in magnetic store + * before being discarded. For more information, see Storage in the + * Amazon Timestream Developer Guide.
+ */ + MagneticDuration: number | undefined; + + /** + *Set this attribute to true to specify that DMS only
+ * applies inserts and updates, and not deletes. Amazon Timestream does not allow
+ * deleting records, so if this value is false, DMS nulls out
+ * the corresponding record in the Timestream database rather than deleting it.
Set this attribute to true to enable memory store writes.
+ * When this value is false, DMS does not write records that are older
+ * in days than the value specified in MagneticDuration, because Amazon Timestream does not
+ * allow memory writes by default. For more information, see Storage in the
+ * Amazon Timestream Developer Guide.
Settings in JSON format for the source GCP MySQL endpoint.
*/ GcpMySQLSettings?: GcpMySQLSettings; + + /** + *Settings in JSON format for the target Amazon Timestream endpoint.
+ */ + TimestreamSettings?: TimestreamSettings; } /** @@ -3873,6 +4028,12 @@ export interface Endpoint { *Settings in JSON format for the source GCP MySQL endpoint.
*/ GcpMySQLSettings?: GcpMySQLSettings; + + /** + *The settings for the Amazon Timestream target endpoint. For more information, see the
+ * TimestreamSettings structure.
Configuration parameters for provisioning an DMS Serverless replication.
*/ -export interface CreateReplicationInstanceMessage { +export interface ComputeConfig { /** - *The replication instance identifier. This parameter is stored as a lowercase - * string.
- *Constraints:
- *Must contain 1-63 alphanumeric characters or hyphens.
- *First character must be a letter.
- *Can't end with a hyphen or contain two consecutive hyphens.
- *Example: myrepinstance
- *
The Availability Zone where the DMS Serverless replication using this configuration will run.
+ * The default value is a random, system-chosen Availability Zone in the configuration's Amazon Web Services Region,
+ * for example, "us-west-2". You can't set this parameter if the MultiAZ
+ * parameter is set to true.
The amount of storage (in gigabytes) to be initially allocated for the replication - * instance.
+ *A list of custom DNS name servers supported for the DMS Serverless replication
+ * to access your source or target database. This list overrides the default name servers
+ * supported by the DMS Serverless replication. You can specify a comma-separated list of
+ * internet addresses for up to four DNS name servers.
+ * For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
+ *
The compute and memory capacity of the replication instance as defined for the specified
- * replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see - * - * Selecting the right DMS replication instance for your migration. - *
+ *An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during + * DMS Serverless replication.
+ *If you don't specify a value for the KmsKeyId parameter, DMS uses your default
+ * encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a + * different default encryption key for each Amazon Web Services Region.
*/ - ReplicationInstanceClass: string | undefined; + KmsKeyId?: string; /** - *Specifies the VPC security group to be used with the replication instance. The VPC - * security group must work with the VPC containing the replication instance.
+ *Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless
+ * replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed.
+ * The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value
+ * that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only
+ * DCU parameter you are required to specify.
The Availability Zone where the replication instance will be created. The default
- * value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for
- * example: us-east-1d
- *
Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS
+ * Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value
+ * allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU
+ * value that you can specify for DMS Serverless is 2. You don't have to specify a value for the
+ * MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity
+ * of available source tables to identify an optimum setting for this parameter. If there is no current
+ * source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to
+ * the minimum DCU value allowed, 2.
A subnet group to associate with the replication instance.
+ *Specifies whether the DMS Serverless replication is a Multi-AZ deployment. You can't set the
+ * AvailabilityZone parameter if the MultiAZ parameter is set to
+ * true.
The weekly time range during which system maintenance can occur, in Universal - * Coordinated Time (UTC).
- * Format: ddd:hh24:mi-ddd:hh24:mi
- *
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, - * occurring on a random day of the week.
- *Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
- *Constraints: Minimum 30-minute window.
+ *The weekly time range during which system maintenance can occur for the DMS Serverless
+ * replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi.
The default is a 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region.
+ * This maintenance occurs on a random day of the week. Valid values for days of the week include
+ * Mon, Tue, Wed, Thu, Fri, Sat,
+ * and Sun.
Constraints include a minimum 30-minute window.
*/ PreferredMaintenanceWindow?: string; /** - * Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
- * AvailabilityZone parameter if the Multi-AZ parameter is set to
- * true.
Specifies a subnet group identifier to associate with the DMS Serverless replication.
*/ - MultiAZ?: boolean; + ReplicationSubnetGroupId?: string; /** - *The engine version number of the replication instance.
- *If an engine version number is not specified when a replication - * instance is created, the default is the latest engine version available.
+ *Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless + * replication. The VPC security group must work with the VPC containing the replication.
*/ - EngineVersion?: string; + VpcSecurityGroupIds?: string[]; +} + +/** + * @public + * @enum + */ +export const MigrationTypeValue = { + CDC: "cdc", + FULL_LOAD: "full-load", + FULL_LOAD_AND_CDC: "full-load-and-cdc", +} as const; + +/** + * @public + */ +export type MigrationTypeValue = (typeof MigrationTypeValue)[keyof typeof MigrationTypeValue]; +/** + * @public + * + */ +export interface CreateReplicationConfigMessage { /** - *A value that indicates whether minor engine upgrades are applied automatically to the
- * replication instance during the maintenance window. This parameter defaults to
- * true.
Default: true
- *
When AutoMinorVersionUpgrade is enabled, DMS uses the current default
- * engine version when you create a replication instance. For example, if you set
- * EngineVersion to a lower version number than the current default version,
- * DMS uses the default version.
If AutoMinorVersionUpgrade
- * isn’t enabled when you create a replication instance, DMS uses the
- * engine version specified by the EngineVersion parameter.
A unique identifier that you want to use to create a ReplicationConfigArn that is
+ * returned as part of the output from this action. You can then pass this output ReplicationConfigArn
+ * as the value of the ReplicationConfigArn option for other actions to identify both
+ * DMS Serverless replications and replication configurations that you want those actions to operate on.
+ * For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to
+ * identify the specific replication and replication configuration to operate on.
One or more tags to be assigned to the replication instance.
+ *The Amazon Resource Name (ARN) of the source endpoint for + * this DMS Serverless replication configuration.
*/ - Tags?: Tag[]; + SourceEndpointArn: string | undefined; /** - *An KMS key identifier that is used to encrypt the data on the replication - * instance.
- *If you don't specify a value for the KmsKeyId parameter, then
- * DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a - * different default encryption key for each Amazon Web Services Region.
+ *The Amazon Resource Name (ARN) of the target endpoint for + * this DMS serverless replication configuration.
*/ - KmsKeyId?: string; + TargetEndpointArn: string | undefined; /** - * Specifies the accessibility options for the replication instance. A value of
- * true represents an instance with a public IP address. A value of
- * false represents an instance with a private IP address. The default value
- * is true.
Configuration parameters for provisioning an DMS Serverless replication.
*/ - PubliclyAccessible?: boolean; + ComputeConfig: ComputeConfig | undefined; /** - *A list of custom DNS name servers supported for the replication instance to access your
- * on-premise source or target database. This list overrides the default name servers
- * supported by the replication instance. You can specify a comma-separated list of internet
- * addresses for up to four on-premise DNS name servers. For example:
- * "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
- *
The type of DMS Serverless replication to provision + * using this replication configuration.
+ *Possible values:
+ *
+ * "full-load"
+ *
+ * "cdc"
+ *
+ * "full-load-and-cdc"
+ *
A friendly name for the resource identifier at the end of the EndpointArn
- * response parameter that is returned in the created Endpoint object. The value
- * for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,
- * and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,
- * and can only begin with a letter, such as Example-App-ARN1. For example, this
- * value might result in the EndpointArn value
- * arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't
- * specify a ResourceIdentifier value, DMS generates a default identifier
- * value for the end of EndpointArn.
JSON table mappings for DMS Serverless replications that are provisioned + * using this replication configuration. For more information, see + * + * Specifying table selection and transformations rules using JSON.
+ */ + TableMappings: string | undefined; + + /** + *Optional JSON settings for DMS Serverless replications that are + * provisioned using this replication configuration. For example, see + * + * Change processing tuning settings.
+ */ + ReplicationSettings?: string; + + /** + *Optional JSON settings for specifying supplemental data. For more information, see + * + * Specifying supplemental data for task settings.
+ */ + SupplementalSettings?: string; + + /** + *Optional unique value or name that you set for a given resource + * that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see + * + * Fine-grained access control using resource names and tags.
*/ ResourceIdentifier?: string; /** - *The type of IP address protocol used by a replication instance, - * such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. - * IPv6 only is not yet supported.
+ *One or more optional tags associated with resources used by the DMS Serverless replication. + * For more information, see + * Tagging resources in Database Migration Service.
*/ - NetworkType?: string; + Tags?: Tag[]; } /** * @public - *Provides information about the values of pending modifications to a replication
- * instance. This data type is an object of the
- *
- * ReplicationInstance
- * user-defined
- * data type.
This object provides configuration information about a serverless replication.
*/ -export interface ReplicationPendingModifiedValues { +export interface ReplicationConfig { /** - *The compute and memory capacity of the replication instance as defined for the specified - * replication instance class.
- *For more information on the settings and capacities for the available replication instance classes, see + *
The identifier for the ReplicationConfig associated with the replication.
The Amazon Resource Name (ARN) of + * this DMS Serverless replication configuration.
+ */ + ReplicationConfigArn?: string; + + /** + *The Amazon Resource Name (ARN) of the source endpoint for + * this DMS serverless replication configuration.
+ */ + SourceEndpointArn?: string; + + /** + *The Amazon Resource Name (ARN) of the target endpoint for + * this DMS serverless replication configuration.
+ */ + TargetEndpointArn?: string; + + /** + *The type of the replication.
+ */ + ReplicationType?: MigrationTypeValue | string; + + /** + *Configuration parameters for provisioning an DMS serverless replication.
+ */ + ComputeConfig?: ComputeConfig; + + /** + *Configuration parameters for an DMS serverless replication.
+ */ + ReplicationSettings?: string; + + /** + *Additional parameters for an DMS serverless replication.
+ */ + SupplementalSettings?: string; + + /** + *Table mappings specified in the replication.
+ */ + TableMappings?: string; + + /** + *The time the serverless replication config was created.
+ */ + ReplicationConfigCreateTime?: Date; + + /** + *The time the serverless replication config was updated.
+ */ + ReplicationConfigUpdateTime?: Date; +} + +/** + * @public + * + */ +export interface CreateReplicationConfigResponse { + /** + *Configuration parameters returned from the DMS Serverless replication after it is created.
+ */ + ReplicationConfig?: ReplicationConfig; +} + +/** + * @public + *The subnet provided isn't valid.
+ */ +export class InvalidSubnet extends __BaseException { + readonly name: "InvalidSubnet" = "InvalidSubnet"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
+ */ +export class ReplicationSubnetGroupDoesNotCoverEnoughAZs extends __BaseException { + readonly name: "ReplicationSubnetGroupDoesNotCoverEnoughAZs" = "ReplicationSubnetGroupDoesNotCoverEnoughAZs"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe replication instance identifier. This parameter is stored as a lowercase + * string.
+ *Constraints:
+ *Must contain 1-63 alphanumeric characters or hyphens.
+ *First character must be a letter.
+ *Can't end with a hyphen or contain two consecutive hyphens.
+ *Example: myrepinstance
+ *
The amount of storage (in gigabytes) to be initially allocated for the replication + * instance.
+ */ + AllocatedStorage?: number; + + /** + *The compute and memory capacity of the replication instance as defined for the specified
+ * replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see + * + * Choosing the right DMS replication instance; and, + * Selecting the best size for a replication instance. + *
+ */ + ReplicationInstanceClass: string | undefined; + + /** + *Specifies the VPC security group to be used with the replication instance. The VPC + * security group must work with the VPC containing the replication instance.
+ */ + VpcSecurityGroupIds?: string[]; + + /** + *The Availability Zone where the replication instance will be created. The default
+ * value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for
+ * example: us-east-1d.
A subnet group to associate with the replication instance.
+ */ + ReplicationSubnetGroupIdentifier?: string; + + /** + *The weekly time range during which system maintenance can occur, in Universal + * Coordinated Time (UTC).
+ * Format: ddd:hh24:mi-ddd:hh24:mi
+ *
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, + * occurring on a random day of the week.
+ *Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
+ *Constraints: Minimum 30-minute window.
+ */ + PreferredMaintenanceWindow?: string; + + /** + * Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
+ * AvailabilityZone parameter if the Multi-AZ parameter is set to
+ * true.
The engine version number of the replication instance.
+ *If an engine version number is not specified when a replication + * instance is created, the default is the latest engine version available.
+ */ + EngineVersion?: string; + + /** + *A value that indicates whether minor engine upgrades are applied automatically to the
+ * replication instance during the maintenance window. This parameter defaults to
+ * true.
Default: true
+ *
When AutoMinorVersionUpgrade is enabled, DMS uses the current default
+ * engine version when you create a replication instance. For example, if you set
+ * EngineVersion to a lower version number than the current default version,
+ * DMS uses the default version.
If AutoMinorVersionUpgrade
+ * isn’t enabled when you create a replication instance, DMS uses the
+ * engine version specified by the EngineVersion parameter.
One or more tags to be assigned to the replication instance.
+ */ + Tags?: Tag[]; + + /** + *An KMS key identifier that is used to encrypt the data on the replication + * instance.
+ *If you don't specify a value for the KmsKeyId parameter, then
+ * DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a + * different default encryption key for each Amazon Web Services Region.
+ */ + KmsKeyId?: string; + + /** + * Specifies the accessibility options for the replication instance. A value of
+ * true represents an instance with a public IP address. A value of
+ * false represents an instance with a private IP address. The default value
+ * is true.
A list of custom DNS name servers supported for the replication instance to access your
+ * on-premise source or target database. This list overrides the default name servers
+ * supported by the replication instance. You can specify a comma-separated list of internet
+ * addresses for up to four on-premise DNS name servers. For example:
+ * "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
+ *
A friendly name for the resource identifier at the end of the EndpointArn
+ * response parameter that is returned in the created Endpoint object. The value
+ * for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,
+ * and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,
+ * and can only begin with a letter, such as Example-App-ARN1. For example, this
+ * value might result in the EndpointArn value
+ * arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't
+ * specify a ResourceIdentifier value, DMS generates a default identifier
+ * value for the end of EndpointArn.
The type of IP address protocol used by a replication instance, + * such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. + * IPv6 only is not yet supported.
+ */ + NetworkType?: string; +} + +/** + * @public + *Provides information about the values of pending modifications to a replication
+ * instance. This data type is an object of the
+ *
+ * ReplicationInstance
+ * user-defined
+ * data type.
The compute and memory capacity of the replication instance as defined for the specified + * replication instance class.
+ *For more information on the settings and capacities for the available replication instance classes, see * * Selecting the right DMS replication instance for your migration. *
@@ -4888,55 +5362,15 @@ export class InsufficientResourceCapacityFault extends __BaseException { /** * @public - *The subnet provided is invalid.
+ *The storage quota has been exceeded.
*/ -export class InvalidSubnet extends __BaseException { - readonly name: "InvalidSubnet" = "InvalidSubnet"; +export class StorageQuotaExceededFault extends __BaseException { + readonly name: "StorageQuotaExceededFault" = "StorageQuotaExceededFault"; readonly $fault: "client" = "client"; /** * @internal */ - constructor(opts: __ExceptionOptionTypeThe replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
- */ -export class ReplicationSubnetGroupDoesNotCoverEnoughAZs extends __BaseException { - readonly name: "ReplicationSubnetGroupDoesNotCoverEnoughAZs" = "ReplicationSubnetGroupDoesNotCoverEnoughAZs"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe storage quota has been exceeded.
- */ -export class StorageQuotaExceededFault extends __BaseException { - readonly name: "StorageQuotaExceededFault" = "StorageQuotaExceededFault"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe replication config to delete.
+ */ + ReplicationConfigArn: string | undefined; +} + +/** + * @public + * + */ +export interface DeleteReplicationConfigResponse { + /** + *Configuration parameters returned for the DMS Serverless replication after it is deleted.
+ */ + ReplicationConfig?: ReplicationConfig; +} + /** * @public * @@ -6138,7 +6579,7 @@ export interface DescribeEndpointsResponse { */ export interface DescribeEndpointSettingsMessage { /** - *The databse engine used for your source or target endpoint.
+ *The database engine used for your source or target endpoint.
*/ EngineName: string | undefined; @@ -7650,6 +8091,11 @@ export interface RdsRequirements { * Single-AZ deployments. */ DeploymentOption?: string; + + /** + *The required target Amazon RDS engine version.
+ */ + EngineVersion?: string; } /** @@ -7706,6 +8152,11 @@ export interface RdsConfiguration { *"MULTI_AZ" and "SINGLE_AZ".
*/
DeploymentOption?: string;
+
+ /**
+ * Describes the recommended target Amazon RDS engine version.
+ */ + EngineVersion?: string; } /** @@ -7884,6 +8335,47 @@ export interface DescribeRefreshSchemasStatusResponse { RefreshSchemasStatus?: RefreshSchemasStatus; } +/** + * @public + * + */ +export interface DescribeReplicationConfigsMessage { + /** + *Filters applied to the replication configs.
+ */ + Filters?: Filter[]; + + /** + *The maximum number of records to include in the response. If more records exist than the specified
+ * MaxRecords value, a pagination token called a marker is included in the response so that
+ * the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response
+ * includes only records beyond the marker, up to the value specified by MaxRecords.
Returned configuration parameters that describe each provisioned DMS Serverless replication.
+ */ + ReplicationConfigs?: ReplicationConfig[]; +} + /** * @public * @@ -8005,371 +8497,321 @@ export interface DescribeReplicationInstanceTaskLogsResponse { * @public * */ -export interface DescribeReplicationSubnetGroupsMessage { +export interface DescribeReplicationsMessage { /** - *Filters applied to replication subnet groups.
- *Valid filter names: replication-subnet-group-id
+ *Filters applied to the replications.
*/ Filters?: Filter[]; /** - * The maximum number of records to include in the response. If more records exist than
- * the specified MaxRecords value, a pagination token called a marker is included
- * in the response so that the remaining results can be retrieved.
Default: 100
- *Constraints: Minimum 20, maximum 100.
+ *The maximum number of records to include in the response. If more records exist than the specified
+ * MaxRecords value, a pagination token called a marker is included in the response so that
+ * the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the marker, up to the value specified by MaxRecords.
Information about provisioning resources for an DMS serverless replication.
*/ -export interface DescribeReplicationSubnetGroupsResponse { +export interface ProvisionData { /** - * An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
The current provisioning state
*/ - Marker?: string; + ProvisionState?: string; /** - *A description of the replication subnet groups.
+ *The number of capacity units the replication is using.
*/ - ReplicationSubnetGroups?: ReplicationSubnetGroup[]; -} + ProvisionedCapacityUnits?: number; -/** - * @public - * - */ -export interface DescribeReplicationTaskAssessmentResultsMessage { /** - *The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input
- * parameter is specified, the API returns only one result and ignore the values of the
- * MaxRecords and Marker parameters.
The timestamp when DMS provisioned replication resources.
*/ - ReplicationTaskArn?: string; + DateProvisioned?: Date; /** - * The maximum number of records to include in the response. If more records exist than
- * the specified MaxRecords value, a pagination token called a marker is included
- * in the response so that the remaining results can be retrieved.
Default: 100
- *Constraints: Minimum 20, maximum 100.
+ *Whether the new provisioning is available to the replication.
*/ - MaxRecords?: number; + IsNewProvisioningAvailable?: boolean; /** - * An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
The timestamp when provisioning became available.
*/ - Marker?: string; + DateNewProvisioningDataAvailable?: Date; + + /** + *A message describing the reason that DMS provisioned new resources for the serverless replication.
+ */ + ReasonForNewProvisioningData?: string; } /** * @public - *The task assessment report in JSON format.
+ *This object provides a collection of statistics about a serverless replication.
*/ -export interface ReplicationTaskAssessmentResult { +export interface ReplicationStats { /** - *The replication task identifier of the task on which the task assessment was run. - *
+ *The percent complete for the full load serverless replication.
*/ - ReplicationTaskIdentifier?: string; + FullLoadProgressPercent?: number; /** - *The Amazon Resource Name (ARN) of the replication task.
+ *The elapsed time of the replication, in milliseconds.
*/ - ReplicationTaskArn?: string; + ElapsedTimeMillis?: number; /** - *The date the task assessment was completed.
+ *The number of tables loaded for this replication.
*/ - ReplicationTaskLastAssessmentDate?: Date; + TablesLoaded?: number; /** - *The status of the task assessment.
+ *The number of tables currently loading for this replication.
*/ - AssessmentStatus?: string; + TablesLoading?: number; /** - *The file containing the results of the task assessment.
+ *The number of tables queued for this replication.
*/ - AssessmentResultsFile?: string; + TablesQueued?: number; /** - *The task assessment results in JSON format.
- *The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn - * in the request.
+ *The number of errors that have occured for this replication.
*/ - AssessmentResults?: string; + TablesErrored?: number; /** - *The URL of the S3 object containing the task assessment results.
- *The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn - * in the request.
+ *The date the replication was started either with a fresh start or a target reload.
*/ - S3ObjectUrl?: string; -} + FreshStartDate?: Date; -/** - * @public - * - */ -export interface DescribeReplicationTaskAssessmentResultsResponse { /** - * An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
The date the replication is scheduled to start.
*/ - Marker?: string; + StartDate?: Date; /** - *- The Amazon S3 bucket where the task assessment report is located.
+ *The date the replication was stopped.
*/ - BucketName?: string; + StopDate?: Date; /** - *The task assessment report.
+ *The date the replication full load was started.
*/ - ReplicationTaskAssessmentResults?: ReplicationTaskAssessmentResult[]; + FullLoadStartDate?: Date; + + /** + *The date the replication full load was finished.
+ */ + FullLoadFinishDate?: Date; } /** * @public - * + *Provides information that describes a serverless replication created by the CreateReplication operation.
Filters applied to the premigration assessment runs described in the form of key-value pairs.
- *Valid filter names: replication-task-assessment-run-arn, replication-task-arn,
- * replication-instance-arn, status
- *
The identifier for the ReplicationConfig associated with the replication.
The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords value, a pagination token called a marker is included in
- * the response so that the remaining results can be retrieved.
The Amazon Resource Name for the ReplicationConfig associated with the replication.
An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
A pagination token returned for you to pass to a subsequent request. If you pass this
- * token as the Marker value in a subsequent request, the response includes only
- * records beyond the marker, up to the value specified in the request by
- * MaxRecords.
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
One or more premigration assessment runs as specified by Filters.
The type of the serverless replication.
*/ - ReplicationTaskAssessmentRuns?: ReplicationTaskAssessmentRun[]; -} + ReplicationType?: MigrationTypeValue | string; -/** - * @public - * - */ -export interface DescribeReplicationTaskIndividualAssessmentsMessage { /** - *Filters applied to the individual assessments described in the form of key-value - * pairs.
- *Valid filter names: replication-task-assessment-run-arn,
- * replication-task-arn, status
- *
The current status of the serverless replication.
*/ - Filters?: Filter[]; + Status?: string; /** - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords value, a pagination token called a marker is included in
- * the response so that the remaining results can be retrieved.
Information about provisioning resources for an DMS serverless replication.
*/ - MaxRecords?: number; + ProvisionData?: ProvisionData; /** - *An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
Provides information that describes an individual assessment from a premigration - * assessment run.
- */ -export interface ReplicationTaskIndividualAssessment { - /** - *Amazon Resource Name (ARN) of this individual assessment.
- */ - ReplicationTaskIndividualAssessmentArn?: string; - - /** - *ARN of the premigration assessment run that is created to run this individual - * assessment.
- */ - ReplicationTaskAssessmentRunArn?: string; - - /** - *Name of this individual assessment.
- */ - IndividualAssessmentName?: string; - - /** - *Individual assessment status.
- *This status can have one of the following values:
+ *The reason the replication task was stopped. This response parameter can return one of + * the following values:
*
- * "cancelled"
+ * "Stop Reason NORMAL"
*
- * "error"
+ * "Stop Reason RECOVERABLE_ERROR"
*
- * "failed"
+ * "Stop Reason FATAL_ERROR"
*
- * "passed"
+ * "Stop Reason FULL_LOAD_ONLY_FINISHED"
*
- * "pending"
+ * "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied
+ * "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied
+ * "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
*
- * "running"
+ * "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied
+ * "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
+ *
+ * "Stop Reason STOPPED_DUE_TO_LOW_DISK"
+ *
+ * "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
+ * "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
+ * "Stop Reason RECONFIGURATION_RESTART"
+ *
+ * "Stop Reason RECYCLE_TASK"
*
Date when this individual assessment was started as part of running the
- * StartReplicationTaskAssessmentRun operation.
Error and other information about why a serverless replication failed.
*/ - ReplicationTaskIndividualAssessmentStartDate?: Date; -} + FailureMessages?: string[]; -/** - * @public - * - */ -export interface DescribeReplicationTaskIndividualAssessmentsResponse { /** - *A pagination token returned for you to pass to a subsequent request. If you pass this
- * token as the Marker value in a subsequent request, the response includes only
- * records beyond the marker, up to the value specified in the request by
- * MaxRecords.
This object provides a collection of statistics about a serverless replication.
*/ - Marker?: string; + ReplicationStats?: ReplicationStats; /** - *One or more individual assessments as specified by Filters.
The replication type.
*/ - ReplicationTaskIndividualAssessments?: ReplicationTaskIndividualAssessment[]; -} + StartReplicationType?: string; -/** - * @public - * - */ -export interface DescribeReplicationTasksMessage { /** - *Filters applied to replication tasks.
- *Valid filter names: replication-task-arn | replication-task-id | migration-type | - * endpoint-arn | replication-instance-arn
+ *Indicates the start time for a change data capture (CDC) operation. Use either
+ * CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.
+ * Specifying both values results in an error.
The maximum number of records to include in the response. If more records exist than
- * the specified MaxRecords value, a pagination token called a marker is included
- * in the response so that the remaining results can be retrieved.
Default: 100
- *Constraints: Minimum 20, maximum 100.
+ *Indicates the start time for a change data capture (CDC) operation. Use either
+ * CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.
+ * Specifying both values results in an error.
An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
Indicates when you want a change data capture (CDC) operation to stop. The value can be + * either server time or commit time.
*/ - Marker?: string; + CdcStopPosition?: string; /** - *An option to set to avoid returning information about settings. Use this to reduce
- * overhead when setting information is too large. To use this option, choose
- * true; otherwise, choose false (the default).
Indicates the last checkpoint that occurred during a change data capture (CDC)
+ * operation. You can provide this value to the CdcStartPosition parameter to
+ * start a CDC operation that begins at that checkpoint.
The time the serverless replication was created.
+ */ + ReplicationCreateTime?: Date; + + /** + *The time the serverless replication was updated.
+ */ + ReplicationUpdateTime?: Date; + + /** + *The timestamp when replication was last stopped.
+ */ + ReplicationLastStopTime?: Date; } /** * @public * */ -export interface DescribeReplicationTasksResponse { +export interface DescribeReplicationsResponse { /** - * An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the marker, up to the value specified by MaxRecords.
A description of the replication tasks.
+ *The replication descriptions.
*/ - ReplicationTasks?: ReplicationTask[]; + Replications?: Replication[]; } /** * @public * */ -export interface DescribeSchemasMessage { +export interface DescribeReplicationSubnetGroupsMessage { /** - *The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
+ *Filters applied to replication subnet groups.
+ *Valid filter names: replication-subnet-group-id
*/ - EndpointArn: string | undefined; + Filters?: Filter[]; /** *The maximum number of records to include in the response. If more records exist than @@ -8392,7 +8834,7 @@ export interface DescribeSchemasMessage { * @public *
*/ -export interface DescribeSchemasResponse { +export interface DescribeReplicationSubnetGroupsResponse { /** *An optional pagination token provided by a previous request. If this parameter is * specified, the response includes only records beyond the marker, up to the value specified @@ -8401,42 +8843,36 @@ export interface DescribeSchemasResponse { Marker?: string; /** - *
The described schema.
+ *A description of the replication subnet groups.
*/ - Schemas?: string[]; + ReplicationSubnetGroups?: ReplicationSubnetGroup[]; } /** * @public * */ -export interface DescribeTableStatisticsMessage { +export interface DescribeReplicationTableStatisticsMessage { /** - *The Amazon Resource Name (ARN) of the replication task.
+ *The replication config to describe.
*/ - ReplicationTaskArn: string | undefined; + ReplicationConfigArn: string | undefined; /** - * The maximum number of records to include in the response. If more records exist than
- * the specified MaxRecords value, a pagination token called a marker is included
- * in the response so that the remaining results can be retrieved.
Default: 100
- *Constraints: Minimum 20, maximum 500.
+ *The maximum number of records to include in the response. If more records exist than the specified
+ * MaxRecords value, a pagination token called a marker is included in the response so that
+ * the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters applied to table statistics.
- *Valid filter names: schema-name | table-name | table-state
- *A combination of filters creates an AND condition where each record matches all - * specified filters.
+ *Filters applied to the replication table statistics.
*/ Filters?: Filter[]; } @@ -8507,108 +8943,524 @@ export interface TableStatistics { *The number of rows that failed conditional checks during the full load operation (valid * only for migrations where DynamoDB is the target).
*/ - FullLoadCondtnlChkFailedRows?: number; + FullLoadCondtnlChkFailedRows?: number; + + /** + *The number of rows that failed to load during the full load operation (valid only for + * migrations where DynamoDB is the target).
+ */ + FullLoadErrorRows?: number; + + /** + *The time when the full load operation started.
+ */ + FullLoadStartTime?: Date; + + /** + *The time when the full load operation completed.
+ */ + FullLoadEndTime?: Date; + + /** + *A value that indicates if the table was reloaded (true)
+ * or loaded as part of a new full load operation (false).
The last time a table was updated.
+ */ + LastUpdateTime?: Date; + + /** + *The state of the tables described.
+ *Valid states: Table does not exist | Before load | Full load | Table completed | Table + * cancelled | Table error | Table is being reloaded
+ */ + TableState?: string; + + /** + *The number of records that have yet to be validated.
+ */ + ValidationPendingRecords?: number; + + /** + *The number of records that failed validation.
+ */ + ValidationFailedRecords?: number; + + /** + *The number of records that couldn't be validated.
+ */ + ValidationSuspendedRecords?: number; + + /** + *The validation state of the table.
+ *This parameter can have the following values:
+ *Not enabled – Validation isn't enabled for the table in the migration + * task.
+ *Pending records – Some records in the table are waiting for validation.
+ *Mismatched records – Some records in the table don't match between the source + * and target.
+ *Suspended records – Some records in the table couldn't be validated.
+ *No primary key –The table couldn't be validated because it has no primary + * key.
+ *Table error – The table wasn't validated because it's in an error state + * and some data wasn't migrated.
+ *Validated – All rows in the table are validated. If the table is updated, the + * status can change from Validated.
+ *Error – The table couldn't be validated because of an unexpected + * error.
+ *Pending validation – The table is waiting validation.
+ *Preparing table – Preparing the table enabled in the migration task for validation.
+ *Pending revalidation – All rows in the table are pending validation after the table was updated.
+ *Additional details about the state of validation.
+ */ + ValidationStateDetails?: string; +} + +/** + * @public + * + */ +export interface DescribeReplicationTableStatisticsResponse { + /** + *The Amazon Resource Name of the replication config.
+ */ + ReplicationConfigArn?: string; + + /** + *An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the marker, up to the value specified by MaxRecords.
Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.
+ */ + ReplicationTableStatistics?: TableStatistics[]; +} + +/** + * @public + * + */ +export interface DescribeReplicationTaskAssessmentResultsMessage { + /** + *The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input
+ * parameter is specified, the API returns only one result and ignore the values of the
+ * MaxRecords and Marker parameters.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords value, a pagination token called a marker is included
+ * in the response so that the remaining results can be retrieved.
Default: 100
+ *Constraints: Minimum 20, maximum 100.
+ */ + MaxRecords?: number; + + /** + * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
The task assessment report in JSON format.
+ */ +export interface ReplicationTaskAssessmentResult { + /** + *The replication task identifier of the task on which the task assessment was run. + *
+ */ + ReplicationTaskIdentifier?: string; + + /** + *The Amazon Resource Name (ARN) of the replication task.
+ */ + ReplicationTaskArn?: string; + + /** + *The date the task assessment was completed.
+ */ + ReplicationTaskLastAssessmentDate?: Date; + + /** + *The status of the task assessment.
+ */ + AssessmentStatus?: string; + + /** + *The file containing the results of the task assessment.
+ */ + AssessmentResultsFile?: string; + + /** + *The task assessment results in JSON format.
+ *The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn + * in the request.
+ */ + AssessmentResults?: string; + + /** + *The URL of the S3 object containing the task assessment results.
+ *The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn + * in the request.
+ */ + S3ObjectUrl?: string; +} + +/** + * @public + * + */ +export interface DescribeReplicationTaskAssessmentResultsResponse { + /** + * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
- The Amazon S3 bucket where the task assessment report is located.
+ */ + BucketName?: string; + + /** + *The task assessment report.
+ */ + ReplicationTaskAssessmentResults?: ReplicationTaskAssessmentResult[]; +} + +/** + * @public + * + */ +export interface DescribeReplicationTaskAssessmentRunsMessage { + /** + *Filters applied to the premigration assessment runs described in the form of key-value pairs.
+ *Valid filter names: replication-task-assessment-run-arn, replication-task-arn,
+ * replication-instance-arn, status
+ *
The maximum number of records to include in the response. If more records exist than the
+ * specified MaxRecords value, a pagination token called a marker is included in
+ * the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
A pagination token returned for you to pass to a subsequent request. If you pass this
+ * token as the Marker value in a subsequent request, the response includes only
+ * records beyond the marker, up to the value specified in the request by
+ * MaxRecords.
One or more premigration assessment runs as specified by Filters.
Filters applied to the individual assessments described in the form of key-value + * pairs.
+ *Valid filter names: replication-task-assessment-run-arn,
+ * replication-task-arn, status
+ *
The maximum number of records to include in the response. If more records exist than the
+ * specified MaxRecords value, a pagination token called a marker is included in
+ * the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
Provides information that describes an individual assessment from a premigration + * assessment run.
+ */ +export interface ReplicationTaskIndividualAssessment { + /** + *Amazon Resource Name (ARN) of this individual assessment.
+ */ + ReplicationTaskIndividualAssessmentArn?: string; + + /** + *ARN of the premigration assessment run that is created to run this individual + * assessment.
+ */ + ReplicationTaskAssessmentRunArn?: string; + + /** + *Name of this individual assessment.
+ */ + IndividualAssessmentName?: string; + + /** + *Individual assessment status.
+ *This status can have one of the following values:
+ *
+ * "cancelled"
+ *
+ * "error"
+ *
+ * "failed"
+ *
+ * "passed"
+ *
+ * "pending"
+ *
+ * "running"
+ *
Date when this individual assessment was started as part of running the
+ * StartReplicationTaskAssessmentRun operation.
A pagination token returned for you to pass to a subsequent request. If you pass this
+ * token as the Marker value in a subsequent request, the response includes only
+ * records beyond the marker, up to the value specified in the request by
+ * MaxRecords.
One or more individual assessments as specified by Filters.
Filters applied to replication tasks.
+ *Valid filter names: replication-task-arn | replication-task-id | migration-type | + * endpoint-arn | replication-instance-arn
+ */ + Filters?: Filter[]; + + /** + * The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords value, a pagination token called a marker is included
+ * in the response so that the remaining results can be retrieved.
Default: 100
+ *Constraints: Minimum 20, maximum 100.
+ */ + MaxRecords?: number; + + /** + * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
An option to set to avoid returning information about settings. Use this to reduce
+ * overhead when setting information is too large. To use this option, choose
+ * true; otherwise, choose false (the default).
The number of rows that failed to load during the full load operation (valid only for - * migrations where DynamoDB is the target).
+ * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
The time when the full load operation started.
+ *A description of the replication tasks.
*/ - FullLoadStartTime?: Date; + ReplicationTasks?: ReplicationTask[]; +} +/** + * @public + * + */ +export interface DescribeSchemasMessage { /** - *The time when the full load operation completed.
+ *The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/ - FullLoadEndTime?: Date; + EndpointArn: string | undefined; /** - *A value that indicates if the table was reloaded (true)
- * or loaded as part of a new full load operation (false).
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords value, a pagination token called a marker is included
+ * in the response so that the remaining results can be retrieved.
Default: 100
+ *Constraints: Minimum 20, maximum 100.
*/ - FullLoadReloaded?: boolean; + MaxRecords?: number; /** - *The last time a table was updated.
+ * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
The state of the tables described.
- *Valid states: Table does not exist | Before load | Full load | Table completed | Table - * cancelled | Table error | Table is being reloaded
+ * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
The number of records that have yet to be validated.
+ *The described schema.
*/ - ValidationPendingRecords?: number; + Schemas?: string[]; +} +/** + * @public + * + */ +export interface DescribeTableStatisticsMessage { /** - *The number of records that failed validation.
+ *The Amazon Resource Name (ARN) of the replication task.
*/ - ValidationFailedRecords?: number; + ReplicationTaskArn: string | undefined; /** - *The number of records that couldn't be validated.
+ * The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords value, a pagination token called a marker is included
+ * in the response so that the remaining results can be retrieved.
Default: 100
+ *Constraints: Minimum 20, maximum 500.
*/ - ValidationSuspendedRecords?: number; + MaxRecords?: number; /** - *The validation state of the table.
- *This parameter can have the following values:
- *Not enabled – Validation isn't enabled for the table in the migration - * task.
- *Pending records – Some records in the table are waiting for validation.
- *Mismatched records – Some records in the table don't match between the source - * and target.
- *Suspended records – Some records in the table couldn't be validated.
- *No primary key –The table couldn't be validated because it has no primary - * key.
- *Table error – The table wasn't validated because it's in an error state - * and some data wasn't migrated.
- *Validated – All rows in the table are validated. If the table is updated, the - * status can change from Validated.
- *Error – The table couldn't be validated because of an unexpected - * error.
- *Pending validation – The table is waiting validation.
- *Preparing table – Preparing the table enabled in the migration task for validation.
- *Pending revalidation – All rows in the table are pending validation after the table was updated.
- * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords.
Additional details about the state of validation.
+ *Filters applied to table statistics.
+ *Valid filter names: schema-name | table-name | table-state
+ *A combination of filters creates an AND condition where each record matches all + * specified filters.
*/ - ValidationStateDetails?: string; + Filters?: Filter[]; } /** @@ -8998,6 +9850,11 @@ export interface ModifyEndpointMessage { *Settings in JSON format for the source GCP MySQL endpoint.
*/ GcpMySQLSettings?: GcpMySQLSettings; + + /** + *Settings in JSON format for the target Amazon Timestream endpoint.
+ */ + TimestreamSettings?: TimestreamSettings; } /** @@ -9057,6 +9914,69 @@ export interface ModifyEventSubscriptionResponse { EventSubscription?: EventSubscription; } +/** + * @public + * + */ +export interface ModifyReplicationConfigMessage { + /** + *The Amazon Resource Name of the replication to modify.
+ */ + ReplicationConfigArn: string | undefined; + + /** + *The new replication config to apply to the replication.
+ */ + ReplicationConfigIdentifier?: string; + + /** + *The type of replication.
+ */ + ReplicationType?: MigrationTypeValue | string; + + /** + *Table mappings specified in the replication.
+ */ + TableMappings?: string; + + /** + *The settings for the replication.
+ */ + ReplicationSettings?: string; + + /** + *Additional settings for the replication.
+ */ + SupplementalSettings?: string; + + /** + *Configuration parameters for provisioning an DMS Serverless replication.
+ */ + ComputeConfig?: ComputeConfig; + + /** + *The Amazon Resource Name (ARN) of the source endpoint for + * this DMS serverless replication configuration.
+ */ + SourceEndpointArn?: string; + + /** + *The Amazon Resource Name (ARN) of the target endpoint for + * this DMS serverless replication configuration.
+ */ + TargetEndpointArn?: string; +} + +/** + * @public + */ +export interface ModifyReplicationConfigResponse { + /** + *Information about the serverless replication config that was modified.
+ */ + ReplicationConfig?: ReplicationConfig; +} + /** * @public * @@ -9476,6 +10396,40 @@ export interface TableToReload { TableName: string | undefined; } +/** + * @public + * + */ +export interface ReloadReplicationTablesMessage { + /** + *The Amazon Resource Name of the replication config for which to reload tables.
+ */ + ReplicationConfigArn: string | undefined; + + /** + *The list of tables to reload.
+ */ + TablesToReload: TableToReload[] | undefined; + + /** + *Options for reload. Specify data-reload to reload the data and re-validate
+ * it if validation is enabled. Specify validate-only to re-validate the table.
+ * This option applies only when validation is enabled for the replication.
The Amazon Resource Name of the replication config for which to reload tables.
+ */ + ReplicationConfigArn?: string; +} + /** * @public */ @@ -9568,6 +10522,53 @@ export interface StartRecommendationsRequest { Settings: RecommendationSettings | undefined; } +/** + * @public + * + */ +export interface StartReplicationMessage { + /** + *The Amazon Resource Name of the replication for which to start replication.
+ */ + ReplicationConfigArn: string | undefined; + + /** + *The replication type.
+ */ + StartReplicationType: string | undefined; + + /** + *Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime
+ * or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Indicates when you want a change data capture (CDC) operation to start. Use either
+ * CdcStartPosition or CdcStartTime to specify when you want a
+ * CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
+ */ + CdcStartPosition?: string; + + /** + *Indicates when you want a change data capture (CDC) operation to stop. The value can be + * either server time or commit time.
+ */ + CdcStopPosition?: string; +} + +/** + * @public + * + */ +export interface StartReplicationResponse { + /** + *The replication that DMS started.
+ */ + Replication?: Replication; +} + /** * @public * @enum @@ -9801,6 +10802,27 @@ export interface StartReplicationTaskAssessmentRunResponse { ReplicationTaskAssessmentRun?: ReplicationTaskAssessmentRun; } +/** + * @public + * + */ +export interface StopReplicationMessage { + /** + *The Amazon Resource Name of the replication to stop.
+ */ + ReplicationConfigArn: string | undefined; +} + +/** + * @public + */ +export interface StopReplicationResponse { + /** + *The replication that DMS stopped.
+ */ + Replication?: Replication; +} + /** * @public * diff --git a/clients/client-database-migration-service/src/pagination/DescribeReplicationConfigsPaginator.ts b/clients/client-database-migration-service/src/pagination/DescribeReplicationConfigsPaginator.ts new file mode 100644 index 000000000000..e75672095619 --- /dev/null +++ b/clients/client-database-migration-service/src/pagination/DescribeReplicationConfigsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + DescribeReplicationConfigsCommand, + DescribeReplicationConfigsCommandInput, + DescribeReplicationConfigsCommandOutput, +} from "../commands/DescribeReplicationConfigsCommand"; +import { DatabaseMigrationServiceClient } from "../DatabaseMigrationServiceClient"; +import { DatabaseMigrationServicePaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: DatabaseMigrationServiceClient, + input: DescribeReplicationConfigsCommandInput, + ...args: any +): PromiseThe Availability Zone where the DMS Serverless replication using this configuration will run. \n The default value is a random, system-chosen Availability Zone in the configuration's Amazon Web Services Region,\n for example, \"us-west-2\". You can't set this parameter if the MultiAZ\n parameter is set to true.
A list of custom DNS name servers supported for the DMS Serverless replication\n to access your source or target database. This list overrides the default name servers\n supported by the DMS Serverless replication. You can specify a comma-separated list of\n internet addresses for up to four DNS name servers.\n For example: \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n
An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during\n DMS Serverless replication.
\nIf you don't specify a value for the KmsKeyId parameter, DMS uses your default\n encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" + } + }, + "MaxCapacityUnits": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless\n replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed.\n The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value\n that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only\n DCU parameter you are required to specify.
Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS\n Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value\n allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU\n value that you can specify for DMS Serverless is 2. You don't have to specify a value for the\n MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity\n of available source tables to identify an optimum setting for this parameter. If there is no current\n source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to\n the minimum DCU value allowed, 2.
Specifies whether the DMS Serverless replication is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the MultiAZ parameter is set to\n true.
The weekly time range during which system maintenance can occur for the DMS Serverless\n replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi.
The default is a 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region.\n This maintenance occurs on a random day of the week. Valid values for days of the week include\n Mon, Tue, Wed, Thu, Fri, Sat,\n and Sun.
Constraints include a minimum 30-minute window.
" + } + }, + "ReplicationSubnetGroupId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies a subnet group identifier to associate with the DMS Serverless replication.
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.databasemigrationservice#StringList", + "traits": { + "smithy.api#documentation": "Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless\n replication. The VPC security group must work with the VPC containing the replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration parameters for provisioning an DMS Serverless replication.
" + } + }, "com.amazonaws.databasemigrationservice#Connection": { "type": "structure", "members": { @@ -2335,6 +2474,12 @@ "traits": { "smithy.api#documentation": "Settings in JSON format for the source GCP MySQL endpoint.
" } + }, + "TimestreamSettings": { + "target": "com.amazonaws.databasemigrationservice#TimestreamSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the target Amazon Timestream endpoint.
" + } } }, "traits": { @@ -2569,21 +2714,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationInstance": { + "com.amazonaws.databasemigrationservice#CreateReplicationConfig": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - { - "target": "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault" - }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -2604,114 +2746,79 @@ }, { "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" } ], "traits": { - "smithy.api#documentation": "Creates the replication instance using the specified parameters.
\nDMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the CLI and DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use DMS.
" + "smithy.api#documentation": "Creates a configuration that you can later provide to configure and start an DMS Serverless\n replication. You can also provide options to validate the configuration inputs before you start the\n replication.
" } }, - "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage": { + "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage": { "type": "structure", "members": { - "ReplicationInstanceIdentifier": { + "ReplicationConfigIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The replication instance identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nMust contain 1-63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: myrepinstance\n
A unique identifier that you want to use to create a ReplicationConfigArn that is\n returned as part of the output from this action. You can then pass this output ReplicationConfigArn\n as the value of the ReplicationConfigArn option for other actions to identify both\n DMS Serverless replications and replication configurations that you want those actions to operate on.\n For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to\n identify the specific replication and replication configuration to operate on.
The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.
" - } - }, - "ReplicationInstanceClass": { + "SourceEndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source endpoint for\n this DMS Serverless replication configuration.
", "smithy.api#required": {} } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.
" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for\n example: us-east-1d\n
A subnet group to associate with the replication instance.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target endpoint for\n this DMS serverless replication configuration.
", + "smithy.api#required": {} } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.databasemigrationservice#String", + "ComputeConfig": { + "target": "com.amazonaws.databasemigrationservice#ComputeConfig", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).
\n Format: ddd:hh24:mi-ddd:hh24:mi\n
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region,\n occurring on a random day of the week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "Configuration parameters for provisioning an DMS Serverless replication.
", + "smithy.api#required": {} } }, - "MultiAZ": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ReplicationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", "traits": { - "smithy.api#documentation": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.
The type of DMS Serverless replication to provision\n using this replication configuration.
\nPossible values:
\n\n \"full-load\"\n
\n \"cdc\"\n
\n \"full-load-and-cdc\"\n
The engine version number of the replication instance.
\nIf an engine version number is not specified when a replication \n instance is created, the default is the latest engine version available.
" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.
Default: true\n
When AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you create a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you create a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
One or more tags to be assigned to the replication instance.
" + "smithy.api#documentation": "JSON table mappings for DMS Serverless replications that are provisioned\n using this replication configuration. For more information, see \n \n Specifying table selection and transformations rules using JSON.
", + "smithy.api#required": {} } }, - "KmsKeyId": { + "ReplicationSettings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An KMS key identifier that is used to encrypt the data on the replication\n instance.
\nIf you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": " Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.
Optional JSON settings for DMS Serverless replications that are\n provisioned using this replication configuration. For example, see\n \n Change processing tuning settings.
" } }, - "DnsNameServers": { + "SupplementalSettings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A list of custom DNS name servers supported for the replication instance to access your\n on-premise source or target database. This list overrides the default name servers\n supported by the replication instance. You can specify a comma-separated list of internet\n addresses for up to four on-premise DNS name servers. For example:\n \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n
Optional JSON settings for specifying supplemental data. For more information, see\n \n Specifying supplemental data for task settings.
" } }, "ResourceIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, DMS generates a default identifier\n value for the end of EndpointArn.
Optional unique value or name that you set for a given resource\n that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see\n \n Fine-grained access control using resource names and tags.
" } }, - "NetworkType": { - "target": "com.amazonaws.databasemigrationservice#String", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" + "smithy.api#documentation": "One or more optional tags associated with resources used by the DMS Serverless replication.\n For more information, see \n Tagging resources in Database Migration Service.
" } } }, @@ -2719,13 +2826,13 @@ "smithy.api#documentation": "" } }, - "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse": { + "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse": { "type": "structure", "members": { - "ReplicationInstance": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", "traits": { - "smithy.api#documentation": "The replication instance that was created.
" + "smithy.api#documentation": "Configuration parameters returned from the DMS Serverless replication after it is created.
" } } }, @@ -2734,21 +2841,30 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroup": { + "com.amazonaws.databasemigrationservice#CreateReplicationInstance": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" }, + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" + }, { "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" }, @@ -2760,10 +2876,166 @@ }, { "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" } ], "traits": { - "smithy.api#documentation": "Creates a replication subnet group given a list of the subnet IDs in a VPC.
\nThe VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the\n service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
Creates the replication instance using the specified parameters.
\nDMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the CLI and DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use DMS.
" + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage": { + "type": "structure", + "members": { + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The replication instance identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nMust contain 1-63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: myrepinstance\n
The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.
" + } + }, + "ReplicationInstanceClass": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see \n \n Choosing the right DMS replication instance; and, \n Selecting the best size for a replication instance.\n
", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for\n example: us-east-1d.
A subnet group to associate with the replication instance.
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).
\n Format: ddd:hh24:mi-ddd:hh24:mi\n
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region,\n occurring on a random day of the week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" + } + }, + "MultiAZ": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.
The engine version number of the replication instance.
\nIf an engine version number is not specified when a replication \n instance is created, the default is the latest engine version available.
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.
Default: true\n
When AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you create a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you create a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
One or more tags to be assigned to the replication instance.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "An KMS key identifier that is used to encrypt the data on the replication\n instance.
\nIf you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": " Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.
A list of custom DNS name servers supported for the replication instance to access your\n on-premise source or target database. This list overrides the default name servers\n supported by the replication instance. You can specify a comma-separated list of internet\n addresses for up to four on-premise DNS name servers. For example:\n \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n
A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, DMS generates a default identifier\n value for the end of EndpointArn.
The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse": { + "type": "structure", + "members": { + "ReplicationInstance": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "traits": { + "smithy.api#documentation": "The replication instance that was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" + }, + { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "Creates a replication subnet group given a list of the subnet IDs in a VPC.
\nThe VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the\n service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action \n returns the following error message: The Replication Subnet Group already exists. In this case, delete \n the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, \n then choose your subnet group. Next, choose Delete from Actions.
" } }, "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage": { @@ -3464,6 +3736,59 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DeleteReplicationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all\n replications that use this configuration. You can't delete the configuration for an DMS Serverless replication\n that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
" + } + }, + "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The replication config to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse": { + "type": "structure", + "members": { + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "traits": { + "smithy.api#documentation": "Configuration parameters returned for the DMS Serverless replication after it is deleted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DeleteReplicationInstance": { "type": "operation", "input": { @@ -3984,7 +4309,7 @@ "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The databse engine used for your source or target endpoint.
", + "smithy.api#documentation": "The database engine used for your source or target endpoint.
", "smithy.api#required": {} } }, @@ -5070,6 +5395,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns one or more existing DMS Serverless replication configurations as a list of structures.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the replication configs.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.
Returned configuration parameters that describe each provisioned DMS Serverless replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogs": { "type": "operation", "input": { @@ -5363,21 +5757,24 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResults": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatistics": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.
\nFor more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.
", + "smithy.api#documentation": "Returns table and schema statistics for one or more provisioned replications that use a\n given DMS Serverless replication configuration.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5385,7 +5782,89 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The replication config to describe.
", + "smithy.api#required": {} + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters applied to the replication table statistics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the replication config.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.
\nFor more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { "type": "structure", "members": { "ReplicationTaskArn": { @@ -5993,6 +6472,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DescribeReplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Provides details on replication progress by returning status information for one or more\n provisioned DMS Serverless replications.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the replications.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
The replication descriptions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DescribeSchemas": { "type": "operation", "input": { @@ -6268,6 +6816,18 @@ "traits": { "smithy.api#documentation": "The full ARN, partial ARN, or friendly name of the SecretsManagerSecret\n that contains the DocumentDB endpoint connection details.
If true, DMS retrieves the entire document from the DocumentDB source during migration.\n This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates\n and deletes during migration, set this parameter to false.
If true, DMS replicates data to shard collections. DMS only uses this setting if\n the target endpoint is a DocumentDB elastic cluster.
When this setting is true, note the following:
You must set TargetTablePrepMode to nothing.
DMS automatically sets useUpdateLookup to false.
Settings in JSON format for the source GCP MySQL endpoint.
" } + }, + "TimestreamSettings": { + "target": "com.amazonaws.databasemigrationservice#TimestreamSettings", + "traits": { + "smithy.api#documentation": "The settings for the Amazon Timestream target endpoint. For more information, see the\n TimestreamSettings structure.
The subnet provided is invalid.
", + "smithy.api#documentation": "The subnet provided isn't valid.
", "smithy.api#error": "client" } }, @@ -7573,12 +8139,35 @@ "traits": { "smithy.api#documentation": "For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions \n 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this\n parameter to PLAIN.\n
Sets hostname verification\n for the certificate. This setting is supported in DMS version 3.5.1 and later.
" + } } }, "traits": { "smithy.api#documentation": "Provides information that describes an Apache Kafka endpoint. This\n information includes the output format of records applied to the endpoint and details of\n transaction and control table data information.
" } }, + "com.amazonaws.databasemigrationservice#KafkaSslEndpointIdentificationAlgorithm": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https" + } + } + } + }, "com.amazonaws.databasemigrationservice#KeyList": { "type": "list", "member": { @@ -7764,6 +8353,29 @@ "com.amazonaws.databasemigrationservice#LongOptional": { "type": "long" }, + "com.amazonaws.databasemigrationservice#LongVarcharMappingType": { + "type": "enum", + "members": { + "WSTRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "wstring" + } + }, + "CLOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "clob" + } + }, + "NCLOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nclob" + } + } + } + }, "com.amazonaws.databasemigrationservice#MessageFormatValue": { "type": "enum", "members": { @@ -8141,6 +8753,12 @@ "traits": { "smithy.api#documentation": "Settings in JSON format for the source GCP MySQL endpoint.
" } + }, + "TimestreamSettings": { + "target": "com.amazonaws.databasemigrationservice#TimestreamSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the target Amazon Timestream endpoint.
" + } } }, "traits": { @@ -8257,117 +8875,94 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#ModifyReplicationInstance": { + "com.amazonaws.databasemigrationservice#ModifyReplicationConfig": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceMessage" + "target": "com.amazonaws.databasemigrationservice#ModifyReplicationConfigMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceResponse" + "target": "com.amazonaws.databasemigrationservice#ModifyReplicationConfigResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - { - "target": "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault" - }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, { - "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" }, { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" }, { - "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" }, { - "target": "com.amazonaws.databasemigrationservice#UpgradeDependencyFailureFault" + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Modifies the replication instance to apply new settings. You can change one or more\n parameters by specifying these parameters and the new values in the request.
\nSome settings are applied during the maintenance window.
\n " + "smithy.api#documentation": "Modifies an existing DMS Serverless replication configuration that you can use\n to start a replication. This command includes input validation and logic to check\n the state of any replication that uses this configuration. You can only modify a replication\n configuration before any replication that uses it has started. As soon as you have initially\n started a replication with a given configuiration, you can't modify that configuration,\n even if you stop it.
\nOther run statuses that allow you to run this command include FAILED and CREATED.\n A provisioning state that allows you to run this command is FAILED_PROVISION.
" } }, - "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceMessage": { + "com.amazonaws.databasemigrationservice#ModifyReplicationConfigMessage": { "type": "structure", "members": { - "ReplicationInstanceArn": { + "ReplicationConfigArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
", + "smithy.api#documentation": "The Amazon Resource Name of the replication to modify.
", "smithy.api#required": {} } }, - "AllocatedStorage": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "The amount of storage (in gigabytes) to be allocated for the replication\n instance.
" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.databasemigrationservice#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the changes should be applied immediately or during the next\n maintenance window.
" - } - }, - "ReplicationInstanceClass": { + "ReplicationConfigIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
" + "smithy.api#documentation": "The new replication config to apply to the replication.
" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", + "ReplicationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", "traits": { - "smithy.api#documentation": "Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.
" + "smithy.api#documentation": "The type of replication.
" } }, - "PreferredMaintenanceWindow": { + "TableMappings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter does not result in an outage, except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n moving this window to the current time, there must be at least 30 minutes between the\n current time and end of the window to ensure pending changes are applied.
\nDefault: Uses existing setting
\nFormat: ddd:hh24:mi-ddd:hh24:mi
\nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
\nConstraints: Must be at least 30 minutes
" - } - }, - "MultiAZ": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.
Table mappings specified in the replication.
" } }, - "EngineVersion": { + "ReplicationSettings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The engine version number of the replication instance.
\nWhen modifying a major engine version of an instance, also set \n AllowMajorVersionUpgrade to true.
The settings for the replication.
" } }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.databasemigrationservice#Boolean", + "SupplementalSettings": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates that major version upgrades are allowed. Changing this parameter does not\n result in an outage, and the change is asynchronously applied as soon as possible.
\nThis parameter must be set to true when specifying a value for the\n EngineVersion parameter that is a different major version than the\n replication instance's current version.
Additional settings for the replication.
" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ComputeConfig": { + "target": "com.amazonaws.databasemigrationservice#ComputeConfig", "traits": { - "smithy.api#documentation": "A value that indicates that minor version upgrades are applied automatically to the\n replication instance during the maintenance window. Changing this parameter doesn't result\n in an outage, except in the case described following. The change is asynchronously applied\n as soon as possible.
\nAn outage does result if these factors apply:
\nThis parameter is set to true during the maintenance window.
A newer minor version is available.
\nDMS has enabled automatic patching for the given engine version.
\nWhen AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you modify a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you modify a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
Configuration parameters for provisioning an DMS Serverless replication.
" } }, - "ReplicationInstanceIdentifier": { + "SourceEndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The replication instance identifier. This parameter is stored as a lowercase\n string.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source endpoint for\n this DMS serverless replication configuration.
" } }, - "NetworkType": { + "TargetEndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target endpoint for\n this DMS serverless replication configuration.
" } } }, @@ -8375,47 +8970,179 @@ "smithy.api#documentation": "" } }, - "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceResponse": { + "com.amazonaws.databasemigrationservice#ModifyReplicationConfigResponse": { "type": "structure", "members": { - "ReplicationInstance": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", "traits": { - "smithy.api#documentation": "The modified replication instance.
" + "smithy.api#documentation": "Information about the serverless replication config that was modified.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroup": { + "com.amazonaws.databasemigrationservice#ModifyReplicationInstance": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupMessage" + "target": "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupResponse" + "target": "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, { - "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" + "target": "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault" }, { - "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" }, { - "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" }, { - "target": "com.amazonaws.databasemigrationservice#SubnetAlreadyInUse" + "target": "com.amazonaws.databasemigrationservice#UpgradeDependencyFailureFault" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the replication instance to apply new settings. You can change one or more\n parameters by specifying these parameters and the new values in the request.
\nSome settings are applied during the maintenance window.
\n " + } + }, + "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceMessage": { + "type": "structure", + "members": { + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of storage (in gigabytes) to be allocated for the replication\n instance.
" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.databasemigrationservice#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the changes should be applied immediately or during the next\n maintenance window.
" + } + }, + "ReplicationInstanceClass": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter does not result in an outage, except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n moving this window to the current time, there must be at least 30 minutes between the\n current time and end of the window to ensure pending changes are applied.
\nDefault: Uses existing setting
\nFormat: ddd:hh24:mi-ddd:hh24:mi
\nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
\nConstraints: Must be at least 30 minutes
" + } + }, + "MultiAZ": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.
The engine version number of the replication instance.
\nWhen modifying a major engine version of an instance, also set \n AllowMajorVersionUpgrade to true.
Indicates that major version upgrades are allowed. Changing this parameter does not\n result in an outage, and the change is asynchronously applied as soon as possible.
\nThis parameter must be set to true when specifying a value for the\n EngineVersion parameter that is a different major version than the\n replication instance's current version.
A value that indicates that minor version upgrades are applied automatically to the\n replication instance during the maintenance window. Changing this parameter doesn't result\n in an outage, except in the case described following. The change is asynchronously applied\n as soon as possible.
\nAn outage does result if these factors apply:
\nThis parameter is set to true during the maintenance window.
A newer minor version is available.
\nDMS has enabled automatic patching for the given engine version.
\nWhen AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you modify a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you modify a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
The replication instance identifier. This parameter is stored as a lowercase\n string.
" + } + }, + "NetworkType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceResponse": { + "type": "structure", + "members": { + "ReplicationInstance": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "traits": { + "smithy.api#documentation": "The modified replication instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" + }, + { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#SubnetAlreadyInUse" } ], "traits": { @@ -8655,6 +9382,18 @@ "traits": { "smithy.api#documentation": "The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
If true, DMS retrieves the entire document from the MongoDB source during migration.\n This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates\n and deletes during migration, set this parameter to false.
If true, DMS replicates data to shard collections. DMS only uses this setting if\n the target endpoint is a DocumentDB elastic cluster.
When this setting is true, note the following:
You must set TargetTablePrepMode to nothing.
DMS automatically sets useUpdateLookup to false.
When true, converts timestamps with the timezone datatype to their UTC value.
The timeframe in minutes to check for open transactions for a CDC-only task.
\nYou can\n specify an integer value between 0 (the default) and 240 (the maximum).
\nThis parameter is only valid in DMS version 3.5.0 and later. DMS supports\n a window of up to 9.5 hours including the value for OpenTransactionWindow.
Sets the name of a previously created logical replication slot\n for a change data capture (CDC) load of the PostgreSQL source instance.
\nWhen used with the CdcStartPosition\n request parameter for the DMS API , this attribute also makes it possible to use native CDC\n start points. DMS verifies that the specified logical\n replication slot exists before starting the CDC load task. It\n also verifies that the task was created with a valid setting of\n CdcStartPosition. If the specified slot\n doesn't exist or the task doesn't have a valid\n CdcStartPosition setting, DMS raises an\n error.
For more information about setting the CdcStartPosition request parameter,\n see Determining a CDC native start point in the Database Migration Service User\n Guide. For more information about using CdcStartPosition, see\n CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
Sets the name of a previously created logical replication slot\n for a change data capture (CDC) load of the PostgreSQL source instance.
\nWhen used with the CdcStartPosition\n request parameter for the DMS API , this attribute also makes it possible to use native CDC\n start points. DMS verifies that the specified logical\n replication slot exists before starting the CDC load task. It\n also verifies that the task was created with a valid setting of\n CdcStartPosition. If the specified slot\n doesn't exist or the task doesn't have a valid\n CdcStartPosition setting, DMS raises an\n error.
For more information about setting the CdcStartPosition request parameter,\n see Determining a CDC native start point in the Database Migration Service User\n Guide. For more information about using CdcStartPosition, see\n CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as \n varchar(5).
When true, DMS migrates JSONB values as CLOB.
" + } + }, + "MapLongVarcharAs": { + "target": "com.amazonaws.databasemigrationservice#LongVarcharMappingType", + "traits": { + "smithy.api#documentation": "When true, DMS migrates LONG values as VARCHAR.
" + } } }, "traits": { "smithy.api#documentation": "Provides information that defines a PostgreSQL endpoint.
" } }, + "com.amazonaws.databasemigrationservice#ProvisionData": { + "type": "structure", + "members": { + "ProvisionState": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The current provisioning state
" + } + }, + "ProvisionedCapacityUnits": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of capacity units the replication is using.
" + } + }, + "DateProvisioned": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The timestamp when DMS provisioned replication resources.
" + } + }, + "IsNewProvisioningAvailable": { + "target": "com.amazonaws.databasemigrationservice#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the new provisioning is available to the replication.
" + } + }, + "DateNewProvisioningDataAvailable": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The timestamp when provisioning became available.
" + } + }, + "ReasonForNewProvisioningData": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A message describing the reason that DMS provisioned new resources for the serverless replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about provisioning resources for an DMS serverless replication.
" + } + }, "com.amazonaws.databasemigrationservice#RdsConfiguration": { "type": "structure", "members": { @@ -9503,6 +10306,12 @@ "traits": { "smithy.api#documentation": "Describes the deployment option for the recommended Amazon RDS DB instance. The deployment\n options include Multi-AZ and Single-AZ deployments. Valid values include\n \"MULTI_AZ\" and \"SINGLE_AZ\".
Describes the recommended target Amazon RDS engine version.
" + } } }, "traits": { @@ -9567,6 +10376,12 @@ "traits": { "smithy.api#documentation": "The required deployment option for the Amazon RDS DB instance. Valid values include\n \"MULTI_AZ\" for Multi-AZ deployments and \"SINGLE_AZ\" for\n Single-AZ deployments.
The required target Amazon RDS engine version.
" + } } }, "traits": { @@ -10151,6 +10966,69 @@ } } }, + "com.amazonaws.databasemigrationservice#ReloadReplicationTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ReloadReplicationTablesMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ReloadReplicationTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Reloads the target database table with the source data for a given DMS Serverless\n replication configuration.
\nYou can only use this operation with a task in the RUNNING state, otherwise the service\n will throw an InvalidResourceStateFault exception.
The Amazon Resource Name of the replication config for which to reload tables.
", + "smithy.api#required": {} + } + }, + "TablesToReload": { + "target": "com.amazonaws.databasemigrationservice#TableListToReload", + "traits": { + "smithy.api#documentation": "The list of tables to reload.
", + "smithy.api#required": {} + } + }, + "ReloadOption": { + "target": "com.amazonaws.databasemigrationservice#ReloadOptionValue", + "traits": { + "smithy.api#documentation": "Options for reload. Specify data-reload to reload the data and re-validate\n it if validation is enabled. Specify validate-only to re-validate the table.\n This option applies only when validation is enabled for the replication.
The Amazon Resource Name of the replication config for which to reload tables.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#ReloadTables": { "type": "operation", "input": { @@ -10233,28 +11111,227 @@ "ResourceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
", - "smithy.api#required": {} + "smithy.api#documentation": "An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.databasemigrationservice#KeyList", + "traits": { + "smithy.api#documentation": "The tag key (name) of the tag to be removed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Removes one or more tags from an DMS resource.
" + } + }, + "com.amazonaws.databasemigrationservice#RemoveTagsFromResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#Replication": { + "type": "structure", + "members": { + "ReplicationConfigIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The identifier for the ReplicationConfig associated with the replication.
The Amazon Resource Name for the ReplicationConfig associated with the replication.
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
The type of the serverless replication.
" + } + }, + "Status": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The current status of the serverless replication.
" + } + }, + "ProvisionData": { + "target": "com.amazonaws.databasemigrationservice#ProvisionData", + "traits": { + "smithy.api#documentation": "Information about provisioning resources for an DMS serverless replication.
" + } + }, + "StopReason": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The reason the replication task was stopped. This response parameter can return one of\n the following values:
\n\n \"Stop Reason NORMAL\"\n
\n \"Stop Reason RECOVERABLE_ERROR\"\n
\n \"Stop Reason FATAL_ERROR\"\n
\n \"Stop Reason FULL_LOAD_ONLY_FINISHED\"\n
\n \"Stop Reason STOPPED_AFTER_FULL_LOAD\" – Full load completed, with cached changes not applied
\n \"Stop Reason STOPPED_AFTER_CACHED_EVENTS\" – Full load completed, with cached changes applied
\n \"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED\"\n
\n \"Stop Reason STOPPED_AFTER_DDL_APPLY\" – User-defined stop task after DDL applied
\n \"Stop Reason STOPPED_DUE_TO_LOW_MEMORY\"\n
\n \"Stop Reason STOPPED_DUE_TO_LOW_DISK\"\n
\n \"Stop Reason STOPPED_AT_SERVER_TIME\" – User-defined server time for stopping task
\n \"Stop Reason STOPPED_AT_COMMIT_TIME\" – User-defined commit time for stopping task
\n \"Stop Reason RECONFIGURATION_RESTART\"\n
\n \"Stop Reason RECYCLE_TASK\"\n
Error and other information about why a serverless replication failed.
" + } + }, + "ReplicationStats": { + "target": "com.amazonaws.databasemigrationservice#ReplicationStats", + "traits": { + "smithy.api#documentation": "This object provides a collection of statistics about a serverless replication.
" + } + }, + "StartReplicationType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The replication type.
" + } + }, + "CdcStartTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "Indicates the start time for a change data capture (CDC) operation. Use either\n CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.\n Specifying both values results in an error.
Indicates the start time for a change data capture (CDC) operation. Use either\n CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.\n Specifying both values results in an error.
Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
" + } + }, + "RecoveryCheckpoint": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Indicates the last checkpoint that occurred during a change data capture (CDC)\n operation. You can provide this value to the CdcStartPosition parameter to\n start a CDC operation that begins at that checkpoint.
The time the serverless replication was created.
" + } + }, + "ReplicationUpdateTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The time the serverless replication was updated.
" + } + }, + "ReplicationLastStopTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The timestamp when replication was last stopped.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that describes a serverless replication created by the CreateReplication operation.
The identifier for the ReplicationConfig associated with the replication.
The Amazon Resource Name (ARN) of \n this DMS Serverless replication configuration.
" + } + }, + "SourceEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source endpoint for\n this DMS serverless replication configuration.
" + } + }, + "TargetEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target endpoint for\n this DMS serverless replication configuration.
" + } + }, + "ReplicationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "traits": { + "smithy.api#documentation": "The type of the replication.
" + } + }, + "ComputeConfig": { + "target": "com.amazonaws.databasemigrationservice#ComputeConfig", + "traits": { + "smithy.api#documentation": "Configuration parameters for provisioning an DMS serverless replication.
" + } + }, + "ReplicationSettings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Configuration parameters for an DMS serverless replication.
" } }, - "TagKeys": { - "target": "com.amazonaws.databasemigrationservice#KeyList", + "SupplementalSettings": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The tag key (name) of the tag to be removed.
", - "smithy.api#required": {} + "smithy.api#documentation": "Additional parameters for an DMS serverless replication.
" + } + }, + "TableMappings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Table mappings specified in the replication.
" + } + }, + "ReplicationConfigCreateTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The time the serverless replication config was created.
" + } + }, + "ReplicationConfigUpdateTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The time the serverless replication config was updated.
" } } }, "traits": { - "smithy.api#documentation": "Removes one or more tags from an DMS resource.
" + "smithy.api#documentation": "This object provides configuration information about a serverless replication.
" } }, - "com.amazonaws.databasemigrationservice#RemoveTagsFromResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "", - "smithy.api#output": {} + "com.amazonaws.databasemigrationservice#ReplicationConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "traits": { + "smithy.api#xmlName": "ReplicationConfig" + } } }, "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue": { @@ -10498,6 +11575,15 @@ "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceTaskLog" } }, + "com.amazonaws.databasemigrationservice#ReplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#Replication", + "traits": { + "smithy.api#xmlName": "Replication" + } + } + }, "com.amazonaws.databasemigrationservice#ReplicationPendingModifiedValues": { "type": "structure", "members": { @@ -10536,6 +11622,86 @@ "smithy.api#documentation": "Provides information about the values of pending modifications to a replication\n instance. This data type is an object of the\n \n ReplicationInstance\n user-defined\n data type.
The percent complete for the full load serverless replication.
" + } + }, + "ElapsedTimeMillis": { + "target": "com.amazonaws.databasemigrationservice#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The elapsed time of the replication, in milliseconds.
" + } + }, + "TablesLoaded": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tables loaded for this replication.
" + } + }, + "TablesLoading": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tables currently loading for this replication.
" + } + }, + "TablesQueued": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tables queued for this replication.
" + } + }, + "TablesErrored": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of errors that have occured for this replication.
" + } + }, + "FreshStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication was started either with a fresh start or a target reload.
" + } + }, + "StartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication is scheduled to start.
" + } + }, + "StopDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication was stopped.
" + } + }, + "FullLoadStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication full load was started.
" + } + }, + "FullLoadFinishDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication full load was finished.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This object provides a collection of statistics about a serverless replication.
" + } + }, "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup": { "type": "structure", "members": { @@ -10604,6 +11770,12 @@ } } }, + "com.amazonaws.databasemigrationservice#ReplicationTableStatisticsList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#TableStatistics" + } + }, "com.amazonaws.databasemigrationservice#ReplicationTask": { "type": "structure", "members": { @@ -11036,7 +12208,10 @@ } }, "resourceArn": { - "target": "com.amazonaws.databasemigrationservice#ResourceArn" + "target": "com.amazonaws.databasemigrationservice#ResourceArn", + "traits": { + "smithy.api#documentation": "" + } } }, "traits": { @@ -11263,7 +12438,7 @@ "IncludeOpForFullLoad": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that enables a full load to write INSERT operations to the comma-separated value\n (.csv) output files only to indicate how the rows were added to the source database.
\nDMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.
For full load, records can only be inserted. By default (the false\n setting), no information is recorded in these output files for a full load to indicate that\n the rows were inserted at the source database. If IncludeOpForFullLoad is set\n to true or y, the INSERT is recorded as an I annotation in the\n first field of the .csv file. This allows the format of your target records from a full\n load to be consistent with the target records from a CDC load.
This setting works together with the CdcInsertsOnly and the\n CdcInsertsAndUpdates parameters for output to .csv files only. For more\n information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service\n User Guide..
A value that enables a full load to write INSERT operations to the comma-separated value\n (.csv) or .parquet output files only to indicate how the rows were added to the source database.
\nDMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.
DMS supports the use of the .parquet files with the IncludeOpForFullLoad \n parameter in versions 3.4.7 and later.
For full load, records can only be inserted. By default (the false\n setting), no information is recorded in these output files for a full load to indicate that\n the rows were inserted at the source database. If IncludeOpForFullLoad is set\n to true or y, the INSERT is recorded as an I annotation in the\n first field of the .csv file. This allows the format of your target records from a full\n load to be consistent with the target records from a CDC load.
This setting works together with the CdcInsertsOnly and the\n CdcInsertsAndUpdates parameters for output to .csv files only. For more\n information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service\n User Guide..
A value that enables a change data capture (CDC) load to write INSERT and UPDATE\n operations to .csv or .parquet (columnar storage) output files. The default setting is\n false, but when CdcInsertsAndUpdates is set to\n true or y, only INSERTs and UPDATEs from the source database\n are migrated to the .csv or .parquet file.
For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the\n value of the IncludeOpForFullLoad parameter. If\n IncludeOpForFullLoad is set to true, the first field of every\n CDC record is set to either I or U to indicate INSERT and UPDATE\n operations at the source. But if IncludeOpForFullLoad is set to\n false, CDC records are written without an indication of INSERT or UPDATE\n operations at the source. For more information about how these settings work together, see\n Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.
\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.
A value that enables a change data capture (CDC) load to write INSERT and UPDATE\n operations to .csv or .parquet (columnar storage) output files. The default setting is\n false, but when CdcInsertsAndUpdates is set to\n true or y, only INSERTs and UPDATEs from the source database\n are migrated to the .csv or .parquet file.
DMS supports the use of the .parquet files in versions 3.4.7 and later.
\nHow these INSERTs and UPDATEs are recorded depends on the\n value of the IncludeOpForFullLoad parameter. If\n IncludeOpForFullLoad is set to true, the first field of every\n CDC record is set to either I or U to indicate INSERT and UPDATE\n operations at the source. But if IncludeOpForFullLoad is set to\n false, CDC records are written without an indication of INSERT or UPDATE\n operations at the source. For more information about how these settings work together, see\n Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.
\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.
For a given DMS Serverless replication configuration, DMS connects to the source endpoint and\n collects the metadata to analyze the replication workload. Using this metadata, DMS then\n computes and provisions the required capacity and starts replicating to the target endpoint\n using the server resources that DMS has provisioned for the DMS Serverless replication.
" + } + }, + "com.amazonaws.databasemigrationservice#StartReplicationMessage": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the replication for which to start replication.
", + "smithy.api#required": {} + } + }, + "StartReplicationType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The replication type.
", + "smithy.api#required": {} + } + }, + "CdcStartTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime\n or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Indicates when you want a change data capture (CDC) operation to start. Use either \n CdcStartPosition or CdcStartTime to specify when you want a \n CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
" + } + }, + "CdcStopPosition": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be \n either server time or commit time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#StartReplicationResponse": { + "type": "structure", + "members": { + "Replication": { + "target": "com.amazonaws.databasemigrationservice#Replication", + "traits": { + "smithy.api#documentation": "The replication that DMS started.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#StartReplicationTask": { "type": "operation", "input": { @@ -11995,6 +13248,58 @@ } } }, + "com.amazonaws.databasemigrationservice#StopReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StopReplicationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StopReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications.\n This command doesn't deprovision the stopped replications.
" + } + }, + "com.amazonaws.databasemigrationservice#StopReplicationMessage": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the replication to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#StopReplicationResponse": { + "type": "structure", + "members": { + "Replication": { + "target": "com.amazonaws.databasemigrationservice#Replication", + "traits": { + "smithy.api#documentation": "The replication that DMS stopped.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#StopReplicationTask": { "type": "operation", "input": { @@ -12537,6 +13842,47 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#TimestreamSettings": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Database name for the endpoint.
", + "smithy.api#required": {} + } + }, + "MemoryDuration": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "Set this attribute to specify the length of time to store all of the tables in memory \n that are migrated into Amazon Timestream from the source database. Time is measured in units \n of hours. When Timestream data comes in, it first resides in memory for the specified duration, \n which allows quick access to it.
", + "smithy.api#required": {} + } + }, + "MagneticDuration": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "Set this attribute to specify the default magnetic duration applied to the Amazon Timestream\n tables in days. This is the number of days that records remain in magnetic store \n before being discarded. For more information, see Storage in the\n Amazon Timestream Developer Guide.
", + "smithy.api#required": {} + } + }, + "CdcInsertsAndUpdates": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "Set this attribute to true to specify that DMS only\n applies inserts and updates, and not deletes. Amazon Timestream does not allow\n deleting records, so if this value is false, DMS nulls out\n the corresponding record in the Timestream database rather than deleting it.
Set this attribute to true to enable memory store writes.\n When this value is false, DMS does not write records that are older \n in days than the value specified in MagneticDuration, because Amazon Timestream does not\n allow memory writes by default. For more information, see Storage in the\n Amazon Timestream Developer Guide.
Provides information that defines an Amazon Timestream endpoint.
" + } + }, "com.amazonaws.databasemigrationservice#TlogAccessMode": { "type": "enum", "members": {