Module Smaws_Client_DatabaseMigrationService.Types

type nonrec string_ = string
type nonrec vpc_security_group_membership = {
  1. status : string_ option;
    (*

    The status of the VPC security group.

    *)
  2. vpc_security_group_id : string_ option;
    (*

    The VPC security group ID.

    *)
}

Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.

type nonrec vpc_security_group_membership_list = vpc_security_group_membership list
type nonrec vpc_security_group_id_list = string_ list
type nonrec version_status =
  1. | UNSUPPORTED
  2. | OUTDATED
  3. | UP_TO_DATE
type nonrec exception_message = string
type nonrec upgrade_dependency_failure_fault = {
  1. message : exception_message option;
}

An upgrade dependency is preventing the database migration.

type nonrec update_subscriptions_to_event_bridge_response = {
  1. result_ : string_ option;
    (*

    A string that indicates how many event subscriptions were migrated and how many remain to be migrated.

    *)
}
type nonrec boolean_optional = bool
type nonrec update_subscriptions_to_event_bridge_message = {
  1. force_move : boolean_optional option;
    (*

    When set to true, this operation migrates DMS subscriptions for Amazon SNS notifications no matter what your replication instance version is. If not set or set to false, this operation runs only when all your replication instances are from DMS version 3.4.5 or higher.

    *)
}
type nonrec invalid_resource_state_fault = {
  1. message : exception_message option;
}

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

type nonrec access_denied_fault = {
  1. message : exception_message option;
}

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

type nonrec tlog_access_mode =
  1. | TlogOnly
  2. | PreferTlog
  3. | PreferBackup
  4. | BackupOnly
type nonrec integer_optional = int
type nonrec timestream_settings = {
  1. enable_magnetic_store_writes : boolean_optional option;
    (*

    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.

    *)
  2. cdc_inserts_and_updates : boolean_optional option;
    (*

    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.

    *)
  3. magnetic_duration : integer_optional;
    (*

    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.

    *)
  4. memory_duration : integer_optional;
    (*

    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.

    *)
  5. database_name : string_;
    (*

    Database name for the endpoint.

    *)
}

Provides information that defines an Amazon Timestream endpoint.

type nonrec connection = {
  1. replication_instance_identifier : string_ option;
    (*

    The replication instance identifier. This parameter is stored as a lowercase string.

    *)
  2. endpoint_identifier : string_ option;
    (*

    The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

    *)
  3. last_failure_message : string_ option;
    (*

    The error message when the connection last failed.

    *)
  4. status : string_ option;
    (*

    The connection status. This parameter can return one of the following values:

    • "successful"
    • "testing"
    • "failed"
    • "deleting"
    *)
  5. endpoint_arn : string_ option;
    (*

    The ARN string that uniquely identifies the endpoint.

    *)
  6. replication_instance_arn : string_ option;
    (*

    The ARN of the replication instance.

    *)
}

Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

type nonrec test_connection_response = {
  1. connection : connection option;
    (*

    The connection tested.

    *)
}
type nonrec test_connection_message = {
  1. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
  2. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
}
type nonrec resource_quota_exceeded_fault = {
  1. message : exception_message option;
}

The quota for this resource quota has been exceeded.

type nonrec resource_not_found_fault = {
  1. message : exception_message option;
}

The resource could not be found.

type nonrec kms_key_not_accessible_fault = {
  1. message : exception_message option;
}

DMS cannot access the KMS key.

type nonrec target_db_type =
  1. | MULTIPLE_DATABASES
  2. | SPECIFIC_DATABASE
type nonrec table_preparation_mode =
  1. | DROP_TABLES_ON_TARGET
  2. | TRUNCATE
  3. | DO_NOTHING
type nonrec target_data_setting = {
  1. table_preparation_mode : table_preparation_mode option;
    (*

    This setting determines how DMS handles the target tables before starting a data migration, either by leaving them untouched, dropping and recreating them, or truncating the existing data in the target tables.

    *)
}

Defines settings for a target data provider for a data migration.

type nonrec target_data_settings = target_data_setting list
type nonrec tag = {
  1. resource_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.

    *)
  2. value : string_ option;
    (*

    A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

    *)
  3. key : string_ option;
    (*

    A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

    *)
}

A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

  • AddTagsToResource
  • ListTagsForResource
  • RemoveTagsFromResource
type nonrec tag_list = tag list
type nonrec table_to_reload = {
  1. table_name : string_;
    (*

    The table name of the table to be reloaded.

    *)
  2. schema_name : string_;
    (*

    The schema name of the table to be reloaded.

    *)
}

Provides the name of the schema and table to be reloaded.

type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec long_optional = Smaws_Lib.CoreTypes.Int64.t
type nonrec t_stamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec double_optional = float
type nonrec table_statistics = {
  1. resync_progress : double_optional option;
    (*

    Calculates the percentage of failed validations that were successfully resynced to the system.

    *)
  2. resync_rows_failed : long_optional option;
    (*

    Records the total number of mismatched data rows where fix attempts failed in the target database.

    *)
  3. resync_rows_succeeded : long_optional option;
    (*

    Records the total number of mismatched data rows where fixes were successfully applied in the target database.

    *)
  4. resync_rows_attempted : long_optional option;
    (*

    Records the total number of mismatched data rows where the system attempted to apply fixes in the target database.

    *)
  5. resync_state : string_ option;
    (*

    Records the current state of table resynchronization in the migration task.

    This parameter can have the following values:

    • Not enabled – Resync is not enabled for the table in the migration task.
    • Pending – The tables are waiting for resync.
    • In progress – Resync in progress for some records in the table.
    • No primary key – The table could not be resynced because it has no primary key.
    • Last resync at: date/time – Resync session is finished at time. Time provided in UTC format.
    *)
  6. validation_state_details : string_ option;
    (*

    Additional details about the state of validation.

    *)
  7. validation_state : string_ option;
    (*

    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.
    *)
  8. validation_suspended_records : long option;
    (*

    The number of records that couldn't be validated.

    *)
  9. validation_failed_records : long option;
    (*

    The number of records that failed validation.

    *)
  10. validation_pending_records : long option;
    (*

    The number of records that have yet to be validated.

    *)
  11. table_state : string_ option;
    (*

    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

    *)
  12. last_update_time : t_stamp option;
    (*

    The last time a table was updated.

    *)
  13. full_load_reloaded : boolean_optional option;
    (*

    A value that indicates if the table was reloaded (true) or loaded as part of a new full load operation (false).

    *)
  14. full_load_end_time : t_stamp option;
    (*

    The time when the full load operation completed.

    *)
  15. full_load_start_time : t_stamp option;
    (*

    The time when the full load operation started.

    *)
  16. full_load_error_rows : long option;
    (*

    The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).

    *)
  17. full_load_condtnl_chk_failed_rows : long option;
    (*

    The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).

    *)
  18. full_load_rows : long option;
    (*

    The number of rows added during the full load operation.

    *)
  19. applied_ddls : long_optional option;
    (*

    The number of data definition language (DDL) statements used to build and modify the structure of your tables applied on the target.

    *)
  20. applied_updates : long_optional option;
    (*

    The number of update actions applied on a target table.

    *)
  21. applied_deletes : long_optional option;
    (*

    The number of delete actions applied on a target table.

    *)
  22. applied_inserts : long_optional option;
    (*

    The number of insert actions applied on a target table.

    *)
  23. ddls : long option;
    (*

    The data definition language (DDL) used to build and modify the structure of your tables.

    *)
  24. updates : long option;
    (*

    The number of update actions performed on a table.

    *)
  25. deletes : long option;
    (*

    The number of delete actions performed on a table.

    *)
  26. inserts : long option;
    (*

    The number of insert actions performed on a table.

    *)
  27. table_name : string_ option;
    (*

    The name of the table.

    *)
  28. schema_name : string_ option;
    (*

    The schema name.

    *)
}

Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.

type nonrec table_statistics_list = table_statistics list
type nonrec table_list_to_reload = table_to_reload list
type nonrec secret_string = string
type nonrec sybase_settings = {
  1. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

    *)
  2. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  3. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  4. server_name : string_ option;
    (*

    Fully qualified domain name of the endpoint.

    *)
  5. port : integer_optional option;
    (*

    Endpoint TCP port. The default is 5000.

    *)
  6. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  7. database_name : string_ option;
    (*

    Database name for the endpoint.

    *)
}

Provides information that defines a SAP ASE endpoint.

type nonrec dms_ssl_mode_value =
  1. | VERIFY_FULL
  2. | VERIFY_CA
  3. | REQUIRE
  4. | NONE
type nonrec sybase_ase_data_provider_settings = {
  1. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  2. encrypt_password : boolean_optional option;
    (*

    Specifies whether to encrypt the password when connecting to the Sybase ASE database. When set to true, the connection password is encrypted during transmission. Default is true.

    *)
  3. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the SAP ASE data provider. The default value is none.

    *)
  4. database_name : string_ option;
    (*

    The database name on the SAP ASE data provider.

    *)
  5. port : integer_optional option;
    (*

    The port value for the SAP ASE data provider.

    *)
  6. server_name : string_ option;
    (*

    The name of the SAP ASE server.

    *)
}

Provides information that defines an SAP ASE data provider.

type nonrec boolean_ = bool
type nonrec replication_endpoint_type_value =
  1. | TARGET
  2. | SOURCE
type nonrec supported_endpoint_type = {
  1. engine_display_name : string_ option;
    (*

    The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

    *)
  2. replication_instance_engine_minimum_version : string_ option;
    (*

    The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.

    *)
  3. endpoint_type : replication_endpoint_type_value option;
    (*

    The type of endpoint. Valid values are source and target.

    *)
  4. supports_cd_c : boolean_ option;
    (*

    Indicates if change data capture (CDC) is supported.

    *)
  5. engine_name : string_ option;
    (*

    The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

    *)
}

Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

type nonrec supported_endpoint_type_list = supported_endpoint_type list
type nonrec availability_zone = {
  1. name : string_ option;
    (*

    The name of the Availability Zone.

    *)
}

The name of an Availability Zone for use during database migration. AvailabilityZone is an optional parameter to the CreateReplicationInstance operation, and it’s value relates to the Amazon Web Services Region of an endpoint. For example, the availability zone of an endpoint in the us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

type nonrec subnet = {
  1. subnet_status : string_ option;
    (*

    The status of the subnet.

    *)
  2. subnet_availability_zone : availability_zone option;
    (*

    The Availability Zone of the subnet.

    *)
  3. subnet_identifier : string_ option;
    (*

    The subnet identifier.

    *)
}

In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.

type nonrec subnet_list = subnet list
type nonrec subnet_identifier_list = string_ list
type nonrec subnet_already_in_use = {
  1. message : exception_message option;
}

The specified subnet is already in use.

type nonrec string_list = string_ list
type nonrec storage_quota_exceeded_fault = {
  1. message : exception_message option;
}

The storage quota has been exceeded.

type nonrec migration_type_value =
  1. | FULL_LOAD_AND_CDC
  2. | CDC
  3. | FULL_LOAD
type nonrec integer = int
type nonrec replication_task_stats = {
  1. full_load_finish_date : t_stamp option;
    (*

    The date the replication task full load was completed.

    *)
  2. full_load_start_date : t_stamp option;
    (*

    The date the replication task full load was started.

    *)
  3. stop_date : t_stamp option;
    (*

    The date the replication task was stopped.

    *)
  4. start_date : t_stamp option;
    (*

    The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.

    *)
  5. fresh_start_date : t_stamp option;
    (*

    The date the replication task was started either with a fresh start or a target reload.

    *)
  6. tables_errored : integer option;
    (*

    The number of errors that have occurred during this task.

    *)
  7. tables_queued : integer option;
    (*

    The number of tables queued for this task.

    *)
  8. tables_loading : integer option;
    (*

    The number of tables currently loading for this task.

    *)
  9. tables_loaded : integer option;
    (*

    The number of tables loaded for this task.

    *)
  10. elapsed_time_millis : long option;
    (*

    The elapsed time of the task, in milliseconds.

    *)
  11. full_load_progress_percent : integer option;
    (*

    The percent complete for the full load migration task.

    *)
}

In response to a request by the DescribeReplicationTasks operation, this object provides a collection of statistics about a replication task.

type nonrec replication_task = {
  1. target_replication_instance_arn : string_ option;
    (*

    The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

    *)
  2. task_data : string_ option;
    (*

    Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

    *)
  3. replication_task_stats : replication_task_stats option;
    (*

    The statistics for the task, including elapsed time, tables loaded, and table errors.

    *)
  4. replication_task_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
  5. recovery_checkpoint : string_ option;
    (*

    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.

    *)
  6. cdc_stop_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

    *)
  7. cdc_start_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

    The value can be in date, checkpoint, or LSN/SCN format.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

    *)
  8. replication_task_start_date : t_stamp option;
    (*

    The date the replication task is scheduled to start.

    *)
  9. replication_task_creation_date : t_stamp option;
    (*

    The date the replication task was created.

    *)
  10. stop_reason : string_ option;
    (*

    The reason the replication task was stopped. This response parameter can return one of the following values:

    • "Stop Reason NORMAL" – The task completed successfully with no additional information returned.
    • "Stop Reason RECOVERABLE_ERROR"
    • "Stop Reason FATAL_ERROR"
    • "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true.
    • "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"
    • "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"
    *)
  11. last_failure_message : string_ option;
    (*

    The last error (failure) message generated for the replication task.

    *)
  12. status : string_ option;
    (*

    The status of the replication task. This response parameter can return one of the following values:

    *)
  13. replication_task_settings : string_ option;
    (*

    The settings for the replication task.

    *)
  14. table_mappings : string_ option;
    (*

    Table mappings specified in the task.

    *)
  15. migration_type : migration_type_value option;
    (*

    The type of migration.

    *)
  16. replication_instance_arn : string_ option;
    (*

    The ARN of the replication instance.

    *)
  17. target_endpoint_arn : string_ option;
    (*

    The ARN that uniquely identifies the endpoint.

    *)
  18. source_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) that uniquely identifies the endpoint.

    *)
  19. replication_task_identifier : string_ option;
    (*

    The user-assigned replication task identifier or name.

    Constraints:

    • Must contain 1-255 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    *)
}

Provides information that describes a replication task created by the CreateReplicationTask operation.

type nonrec stop_replication_task_response = {
  1. replication_task : replication_task option;
    (*

    The replication task stopped.

    *)
}
type nonrec stop_replication_task_message = {
  1. replication_task_arn : string_;
    (*

    The Amazon Resource Name(ARN) of the replication task to be stopped.

    *)
}
type nonrec provision_data = {
  1. reason_for_new_provisioning_data : string_ option;
    (*

    A message describing the reason that DMS provisioned new resources for the serverless replication.

    *)
  2. date_new_provisioning_data_available : t_stamp option;
    (*

    The timestamp when provisioning became available.

    *)
  3. is_new_provisioning_available : boolean_ option;
    (*

    Whether the new provisioning is available to the replication.

    *)
  4. date_provisioned : t_stamp option;
    (*

    The timestamp when DMS provisioned replication resources.

    *)
  5. provisioned_capacity_units : integer option;
    (*

    The number of capacity units the replication is using.

    *)
  6. provision_state : string_ option;
    (*

    The current provisioning state

    *)
}

Information about provisioning resources for an DMS serverless replication.

type nonrec replication_task_assessment_run_progress = {
  1. individual_assessment_completed_count : integer option;
    (*

    The number of individual assessments that have completed, successfully or not.

    *)
  2. individual_assessment_count : integer option;
    (*

    The number of individual assessments that are specified to run.

    *)
}

The progress values reported by the AssessmentProgress response element.

type nonrec replication_task_assessment_run_result_statistic = {
  1. skipped : integer option;
    (*

    The number of individual assessments that were skipped during the assessment run.

    *)
  2. cancelled : integer option;
    (*

    The number of individual assessments that were cancelled during the assessment run.

    *)
  3. warning : integer option;
    (*

    Indicates that the recent completed AssessmentRun triggered a warning.

    *)
  4. error : integer option;
    (*

    The number of individual assessments that encountered a critical error and could not complete properly.

    *)
  5. failed : integer option;
    (*

    The number of individual assessments that failed to meet the criteria defined in the assessment run.

    *)
  6. passed : integer option;
    (*

    The number of individual assessments that successfully passed all checks in the assessment run.

    *)
}

The object containing the result statistics for a completed assessment run.

type nonrec premigration_assessment_status = {
  1. result_statistic : replication_task_assessment_run_result_statistic option;
  2. result_kms_key_arn : string_ option;
    (*

    The ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.

    *)
  3. result_encryption_mode : string_ option;
    (*

    The supported values are SSE_KMS and SSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects.

    *)
  4. result_location_folder : string_ option;
    (*

    The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.

    *)
  5. result_location_bucket : string_ option;
    (*

    The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.

    *)
  6. last_failure_message : string_ option;
    (*

    The last message generated by an individual assessment failure.

    *)
  7. assessment_progress : replication_task_assessment_run_progress option;
  8. premigration_assessment_run_creation_date : t_stamp option;
    (*

    The date which the assessment run was created.

    *)
  9. status : string_ option;
    (*

    This describes the assessment run status. The status can be one of the following values:

    • cancelling: The assessment run was canceled.
    • deleting: The assessment run was deleted.
    • failed: At least one individual assessment completed with a failed status.
    • error-provisioning: An internal error occurred while resources were provisioned (during the provisioning status).
    • error-executing An internal error occurred while individual assessments ran (during the running status).
    • invalid state: The assessment run is in an unknown state.
    • passed: All individual assessments have completed and none have a failed status.
    • provisioning: The resources required to run individual assessments are being provisioned.
    • running: Individual assessments are being run.
    • starting: The assessment run is starting, but resources are not yet being provisioned for individual assessments.
    • warning: At least one individual assessment completed with a warning status.
    *)
  10. fail_on_assessment_failure : boolean_ option;
    (*

    A configurable setting you can set to true (the defualt setting) or false. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.

    *)
  11. premigration_assessment_run_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of this assessment run.

    *)
}

The results returned in describe-replications to display the results of the premigration assessment from the replication configuration.

type nonrec premigration_assessment_status_list = premigration_assessment_status list
type nonrec replication_stats = {
  1. full_load_finish_date : t_stamp option;
    (*

    The date the replication full load was finished.

    *)
  2. full_load_start_date : t_stamp option;
    (*

    The date the replication full load was started.

    *)
  3. stop_date : t_stamp option;
    (*

    The date the replication was stopped.

    *)
  4. start_date : t_stamp option;
    (*

    The date the replication is scheduled to start.

    *)
  5. fresh_start_date : t_stamp option;
    (*

    The date the replication was started either with a fresh start or a target reload.

    *)
  6. tables_errored : integer option;
    (*

    The number of errors that have occured for this replication.

    *)
  7. tables_queued : integer option;
    (*

    The number of tables queued for this replication.

    *)
  8. tables_loading : integer option;
    (*

    The number of tables currently loading for this replication.

    *)
  9. tables_loaded : integer option;
    (*

    The number of tables loaded for this replication.

    *)
  10. elapsed_time_millis : long option;
    (*

    The elapsed time of the replication, in milliseconds.

    *)
  11. full_load_progress_percent : integer option;
    (*

    The percent complete for the full load serverless replication.

    *)
}

This object provides a collection of statistics about a serverless replication.

type nonrec replication = {
  1. is_read_only : boolean_optional option;
    (*

    Indicates whether the serverless replication is read-only. When set to true, this replication is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only replications through their associated zero-ETL integration.

    *)
  2. replication_deprovision_time : t_stamp option;
    (*

    The timestamp when DMS will deprovision the replication.

    *)
  3. replication_last_stop_time : t_stamp option;
    (*

    The timestamp when replication was last stopped.

    *)
  4. replication_update_time : t_stamp option;
    (*

    The time the serverless replication was updated.

    *)
  5. replication_create_time : t_stamp option;
    (*

    The time the serverless replication was created.

    *)
  6. recovery_checkpoint : string_ option;
    (*

    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.

    *)
  7. cdc_stop_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    *)
  8. cdc_start_position : string_ option;
    (*

    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.

    *)
  9. cdc_start_time : t_stamp option;
    (*

    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.

    *)
  10. start_replication_type : string_ option;
    (*

    The type of replication to start.

    *)
  11. replication_stats : replication_stats option;
    (*

    This object provides a collection of statistics about a serverless replication.

    *)
  12. failure_messages : string_list option;
    (*

    Error and other information about why a serverless replication failed.

    *)
  13. stop_reason : string_ option;
    (*

    The reason the replication task was stopped. This response parameter can return one of the following values:

    • "Stop Reason NORMAL"
    • "Stop Reason RECOVERABLE_ERROR"
    • "Stop Reason FATAL_ERROR"
    • "Stop Reason FULL_LOAD_ONLY_FINISHED"
    • "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"
    • "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"
    *)
  14. premigration_assessment_statuses : premigration_assessment_status_list option;
    (*

    The status output of premigration assessment in describe-replications.

    *)
  15. provision_data : provision_data option;
    (*

    Information about provisioning resources for an DMS serverless replication.

    *)
  16. status : string_ option;
    (*

    The current status of the serverless replication.

    *)
  17. replication_type : migration_type_value option;
    (*

    The type of the serverless replication.

    *)
  18. target_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.

    *)
  19. source_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.

    *)
  20. replication_config_arn : string_ option;
    (*

    The Amazon Resource Name for the ReplicationConfig associated with the replication.

    *)
  21. replication_config_identifier : string_ option;
    (*

    The identifier for the ReplicationConfig associated with the replication.

    *)
}

Provides information that describes a serverless replication created by the CreateReplication operation.

type nonrec stop_replication_response = {
  1. replication : replication option;
    (*

    The replication that DMS stopped.

    *)
}
type nonrec stop_replication_message = {
  1. replication_config_arn : string_;
    (*

    The Amazon Resource Name of the replication to stop.

    *)
}
type nonrec iso8601_date_time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec data_migration_settings = {
  1. selection_rules : secret_string option;
    (*

    A JSON-formatted string that defines what objects to include and exclude from the migration.

    *)
  2. cloudwatch_logs_enabled : boolean_optional option;
    (*

    Whether to enable CloudWatch logging for the data migration.

    *)
  3. number_of_jobs : integer_optional option;
    (*

    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

    *)
}

Options for configuring a data migration, including whether to enable CloudWatch logs, and the selection rules to use to include or exclude database objects from the migration.

type nonrec source_data_setting = {
  1. slot_name : string_ option;
    (*

    The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.

    *)
  2. cdc_stop_time : iso8601_date_time option;
    (*

    The change data capture (CDC) stop time for the source data provider.

    *)
  3. cdc_start_time : iso8601_date_time option;
    (*

    The change data capture (CDC) start time for the source data provider.

    *)
  4. cdc_start_position : string_ option;
    (*

    The change data capture (CDC) start position for the source data provider.

    *)
}

Defines settings for a source data provider for a data migration.

type nonrec source_data_settings = source_data_setting list
type nonrec data_migration_statistics = {
  1. stop_time : iso8601_date_time option;
    (*

    The time when the migration stopped or failed.

    *)
  2. start_time : iso8601_date_time option;
    (*

    The time when the migration started.

    *)
  3. tables_errored : integer option;
    (*

    The number of tables that DMS failed to process.

    *)
  4. tables_queued : integer option;
    (*

    The number of tables that are waiting for processing.

    *)
  5. cdc_latency : integer option;
    (*

    The current latency of the change data capture (CDC) operation.

    *)
  6. full_load_percentage : integer option;
    (*

    The data migration's progress in the full-load migration phase.

    *)
  7. tables_loading : integer option;
    (*

    The data migration's table loading progress.

    *)
  8. elapsed_time_millis : long option;
    (*

    The elapsed duration of the data migration run.

    *)
  9. tables_loaded : integer option;
    (*

    The number of tables loaded in the current data migration run.

    *)
}

Information about the data migration run, including start and stop time, latency, and migration progress.

type nonrec public_ip_address_list = string_ list
type nonrec data_migration_cidr_block = string_ list
type nonrec data_migration = {
  1. stop_reason : string_ option;
    (*

    The reason the data migration last stopped.

    *)
  2. last_failure_message : string_ option;
    (*

    Information about the data migration's most recent error or failure.

    *)
  3. data_migration_cidr_blocks : data_migration_cidr_block option;
    (*

    The CIDR blocks of the endpoints for the data migration.

    *)
  4. public_ip_addresses : public_ip_address_list option;
    (*

    The IP addresses of the endpoints for the data migration.

    *)
  5. data_migration_status : string_ option;
    (*

    The current status of the data migration.

    *)
  6. data_migration_statistics : data_migration_statistics option;
    (*

    Provides information about the data migration's run, including start and stop time, latency, and data migration progress.

    *)
  7. target_data_settings : target_data_settings option;
    (*

    Specifies information about the data migration's target data provider.

    *)
  8. source_data_settings : source_data_settings option;
    (*

    Specifies information about the data migration's source data provider.

    *)
  9. data_migration_settings : data_migration_settings option;
    (*

    Specifies CloudWatch settings and selection rules for the data migration.

    *)
  10. data_migration_type : migration_type_value option;
    (*

    Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

    *)
  11. migration_project_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the data migration's associated migration project.

    *)
  12. service_access_role_arn : string_ option;
    (*

    The IAM role that the data migration uses to access Amazon Web Services resources.

    *)
  13. data_migration_end_time : iso8601_date_time option;
    (*

    The UTC time when data migration ended.

    *)
  14. data_migration_start_time : iso8601_date_time option;
    (*

    The UTC time when DMS started the data migration.

    *)
  15. data_migration_create_time : iso8601_date_time option;
    (*

    The UTC time when DMS created the data migration.

    *)
  16. data_migration_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) that identifies this replication.

    *)
  17. data_migration_name : string_ option;
    (*

    The user-friendly name for the data migration.

    *)
}

This object provides information about a DMS data migration.

type nonrec stop_data_migration_response = {
  1. data_migration : data_migration option;
    (*

    The data migration that DMS stopped.

    *)
}
type nonrec stop_data_migration_message = {
  1. data_migration_identifier : string_;
    (*

    The identifier (name or ARN) of the data migration to stop.

    *)
}
type nonrec failed_dependency_fault = {
  1. message : exception_message option;
}

A dependency threw an exception.

type nonrec statement_properties = {
  1. definition : string_;
    (*

    The SQL text of the statement.

    *)
}

The properties of the statement for metadata model creation.

type nonrec start_replication_task_type_value =
  1. | RELOAD_TARGET
  2. | RESUME_PROCESSING
  3. | START_REPLICATION
type nonrec start_replication_task_response = {
  1. replication_task : replication_task option;
    (*

    The replication task started.

    *)
}
type nonrec start_replication_task_message = {
  1. cdc_stop_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

    *)
  2. cdc_start_position : string_ option;
    (*

    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.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    *)
  3. cdc_start_time : t_stamp option;
    (*

    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.

    Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

    *)
  4. start_replication_task_type : start_replication_task_type_value;
    (*

    The type of replication task to start.

    start-replication is the only valid action that can be used for the first time a task with the migration type of full-loadfull-load, full-load-and-cdc or cdc is run. Any other action used for the first time on a given task, such as resume-processing and reload-target will result in data errors.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    For a full-load task, the resume-processing option will reload any tables that were partially loaded or not yet loaded during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    For a cdc only task, to start from a specific position, you must use start-replication and also specify the start position. Check the source endpoint DMS documentation for any limitations. For example, not all sources support starting from a time.

    resume-processing is only available for previously executed tasks.

    *)
  5. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication task to be started.

    *)
}
type nonrec replication_task_assessment_run = {
  1. result_statistic : replication_task_assessment_run_result_statistic option;
    (*

    Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

    *)
  2. is_latest_task_assessment_run : boolean_ option;
    (*

    Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

    *)
  3. assessment_run_name : string_ option;
    (*

    Unique name of the assessment run.

    *)
  4. result_kms_key_arn : string_ option;
    (*

    ARN of the KMS encryption key used to encrypt the assessment run results.

    *)
  5. result_encryption_mode : string_ option;
    (*

    Encryption mode used to encrypt the assessment run results.

    *)
  6. result_location_folder : string_ option;
    (*

    Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

    *)
  7. result_location_bucket : string_ option;
    (*

    Amazon S3 bucket where DMS stores the results of this assessment run.

    *)
  8. service_access_role_arn : string_ option;
    (*

    ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

    *)
  9. last_failure_message : string_ option;
    (*

    Last message generated by an individual assessment failure.

    *)
  10. assessment_progress : replication_task_assessment_run_progress option;
    (*

    Indication of the completion progress for the individual assessments specified to run.

    *)
  11. replication_task_assessment_run_creation_date : t_stamp option;
    (*

    Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

    *)
  12. status : string_ option;
    (*

    Assessment run status.

    This status can have one of the following values:

    • "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
    • "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
    • "failed" – At least one individual assessment completed with a failed status.
    • "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
    • "error-executing" – An internal error occurred while individual assessments ran (during running status).
    • "invalid state" – The assessment run is in an unknown state.
    • "passed" – All individual assessments have completed, and none has a failed status.
    • "provisioning" – Resources required to run individual assessments are being provisioned.
    • "running" – Individual assessments are being run.
    • "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
    • "warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).
    *)
  13. replication_task_arn : string_ option;
    (*

    ARN of the migration task associated with this premigration assessment run.

    *)
  14. replication_task_assessment_run_arn : string_ option;
    (*

    Amazon Resource Name (ARN) of this assessment run.

    *)
}

Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.

Some of the information appears based on other operations that can return the ReplicationTaskAssessmentRun object.

type nonrec start_replication_task_assessment_run_response = {
  1. replication_task_assessment_run : replication_task_assessment_run option;
    (*

    The premigration assessment run that was started.

    *)
}
type nonrec include_test_list = string_ list
type nonrec exclude_test_list = string_ list
type nonrec start_replication_task_assessment_run_message = {
  1. tags : tag_list option;
    (*

    One or more tags to be assigned to the premigration assessment run that you want to start.

    *)
  2. exclude : exclude_test_list option;
    (*

    Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

    You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation.

    To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

    *)
  3. include_only : include_test_list option;
    (*

    Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

    You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation.

    To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

    *)
  4. assessment_run_name : string_;
    (*

    Unique name to identify the assessment run.

    *)
  5. result_kms_key_arn : string_ option;
    (*

    ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

    *)
  6. result_encryption_mode : string_ option;
    (*

    Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

    • "SSE_S3" – The server-side encryption provided as a default by Amazon S3.
    • "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
    *)
  7. result_location_folder : string_ option;
    (*

    Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

    *)
  8. result_location_bucket : string_;
    (*

    Amazon S3 bucket where you want DMS to store the results of this assessment run.

    *)
  9. service_access_role_arn : string_;
    (*

    ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

    *)
  10. replication_task_arn : string_;
    (*

    Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

    *)
}
type nonrec s3_resource_not_found_fault = {
  1. message : exception_message option;
}

A specified Amazon S3 bucket, bucket folder, or other object can't be found.

type nonrec s3_access_denied_fault = {
  1. message : exception_message option;
}

Insufficient privileges are preventing access to an Amazon S3 object.

type nonrec resource_arn = string
type nonrec resource_already_exists_fault = {
  1. resource_arn : resource_arn option;
  2. message : exception_message option;
}

The resource you are attempting to create already exists.

type nonrec kms_not_found_fault = {
  1. message : exception_message option;
}

The specified KMS entity or resource can't be found.

type nonrec kms_invalid_state_fault = {
  1. message : exception_message option;
}

The state of the specified KMS resource isn't valid for this request.

type nonrec kms_fault = {
  1. message : exception_message option;
}

An Key Management Service (KMS) error is preventing access to KMS.

type nonrec kms_disabled_fault = {
  1. message : exception_message option;
}

The specified KMS key isn't enabled.

type nonrec kms_access_denied_fault = {
  1. message : exception_message option;
}

The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.

type nonrec start_replication_task_assessment_response = {
  1. replication_task : replication_task option;
    (*

    The assessed replication task.

    *)
}
type nonrec start_replication_task_assessment_message = {
  1. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
}
type nonrec start_replication_response = {
  1. replication : replication option;
    (*

    The replication that DMS started.

    *)
}
type nonrec start_replication_migration_type_value =
  1. | START_REPLICATION
  2. | RESUME_PROCESSING
  3. | RELOAD_TARGET
type nonrec start_replication_message = {
  1. cdc_stop_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    *)
  2. cdc_start_position : string_ option;
    (*

    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.

    *)
  3. cdc_start_time : t_stamp option;
    (*

    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.

    *)
  4. premigration_assessment_settings : string_ option;
    (*

    User-defined settings for the premigration assessment. The possible values are:

    • ResultLocationFolder: The folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
    • ResultEncryptionMode: The supported values are SSE_KMS and SSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects.
    • ResultKmsKeyArn: The ARN of a customer KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.
    • IncludeOnly: A space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration.
    • Exclude: A space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration.
    • FailOnAssessmentFailure: A configurable setting you can set to true (the default setting) or false. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.
    *)
  5. start_replication_type : string_;
    (*

    The replication type.

    When the replication type is full-load or full-load-and-cdc, the only valid value for the first run of the replication is start-replication. This option will start the replication.

    You can also use ReloadTables to reload specific tables that failed during replication instead of restarting the replication.

    The resume-processing option isn't applicable for a full-load replication, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc replication, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    *)
  6. replication_config_arn : string_;
    (*

    The Amazon Resource Name of the replication for which to start replication.

    *)
}
type nonrec recommendation_settings = {
  1. workload_type : string_;
    (*

    The deployment option for your target engine. For production databases, Fleet Advisor chooses Multi-AZ deployment. For development or test databases, Fleet Advisor chooses Single-AZ deployment. Valid values include "development" and "production".

    *)
  2. instance_sizing_type : string_;
    (*

    The size of your target instance. Fleet Advisor calculates this value based on your data collection type, such as total capacity and resource utilization. Valid values include "total-capacity" and "utilization".

    *)
}

Provides information about the required target engine settings.

type nonrec start_recommendations_request_entry = {
  1. settings : recommendation_settings;
    (*

    The required target engine settings.

    *)
  2. database_id : string_;
    (*

    The identifier of the source database.

    *)
}

Provides information about the source database to analyze and provide target recommendations according to the specified requirements.

type nonrec start_recommendations_request_entry_list = start_recommendations_request_entry list
type nonrec start_recommendations_request = {
  1. settings : recommendation_settings;
    (*

    The settings in JSON format that Fleet Advisor uses to determine target engine recommendations. These parameters include target instance sizing and availability and durability settings. For target instance sizing, Fleet Advisor supports the following two options: total capacity and resource utilization. For availability and durability, Fleet Advisor supports the following two options: production (Multi-AZ deployments) and Dev/Test (Single-AZ deployments).

    *)
  2. database_id : string_;
    (*

    The identifier of the source database to analyze and provide recommendations for.

    *)
}
type nonrec start_metadata_model_import_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the import operation.

    *)
}
type nonrec migration_project_identifier = string
type nonrec origin_type_value =
  1. | TARGET
  2. | SOURCE
type nonrec start_metadata_model_import_message = {
  1. refresh : boolean_ option;
    (*

    If true, DMS loads metadata for the specified objects from the source database.

    *)
  2. origin : origin_type_value;
    (*

    Whether to load metadata to the source or target database.

    *)
  3. selection_rules : string_;
    (*

    A value that specifies the database objects to import.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_metadata_model_export_to_target_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the export operation.

    *)
}
type nonrec start_metadata_model_export_to_target_message = {
  1. overwrite_extension_pack : boolean_optional option;
    (*

    Whether to overwrite the migration project extension pack. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.

    *)
  2. selection_rules : string_;
    (*

    A value that specifies the database objects to export.

    *)
  3. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_metadata_model_export_as_script_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the export operation.

    *)
}
type nonrec start_metadata_model_export_as_script_message = {
  1. file_name : string_ option;
    (*

    The name of the model file to create in the Amazon S3 bucket.

    *)
  2. origin : origin_type_value;
    (*

    Whether to export the metadata model from the source or the target.

    *)
  3. selection_rules : string_;
    (*

    A value that specifies the database objects to export.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_metadata_model_creation_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the metadata model creation operation.

    *)
}
type nonrec metadata_model_properties =
  1. | StatementProperties of statement_properties
    (*

    The properties of the statement.

    *)

The properties of metadata model in JSON format. This object is a Union. Only one member of this object can be specified or returned.

type nonrec start_metadata_model_creation_message = {
  1. properties : metadata_model_properties;
    (*

    The properties of metadata model in JSON format. This object is a Union. Only one member of this object can be specified or returned.

    *)
  2. metadata_model_name : string_;
    (*

    The name of the metadata model.

    *)
  3. selection_rules : string_;
    (*

    The JSON string that specifies the location where the metadata model will be created. Selection rules must specify a single schema. For more information, see Selection Rules in the DMS User Guide.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_metadata_model_conversion_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the conversion operation.

    *)
}
type nonrec start_metadata_model_conversion_message = {
  1. selection_rules : string_;
    (*

    A value that specifies the database objects to convert.

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_metadata_model_assessment_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the assessment operation.

    *)
}
type nonrec start_metadata_model_assessment_message = {
  1. selection_rules : string_;
    (*

    A value that specifies the database objects to assess.

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_extension_pack_association_response = {
  1. request_identifier : string_ option;
    (*

    The identifier for the request operation.

    *)
}
type nonrec start_extension_pack_association_message = {
  1. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec start_data_migration_response = {
  1. data_migration : data_migration option;
    (*

    The data migration that DMS started.

    *)
}
type nonrec start_data_migration_message = {
  1. start_type : start_replication_migration_type_value;
    (*

    Specifies the start type for the data migration. Valid values include start-replication, reload-target, and resume-processing.

    *)
  2. data_migration_identifier : string_;
    (*

    The identifier (name or ARN) of the data migration to start.

    *)
}
type nonrec invalid_operation_fault = {
  1. message : exception_message option;
}

The action or operation requested isn't valid.

type nonrec ssl_security_protocol_value =
  1. | SSL_ENCRYPTION
  2. | PLAINTEXT
type nonrec sql_server_authentication_method =
  1. | Kerberos
  2. | Password
type nonrec source_type =
  1. | Replication_instance
type nonrec source_ids_list = string_ list
type nonrec server_short_info_response = {
  1. server_name : string_ option;
    (*

    The name address of a server in a Fleet Advisor collector inventory.

    *)
  2. ip_address : string_ option;
    (*

    The IP address of a server in a Fleet Advisor collector inventory.

    *)
  3. server_id : string_ option;
    (*

    The ID of a server in a Fleet Advisor collector inventory.

    *)
}

Describes a server in a Fleet Advisor collector inventory.

type nonrec schema_short_info_response = {
  1. database_ip_address : string_ option;
    (*

    The IP address of a database in a Fleet Advisor collector inventory.

    *)
  2. database_name : string_ option;
    (*

    The name of a database in a Fleet Advisor collector inventory.

    *)
  3. database_id : string_ option;
    (*

    The ID of a database in a Fleet Advisor collector inventory.

    *)
  4. schema_name : string_ option;
    (*

    The name of a schema in a Fleet Advisor collector inventory.

    *)
  5. schema_id : string_ option;
    (*

    The ID of a schema in a Fleet Advisor collector inventory.

    *)
}

Describes a schema in a Fleet Advisor collector inventory.

type nonrec database_short_info_response = {
  1. database_engine : string_ option;
    (*

    The database engine of a database in a Fleet Advisor collector inventory, for example PostgreSQL.

    *)
  2. database_ip_address : string_ option;
    (*

    The IP address of a database in a Fleet Advisor collector inventory.

    *)
  3. database_name : string_ option;
    (*

    The name of a database in a Fleet Advisor collector inventory.

    *)
  4. database_id : string_ option;
    (*

    The ID of a database in a Fleet Advisor collector inventory.

    *)
}

Describes a database in a Fleet Advisor collector inventory.

type nonrec schema_response = {
  1. similarity : double_optional option;
    (*

    The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value indicates that a schema is likely to be a duplicate.

    *)
  2. original_schema : schema_short_info_response option;
  3. schema_name : string_ option;
    (*

    The name of a schema in a Fleet Advisor collector inventory.

    *)
  4. schema_id : string_ option;
    (*

    The ID of a schema in a Fleet Advisor collector inventory.

    *)
  5. database_instance : database_short_info_response option;
    (*

    The database for a schema in a Fleet Advisor collector inventory.

    *)
  6. server : server_short_info_response option;
    (*

    The database server for a schema in a Fleet Advisor collector inventory.

    *)
  7. complexity : string_ option;
    (*

    The complexity level of the code in a schema in a Fleet Advisor collector inventory.

    *)
  8. code_size : long_optional option;
    (*

    The size level of the code in a schema in a Fleet Advisor collector inventory.

    *)
  9. code_line_count : long_optional option;
    (*

    The number of lines of code in a schema in a Fleet Advisor collector inventory.

    *)
}

Describes a schema in a Fleet Advisor collector inventory.

type nonrec schema_list = string_ list
type nonrec default_error_details = {
  1. message : string_ option;
    (*

    The error message.

    *)
}

Provides error information about a schema conversion operation.

type nonrec error_details =
  1. | DefaultErrorDetails of default_error_details
    (*

    Error information about a project.

    *)

Provides error information about a project.

type nonrec export_sql_details = {
  1. object_ur_l : string_ option;
    (*

    The URL for the object containing the exported metadata model assessment.

    *)
  2. s3_object_key : string_ option;
    (*

    The Amazon S3 object key for the object containing the exported metadata model assessment.

    *)
}

Provides information about a metadata model assessment exported to SQL.

type nonrec processed_object = {
  1. endpoint_type : string_ option;
    (*

    The type of the data provider. This parameter can store one of the following values: "SOURCE" or "TARGET".

    *)
  2. type_ : string_ option;
    (*

    The type of the database object. For example, a table, view, procedure, and so on.

    *)
  3. name : string_ option;
    (*

    The name of the database object.

    *)
}

The database object that the schema conversion operation currently uses.

type nonrec progress = {
  1. processed_object : processed_object option;
    (*

    The name of the database object that the schema conversion operation currently uses.

    *)
  2. progress_step : string_ option;
    (*

    The step of the schema conversion operation. This parameter can store one of the following values:

    • IN_PROGRESS – The operation is running.
    • LOADING_METADATA – Loads metadata from the source database.
    • COUNTING_OBJECTS – Determines the number of objects involved in the operation.
    • ANALYZING – Analyzes the source database objects.
    • CONVERTING – Converts the source database objects to a format compatible with the target database.
    • APPLYING – Applies the converted code to the target database.
    • FINISHED – The operation completed successfully.
    *)
  3. total_objects : long option;
    (*

    The number of objects in this schema conversion operation.

    *)
  4. progress_percent : double_optional option;
    (*

    The percent complete for the current step of the schema conversion operation.

    *)
}

Provides information about the progress of the schema conversion operation.

type nonrec schema_conversion_request = {
  1. progress : progress option;
  2. export_sql_details : export_sql_details option;
  3. error : error_details option;
  4. migration_project_arn : string_ option;
    (*

    The migration project ARN.

    *)
  5. request_identifier : string_ option;
    (*

    The identifier for the schema conversion action.

    *)
  6. status : string_ option;
    (*

    The schema conversion action status.

    *)
}

Provides information about a schema conversion action.

type nonrec schema_conversion_request_list = schema_conversion_request list
type nonrec safeguard_policy =
  1. | SHARED_AUTOMATIC_TRUNCATION
  2. | EXCLUSIVE_AUTOMATIC_TRUNCATION
  3. | RELY_ON_SQL_SERVER_REPLICATION_AGENT
type nonrec sns_no_authorization_fault = {
  1. message : exception_message option;
}

You are not authorized for the SNS subscription.

type nonrec sns_invalid_topic_fault = {
  1. message : exception_message option;
}

The SNS topic is invalid.

type nonrec sc_application_attributes = {
  1. s3_bucket_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_bucket_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for exporting assessment reports.

    *)
}

Provides information that defines a schema conversion application.

type nonrec compression_type_value =
  1. | GZIP
  2. | NONE
type nonrec encryption_mode_value =
  1. | SSE_KMS
  2. | SSE_S3
type nonrec data_format_value =
  1. | PARQUET
  2. | CSV
type nonrec encoding_type_value =
  1. | RLE_DICTIONARY
  2. | PLAIN_DICTIONARY
  3. | PLAIN
type nonrec parquet_version_value =
  1. | PARQUET_2_0
  2. | PARQUET_1_0
type nonrec date_partition_sequence_value =
  1. | DDMMYYYY
  2. | MMYYYYDD
  3. | YYYYMM
  4. | YYYYMMDDHH
  5. | YYYYMMDD
type nonrec date_partition_delimiter_value =
  1. | NONE
  2. | DASH
  3. | UNDERSCORE
  4. | SLASH
type nonrec canned_acl_for_objects_value =
  1. | BUCKET_OWNER_FULL_CONTROL
  2. | BUCKET_OWNER_READ
  3. | AWS_EXEC_READ
  4. | AUTHENTICATED_READ
  5. | PUBLIC_READ_WRITE
  6. | PUBLIC_READ
  7. | PRIVATE
  8. | NONE
type nonrec s3_settings = {
  1. glue_catalog_generation : boolean_optional option;
    (*

    When true, allows Glue to catalog your S3 bucket. Creating an Glue catalog lets you use Athena to query your data.

    *)
  2. expected_bucket_owner : string_ option;
    (*

    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.

    Example:

    --s3-settings='\{"ExpectedBucketOwner": "{i AWS_Account_ID}"\}'

    When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter.

    *)
  3. add_trailing_padding_character : boolean_optional option;
    (*

    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.

    *)
  4. date_partition_timezone : string_ option;
    (*

    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The time zone format is Area/Location. Use this parameter when DatePartitionedEnabled is set to true, as shown in the following example:

    s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":"Asia/Seoul", "BucketName": "dms-nattarat-test"}'

    *)
  5. rfc4180 : boolean_optional option;
    (*

    For an S3 source, when this value is set to true or y, each leading double quotation mark has to be followed by an ending double quotation mark. This formatting complies with RFC 4180. When this value is set to false or n, string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.

    For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to true or y using Amazon S3 as a target, if the data has quotation marks or newline characters in it, DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.

    The default value is true. Valid values include true, false, y, and n.

    *)
  6. max_file_size : integer_optional option;
    (*

    A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.

    The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.

    *)
  7. ignore_header_rows : integer_optional option;
    (*

    When this value is set to 1, DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.

    The default is 0.

    *)
  8. csv_null_value : string_ option;
    (*

    An optional parameter that specifies how DMS treats null values. While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), DMS treats the empty string as the null value instead of NULL.

    The default value is NULL. Valid values include any valid string.

    *)
  9. cdc_min_file_size : integer_optional option;
    (*

    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.

    When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.

    The default value is 32 MB.

    *)
  10. cdc_max_batch_interval : integer_optional option;
    (*

    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.

    When CdcMaxBatchInterval and CdcMinFileSize are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.

    The default value is 60 seconds.

    *)
  11. add_column_name : boolean_optional option;
    (*

    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.

    The default value is false. Valid values are true, false, y, and n.

    *)
  12. canned_acl_for_objects : canned_acl_for_objects_value option;
    (*

    A value that enables DMS to specify a predefined (canned) access control list for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 Developer Guide.

    The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.

    *)
  13. use_task_start_time_for_full_load_timestamp : boolean_optional option;
    (*

    When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp is set to true, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.

    When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target.

    *)
  14. cdc_path : string_ option;
    (*

    Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set, DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set PreserveTransactions to true, DMS verifies that you have set this parameter to a folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by BucketFolder and BucketName.

    For example, if you specify CdcPath as MyChangedData, and you specify BucketName as MyTargetBucket but do not specify BucketFolder, DMS creates the CDC folder path following: MyTargetBucket/MyChangedData.

    If you specify the same CdcPath, and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData, DMS creates the CDC folder path following: MyTargetBucket/MyTargetData/MyChangedData.

    For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target.

    This setting is supported in DMS versions 3.4.2 and later.

    *)
  15. preserve_transactions : boolean_optional option;
    (*

    If set to true, DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath. For more information, see Capturing data changes (CDC) including transaction order on the S3 target.

    This setting is supported in DMS versions 3.4.2 and later.

    *)
  16. csv_no_sup_value : string_ option;
    (*

    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want DMS to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.

    This setting is supported in DMS versions 3.4.1 and later.

    *)
  17. use_csv_no_sup_value : boolean_optional option;
    (*

    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to true for columns not included in the supplemental log, DMS uses the value specified by CsvNoSupValue. If not set or set to false, DMS uses the null value for these columns.

    This setting is supported in DMS versions 3.4.1 and later.

    *)
  18. date_partition_delimiter : date_partition_delimiter_value option;
    (*

    Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.

    *)
  19. date_partition_sequence : date_partition_sequence_value option;
    (*

    Identifies the sequence of the date format to use during folder partitioning. The default value is YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.

    *)
  20. date_partition_enabled : boolean_optional option;
    (*

    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false. For more information about date-based folder partitioning, see Using date-based folder partitioning.

    *)
  21. cdc_inserts_and_updates : boolean_optional option;
    (*

    A value that enables a change data capture (CDC) load to write INSERT and UPDATE 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.

    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 operations at the source. But if IncludeOpForFullLoad is set to false, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..

    DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later.

    CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.

    *)
  22. parquet_timestamp_in_millisecond : boolean_optional option;
    (*

    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.

    DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.

    When ParquetTimestampInMillisecond is set to true or y, DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.

    Currently, Amazon Athena and Glue can handle only millisecond precision for TIMESTAMP values. Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.

    DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision.

    Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.

    *)
  23. timestamp_column_name : string_ option;
    (*

    A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.

    DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

    DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data when you set TimestampColumnName to a nonblank value.

    For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.

    For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.

    The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.

    When the AddColumnName parameter is set to true, DMS also includes a name for the timestamp column that you set with TimestampColumnName.

    *)
  24. cdc_inserts_only : boolean_optional option;
    (*

    A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.

    If CdcInsertsOnly is set to true or y, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of IncludeOpForFullLoad. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is set to false, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..

    DMS supports the interaction described preceding between the CdcInsertsOnly and IncludeOpForFullLoad parameters in versions 3.1.4 and later.

    CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.

    *)
  25. include_op_for_full_load : boolean_optional option;
    (*

    A value that enables a full load to write INSERT operations to the comma-separated value (.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 the rows were inserted at the source database. If IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.

    This setting works together with the CdcInsertsOnly and the CdcInsertsAndUpdates parameters for output to .csv files only. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..

    *)
  26. enable_statistics : boolean_optional option;
    (*

    A value that enables statistics for Parquet pages and row groups. Choose true to enable statistics, false to disable. Statistics include NULL, DISTINCT, MAX, and MIN values. This parameter defaults to true. This value is used for .parquet file format only.

    *)
  27. parquet_version : parquet_version_value option;
    (*

    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.

    *)
  28. data_page_size : integer_optional option;
    (*

    The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.

    *)
  29. row_group_length : integer_optional option;
    (*

    The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.

    If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

    *)
  30. dict_page_size_limit : integer_optional option;
    (*

    The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for .parquet file format only.

    *)
  31. encoding_type : encoding_type_value option;
    (*

    The type of encoding you are using:

    • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.
    • PLAIN doesn't use encoding at all. Values are stored as they are.
    • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
    *)
  32. data_format : data_format_value option;
    (*

    The format of the data that you want to use for output. You can choose one of the following:

    • csv : This is a row-based file format with comma-separated values (.csv).
    • parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.
    *)
  33. server_side_encryption_kms_key_id : string_ option;
    (*

    If you are using SSE_KMS for the EncryptionMode, provide the KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management (IAM) user permissions and allows use of the key.

    Here is a CLI example:

    aws dms create-endpoint --endpoint-identifier {i value} --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn={i value},BucketFolder={i value},BucketName={i value},EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId={i value}
    *)
  34. encryption_mode : encryption_mode_value option;
    (*

    The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS.

    For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS.

    To use SSE_S3, you need an Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

    • s3:CreateBucket
    • s3:ListBucket
    • s3:DeleteBucket
    • s3:GetBucketLocation
    • s3:GetObject
    • s3:PutObject
    • s3:DeleteObject
    • s3:GetObjectVersion
    • s3:GetBucketPolicy
    • s3:PutBucketPolicy
    • s3:DeleteBucketPolicy
    *)
  35. compression_type : compression_type_value option;
    (*

    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats.

    *)
  36. bucket_name : string_ option;
    (*

    The name of the S3 bucket.

    *)
  37. bucket_folder : string_ option;
    (*

    An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path

     {i bucketFolder}/{i schema_name}/{i table_name}/

    . If this parameter isn't specified, then the path used is

     {i schema_name}/{i table_name}/

    .

    *)
  38. csv_delimiter : string_ option;
    (*

    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.

    *)
  39. csv_row_delimiter : string_ option;
    (*

    The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n).

    *)
  40. external_table_definition : string_ option;
    (*

    Specifies how tables are defined in the S3 source files only.

    *)
  41. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action. It is a required parameter that enables DMS to write and read objects from an S3 bucket.

    *)
}

Settings for exporting data to Amazon S3.

type nonrec run_fleet_advisor_lsa_analysis_response = {
  1. status : string_ option;
    (*

    The status of the LSA analysis, for example COMPLETED.

    *)
  2. lsa_analysis_id : string_ option;
    (*

    The ID of the LSA analysis run.

    *)
}
type nonrec pending_maintenance_action = {
  1. description : string_ option;
    (*

    A description providing more detail about the maintenance action.

    *)
  2. current_apply_date : t_stamp option;
    (*

    The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API operation, and also the AutoAppliedAfterDate and ForcedApplyDate parameter values. This value is blank if an opt-in request has not been received and nothing has been specified for AutoAppliedAfterDate or ForcedApplyDate.

    *)
  3. opt_in_status : string_ option;
    (*

    The type of opt-in request that has been received for the resource.

    *)
  4. forced_apply_date : t_stamp option;
    (*

    The date when the maintenance action will be automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

    *)
  5. auto_applied_after_date : t_stamp option;
    (*

    The date of the maintenance window when the action is to be applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

    *)
  6. action : string_ option;
    (*

    The type of pending maintenance action that is available for the resource.

    *)
}

Describes a maintenance action pending for an DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.

type nonrec pending_maintenance_action_details = pending_maintenance_action list
type nonrec resource_pending_maintenance_actions = {
  1. pending_maintenance_action_details : pending_maintenance_action_details option;
    (*

    Detailed information about the pending maintenance action.

    *)
  2. resource_identifier : string_ option;
    (*

    The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) for DMS in the DMS documentation.

    *)
}

Identifies an DMS resource and any pending actions for it.

type nonrec replication_task_list = replication_task list
type nonrec replication_task_individual_assessment = {
  1. replication_task_individual_assessment_start_date : t_stamp option;
    (*

    Date when this individual assessment was started as part of running the StartReplicationTaskAssessmentRun operation.

    *)
  2. status : string_ option;
    (*

    Individual assessment status.

    This status can have one of the following values:

    • "cancelled"
    • "error"
    • "failed"
    • "passed"
    • "pending"
    • "skipped"
    • "running"
    *)
  3. individual_assessment_name : string_ option;
    (*

    Name of this individual assessment.

    *)
  4. replication_task_assessment_run_arn : string_ option;
    (*

    ARN of the premigration assessment run that is created to run this individual assessment.

    *)
  5. replication_task_individual_assessment_arn : string_ option;
    (*

    Amazon Resource Name (ARN) of this individual assessment.

    *)
}

Provides information that describes an individual assessment from a premigration assessment run.

type nonrec replication_task_individual_assessment_list = replication_task_individual_assessment list
type nonrec replication_task_assessment_run_list = replication_task_assessment_run list
type nonrec replication_task_assessment_result = {
  1. s3_object_url : secret_string option;
    (*

    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.

    *)
  2. assessment_results : string_ option;
    (*

    The task assessment results in JSON format.

    The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.

    *)
  3. assessment_results_file : string_ option;
    (*

    The file containing the results of the task assessment.

    *)
  4. assessment_status : string_ option;
    (*

    The status of the task assessment.

    *)
  5. replication_task_last_assessment_date : t_stamp option;
    (*

    The date the task assessment was completed.

    *)
  6. replication_task_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
  7. replication_task_identifier : string_ option;
    (*

    The replication task identifier of the task on which the task assessment was run.

    *)
}

The task assessment report in JSON format.

type nonrec replication_task_assessment_result_list = replication_task_assessment_result list
type nonrec replication_table_statistics_list = table_statistics list
type nonrec replication_subnet_group = {
  1. is_read_only : boolean_optional option;
    (*

    Indicates whether the replication subnet group is read-only. When set to true, this subnet group is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only subnet groups through their associated zero-ETL integration.

    *)
  2. supported_network_types : string_list option;
    (*

    The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

    *)
  3. subnets : subnet_list option;
    (*

    The subnets that are in the subnet group.

    *)
  4. subnet_group_status : string_ option;
    (*

    The status of the subnet group.

    *)
  5. vpc_id : string_ option;
    (*

    The ID of the VPC.

    *)
  6. replication_subnet_group_description : string_ option;
    (*

    A description for the replication subnet group.

    *)
  7. replication_subnet_group_identifier : string_ option;
    (*

    The identifier of the replication instance subnet group.

    *)
}

Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.

type nonrec replication_subnet_groups = replication_subnet_group list
type nonrec replication_subnet_group_does_not_cover_enough_a_zs = {
  1. message : exception_message option;
}

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

type nonrec replication_instance_class = string
type nonrec replication_pending_modified_values = {
  1. network_type : string_ option;
    (*

    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.

    *)
  2. engine_version : string_ option;
    (*

    The engine version number of the replication instance.

    *)
  3. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  4. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gigabytes) that is allocated for the replication instance.

    *)
  5. replication_instance_class : replication_instance_class option;
    (*

    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.

    *)
}

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.

type nonrec replication_list = replication list
type nonrec replication_instance_task_log = {
  1. replication_instance_task_log_size : long option;
    (*

    The size, in bytes, of the replication task log.

    *)
  2. replication_task_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
  3. replication_task_name : string_ option;
    (*

    The name of the replication task.

    *)
}

Contains metadata for a replication instance task log.

type nonrec replication_instance_task_logs_list = replication_instance_task_log list
type nonrec replication_instance_public_ip_address_list = string_ list
type nonrec replication_instance_private_ip_address_list = string_ list
type nonrec replication_instance_ipv6_address_list = string_ list
type nonrec kerberos_authentication_settings = {
  1. krb5_file_contents : string_ option;
    (*

    Specifies the contents of krb5 configuration file required for kerberos authentication.

    *)
  2. key_cache_secret_iam_arn : string_ option;
    (*

    Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the kerberos authentication.

    *)
  3. key_cache_secret_id : string_ option;
    (*

    Specifies the ID of the secret that stores the key cache file required for kerberos authentication.

    *)
}

Specifies the settings required for kerberos authentication when creating the replication instance.

type nonrec replication_instance = {
  1. kerberos_authentication_settings : kerberos_authentication_settings option;
    (*

    Specifies the settings required for kerberos authentication when replicating an instance.

    *)
  2. network_type : string_ option;
    (*

    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.

    *)
  3. dns_name_servers : string_ option;
    (*

    The DNS name servers supported for the replication instance to access your on-premise source or target database.

    *)
  4. free_until : t_stamp option;
    (*

    The expiration date of the free replication instance that is part of the Free DMS program.

    *)
  5. secondary_availability_zone : string_ option;
    (*

    The Availability Zone of the standby replication instance in a Multi-AZ deployment.

    *)
  6. publicly_accessible : boolean_ option;
    (*

    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.

    *)
  7. replication_instance_ipv6_addresses : replication_instance_ipv6_address_list option;
    (*

    One or more IPv6 addresses for the replication instance.

    *)
  8. replication_instance_private_ip_addresses : replication_instance_private_ip_address_list option;
    (*

    One or more private IP addresses for the replication instance.

    *)
  9. replication_instance_public_ip_addresses : replication_instance_public_ip_address_list option;
    (*

    One or more public IP addresses for the replication instance.

    *)
  10. replication_instance_private_ip_address : string_ option;
    (*

    The private IP address of the replication instance.

    *)
  11. replication_instance_public_ip_address : string_ option;
    (*

    The public IP address of the replication instance.

    *)
  12. replication_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
  13. kms_key_id : string_ option;
    (*

    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.

    *)
  14. auto_minor_version_upgrade : boolean_ option;
    (*

    Boolean value indicating if minor version upgrades will be automatically applied to the instance.

    *)
  15. engine_version : string_ option;
    (*

    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.

    When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

    *)
  16. multi_a_z : boolean_ option;
    (*

    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.

    *)
  17. pending_modified_values : replication_pending_modified_values option;
    (*

    The pending modification values.

    *)
  18. preferred_maintenance_window : string_ option;
    (*

    The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

    *)
  19. replication_subnet_group : replication_subnet_group option;
    (*

    The subnet group for the replication instance.

    *)
  20. availability_zone : string_ option;
    (*

    The Availability Zone for the instance.

    *)
  21. vpc_security_groups : vpc_security_group_membership_list option;
    (*

    The VPC security group for the instance.

    *)
  22. instance_create_time : t_stamp option;
    (*

    The time the replication instance was created.

    *)
  23. allocated_storage : integer option;
    (*

    The amount of storage (in gigabytes) that is allocated for the replication instance.

    *)
  24. replication_instance_status : string_ option;
    (*

    The status of the replication instance. The possible return values include:

    • "available"
    • "creating"
    • "deleted"
    • "deleting"
    • "failed"
    • "modifying"
    • "upgrading"
    • "rebooting"
    • "resetting-master-credentials"
    • "storage-full"
    • "incompatible-credentials"
    • "incompatible-network"
    • "maintenance"
    *)
  25. replication_instance_class : replication_instance_class option;
    (*

    The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

    For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

    *)
  26. replication_instance_identifier : string_ option;
    (*

    The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain 1-63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: myrepinstance

    *)
}

Provides information that defines a replication instance.

type nonrec replication_instance_list = replication_instance list
type nonrec compute_config = {
  1. vpc_security_group_ids : string_list option;
    (*

    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.

    *)
  2. replication_subnet_group_id : string_ option;
    (*

    Specifies a subnet group identifier to associate with the DMS Serverless replication.

    *)
  3. preferred_maintenance_window : string_ option;
    (*

    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.

    *)
  4. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  5. min_capacity_units : integer_optional option;
    (*

    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 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. If you don't set this value, DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it reaches the value specified in MinCapacityUnits.

    *)
  6. max_capacity_units : integer_optional option;
    (*

    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 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 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.

    *)
  7. kms_key_id : string_ option;
    (*

    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.

    *)
  8. dns_name_servers : string_ option;
    (*

    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"

    *)
  9. availability_zone : string_ option;
    (*

    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.

    *)
}

Configuration parameters for provisioning an DMS Serverless replication.

type nonrec replication_config = {
  1. is_read_only : boolean_optional option;
    (*

    Indicates whether the replication configuration is read-only. When set to true, this replication configuration is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only replication configurations through their associated zero-ETL integration.

    *)
  2. replication_config_update_time : t_stamp option;
    (*

    The time the serverless replication config was updated.

    *)
  3. replication_config_create_time : t_stamp option;
    (*

    The time the serverless replication config was created.

    *)
  4. table_mappings : string_ option;
    (*

    Table mappings specified in the replication.

    *)
  5. supplemental_settings : string_ option;
    (*

    Additional parameters for an DMS serverless replication.

    *)
  6. replication_settings : string_ option;
    (*

    Configuration parameters for an DMS serverless replication.

    *)
  7. compute_config : compute_config option;
    (*

    Configuration parameters for provisioning an DMS serverless replication.

    *)
  8. replication_type : migration_type_value option;
    (*

    The type of the replication.

    *)
  9. target_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.

    *)
  10. source_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.

    *)
  11. replication_config_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of this DMS Serverless replication configuration.

    *)
  12. replication_config_identifier : string_ option;
    (*

    The identifier for the ReplicationConfig associated with the replication.

    *)
}

This object provides configuration information about a serverless replication.

type nonrec replication_config_list = replication_config list
type nonrec remove_tags_from_resource_response = unit
type nonrec key_list = string_ list
type nonrec remove_tags_from_resource_message = {
  1. tag_keys : key_list;
    (*

    The tag key (name) of the tag to be removed.

    *)
  2. resource_arn : string_;
    (*

    An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).

    *)
}

Removes one or more tags from an DMS resource.

type nonrec reload_tables_response = {
  1. replication_task_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
}
type nonrec reload_option_value =
  1. | VALIDATE_ONLY
  2. | DATA_RELOAD
type nonrec reload_tables_message = {
  1. reload_option : reload_option_value option;
    (*

    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 task.

    Valid values: data-reload, validate-only

    Default value is data-reload.

    *)
  2. tables_to_reload : table_list_to_reload;
    (*

    The name and schema of the table to be reloaded.

    *)
  3. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
}
type nonrec reload_replication_tables_response = {
  1. replication_config_arn : string_ option;
    (*

    The Amazon Resource Name of the replication config for which to reload tables.

    *)
}
type nonrec reload_replication_tables_message = {
  1. reload_option : reload_option_value option;
    (*

    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.

    *)
  2. tables_to_reload : table_list_to_reload;
    (*

    The list of tables to reload.

    *)
  3. replication_config_arn : string_;
    (*

    The Amazon Resource Name of the replication config for which to reload tables.

    *)
}
type nonrec release_status_values =
  1. | PROD
  2. | BETA
type nonrec refresh_schemas_status_type_value =
  1. | REFRESHING
  2. | FAILED
  3. | SUCCESSFUL
type nonrec refresh_schemas_status = {
  1. last_failure_message : string_ option;
    (*

    The last failure message for the schema.

    *)
  2. last_refresh_date : t_stamp option;
    (*

    The date the schema was last refreshed.

    *)
  3. status : refresh_schemas_status_type_value option;
    (*

    The status of the schema.

    *)
  4. replication_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
  5. endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}

Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.

type nonrec refresh_schemas_response = {
  1. refresh_schemas_status : refresh_schemas_status option;
    (*

    The status of the refreshed schema.

    *)
}
type nonrec refresh_schemas_message = {
  1. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
  2. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}
type nonrec redshift_settings = {
  1. map_boolean_as_boolean : boolean_optional option;
    (*

    When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as varchar(1). You must set this setting on both the source and target endpoints for it to take effect.

    *)
  2. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.

    *)
  3. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  4. write_buffer_size : integer_optional option;
    (*

    The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).

    *)
  5. username : string_ option;
    (*

    An Amazon Redshift user name for a registered user.

    *)
  6. truncate_columns : boolean_optional option;
    (*

    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose true to truncate data. The default is false.

    *)
  7. trim_blanks : boolean_optional option;
    (*

    A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose true to remove unneeded white space. The default is false.

    *)
  8. time_format : string_ option;
    (*

    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that aren't supported when you use a time format string.

    If your date and time values use formats different from each other, set this parameter to auto.

    *)
  9. server_side_encryption_kms_key_id : string_ option;
    (*

    The KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.

    *)
  10. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the iam:PassRole action.

    *)
  11. server_name : string_ option;
    (*

    The name of the Amazon Redshift cluster you are using.

    *)
  12. replace_chars : string_ option;
    (*

    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".

    *)
  13. replace_invalid_chars : string_ option;
    (*

    A list of characters that you want to replace. Use with ReplaceChars.

    *)
  14. remove_quotes : boolean_optional option;
    (*

    A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose true to remove quotation marks. The default is false.

    *)
  15. port : integer_optional option;
    (*

    The port number for Amazon Redshift. The default value is 5439.

    *)
  16. password : secret_string option;
    (*

    The password for the user named in the username property.

    *)
  17. max_file_size : integer_optional option;
    (*

    The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).

    *)
  18. load_timeout : integer_optional option;
    (*

    The amount of time to wait (in seconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.

    *)
  19. file_transfer_upload_streams : integer_optional option;
    (*

    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.

    The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview.

    FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.

    *)
  20. explicit_ids : boolean_optional option;
    (*

    This setting is only valid for a full-load migration task. Set ExplicitIds to true to have tables with IDENTITY columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is false.

    *)
  21. encryption_mode : encryption_mode_value option;
    (*

    The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS.

    For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS.

    To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"

    *)
  22. empty_as_null : boolean_optional option;
    (*

    A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.

    *)
  23. date_format : string_ option;
    (*

    The date format that you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't supported when you use a date format string.

    If your date and time values use formats different from each other, set this to auto.

    *)
  24. database_name : string_ option;
    (*

    The name of the Amazon Redshift data warehouse (service) that you are working with.

    *)
  25. connection_timeout : integer_optional option;
    (*

    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

    *)
  26. comp_update : boolean_optional option;
    (*

    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other than RAW. If you set CompUpdate to false, automatic compression is disabled and existing column encodings aren't changed. The default is true.

    *)
  27. case_sensitive_names : boolean_optional option;
    (*

    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.

    *)
  28. bucket_name : string_ option;
    (*

    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.

    *)
  29. bucket_folder : string_ option;
    (*

    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.

    For full load mode, DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. DMS uses the Redshift COPY command to upload the .csv files to the target table. The files are deleted once the COPY operation has finished. For more information, see COPY in the Amazon Redshift Database Developer Guide.

    For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.

    *)
  30. after_connect_script : string_ option;
    (*

    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.

    *)
  31. accept_any_date : boolean_optional option;
    (*

    A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose true or false (the default).

    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

    *)
}

Provides information that defines an Amazon Redshift endpoint.

type nonrec redshift_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. database_name : string_ option;
    (*

    The database name on the Amazon Redshift data provider.

    *)
  4. port : integer_optional option;
    (*

    The port value for the Amazon Redshift data provider.

    *)
  5. server_name : string_ option;
    (*

    The name of the Amazon Redshift server.

    *)
}

Provides information that defines an Amazon Redshift data provider.

type nonrec redis_auth_type_value =
  1. | AUTH_TOKEN
  2. | AUTH_ROLE
  3. | NONE
type nonrec redis_settings = {
  1. ssl_ca_certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

    *)
  2. auth_password : secret_string option;
    (*

    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

    *)
  3. auth_user_name : string_ option;
    (*

    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

    *)
  4. auth_type : redis_auth_type_value option;
    (*

    The type of authentication to perform when connecting to a Redis target. Options include none, auth-token, and auth-role. The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.

    *)
  5. ssl_security_protocol : ssl_security_protocol_value option;
    (*

    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption. The default is ssl-encryption. The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.

    The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

    *)
  6. port : integer;
    (*

    Transmission Control Protocol (TCP) port for the endpoint.

    *)
  7. server_name : string_;
    (*

    Fully qualified domain name of the endpoint.

    *)
}

Provides information that defines a Redis target endpoint.

type nonrec rds_requirements = {
  1. engine_version : string_ option;
    (*

    The required target Amazon RDS engine version.

    *)
  2. deployment_option : string_ option;
    (*

    The required deployment option for the Amazon RDS DB instance. Valid values include "MULTI_AZ" for Multi-AZ deployments and "SINGLE_AZ" for Single-AZ deployments.

    *)
  3. storage_iops : integer_optional option;
    (*

    The required number of I/O operations completed each second (IOPS) on your Amazon RDS DB instance.

    *)
  4. storage_size : integer_optional option;
    (*

    The required Amazon RDS DB instance storage size.

    *)
  5. instance_memory : double_optional option;
    (*

    The required memory on the Amazon RDS DB instance.

    *)
  6. instance_vcpu : double_optional option;
    (*

    The required number of virtual CPUs (vCPU) on the Amazon RDS DB instance.

    *)
  7. engine_edition : string_ option;
    (*

    The required target Amazon RDS engine edition.

    *)
}

Provides information that describes the requirements to the target engine on Amazon RDS.

type nonrec rds_configuration = {
  1. engine_version : string_ option;
    (*

    Describes the recommended target Amazon RDS engine version.

    *)
  2. deployment_option : string_ option;
    (*

    Describes the deployment option for the recommended Amazon RDS DB instance. The deployment options include Multi-AZ and Single-AZ deployments. Valid values include "MULTI_AZ" and "SINGLE_AZ".

    *)
  3. storage_iops : integer_optional option;
    (*

    Describes the number of I/O operations completed each second (IOPS) on the recommended Amazon RDS DB instance that meets your requirements.

    *)
  4. storage_size : integer_optional option;
    (*

    Describes the storage size of the recommended Amazon RDS DB instance that meets your requirements.

    *)
  5. storage_type : string_ option;
    (*

    Describes the storage type of the recommended Amazon RDS DB instance that meets your requirements.

    Amazon RDS provides three storage types: General Purpose SSD (also known as gp2 and gp3), Provisioned IOPS SSD (also known as io1), and magnetic (also known as standard).

    *)
  6. instance_memory : double_optional option;
    (*

    Describes the memory on the recommended Amazon RDS DB instance that meets your requirements.

    *)
  7. instance_vcpu : double_optional option;
    (*

    Describes the number of virtual CPUs (vCPU) on the recommended Amazon RDS DB instance that meets your requirements.

    *)
  8. instance_type : string_ option;
    (*

    Describes the recommended target Amazon RDS instance type.

    *)
  9. engine_edition : string_ option;
    (*

    Describes the recommended target Amazon RDS engine edition.

    *)
}

Provides information that describes the configuration of the recommended target engine on Amazon RDS.

type nonrec rds_recommendation = {
  1. target_configuration : rds_configuration option;
    (*

    Supplemental information about the configuration of the recommended target database on Amazon RDS.

    *)
  2. requirements_to_target : rds_requirements option;
    (*

    Supplemental information about the requirements to the recommended target database on Amazon RDS.

    *)
}

Provides information that describes a recommendation of a target engine on Amazon RDS.

type nonrec recommendation_data = {
  1. rds_engine : rds_recommendation option;
    (*

    The recommendation of a target Amazon RDS database engine.

    *)
}

Provides information about the target engine for the specified source database.

type nonrec recommendation = {
  1. data : recommendation_data option;
    (*

    The recommendation of a target engine for the specified source database.

    *)
  2. settings : recommendation_settings option;
    (*

    The settings in JSON format for the preferred target engine parameters. These parameters include capacity, resource utilization, and the usage type (production, development, or testing).

    *)
  3. preferred : boolean_optional option;
    (*

    Indicates that this target is the rightsized migration destination.

    *)
  4. status : string_ option;
    (*

    The status of the target engine recommendation. Valid values include "alternate", "in-progress", "not-viable", and "recommended".

    *)
  5. created_date : string_ option;
    (*

    The date when Fleet Advisor created the target engine recommendation.

    *)
  6. engine_name : string_ option;
    (*

    The name of the target engine. Valid values include "rds-aurora-mysql", "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and "rds-postgresql".

    *)
  7. database_id : string_ option;
    (*

    The identifier of the source database for which Fleet Advisor provided this recommendation.

    *)
}

Provides information that describes a recommendation of a target engine.

A recommendation is a set of possible Amazon Web Services target engines that you can choose to migrate your source on-premises database. In this set, Fleet Advisor suggests a single target engine as the right sized migration destination. To determine this rightsized migration destination, Fleet Advisor uses the inventory metadata and metrics from data collector. You can use recommendations before the start of migration to save costs and reduce risks.

With recommendations, you can explore different target options and compare metrics, so you can make an informed decision when you choose the migration target.

type nonrec recommendation_list = recommendation list
type nonrec reboot_replication_instance_response = {
  1. replication_instance : replication_instance option;
    (*

    The replication instance that is being rebooted.

    *)
}
type nonrec reboot_replication_instance_message = {
  1. force_planned_failover : boolean_optional option;
    (*

    If this parameter is true, the reboot is conducted through a planned Multi-AZ failover where resources are released and cleaned up prior to conducting the failover. If the instance isn''t configured for Multi-AZ, then you can't specify true. ( --force-planned-failover and --force-failover can't both be set to true.)

    *)
  2. force_failover : boolean_optional option;
    (*

    If this parameter is true, the reboot is conducted through a Multi-AZ failover. If the instance isn't configured for Multi-AZ, then you can't specify true. ( --force-planned-failover and --force-failover can't both be set to true.)

    *)
  3. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
}
type nonrec postgre_sql_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  4. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the PostgreSQL data provider. The default value is none.

    *)
  5. database_name : string_ option;
    (*

    The database name on the PostgreSQL data provider.

    *)
  6. port : integer_optional option;
    (*

    The port value for the PostgreSQL data provider.

    *)
  7. server_name : string_ option;
    (*

    The name of the PostgreSQL server.

    *)
}

Provides information that defines a PostgreSQL data provider.

type nonrec plugin_name_value =
  1. | PGLOGICAL
  2. | TEST_DECODING
  3. | NO_PREFERENCE
type nonrec long_varchar_mapping_type =
  1. | NCLOB
  2. | CLOB
  3. | WSTRING
type nonrec database_mode =
  1. | BABELFISH
  2. | DEFAULT
type nonrec postgre_sql_authentication_method =
  1. | IAM
  2. | Password
type nonrec postgre_sql_settings = {
  1. authentication_method : postgre_sql_authentication_method option;
    (*

    This attribute allows you to specify the authentication method as "iam auth".

    *)
  2. service_access_role_arn : string_ option;
    (*

    The IAM role arn you can use to authenticate the connection to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.

    *)
  3. disable_unicode_source_filter : boolean_optional option;
    (*

    Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.

    Unicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.

    *)
  4. babelfish_database_name : string_ option;
    (*

    The Babelfish for Aurora PostgreSQL database name for the endpoint.

    *)
  5. database_mode : database_mode option;
    (*

    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.

    *)
  6. map_long_varchar_as : long_varchar_mapping_type option;
    (*

    Sets what datatype to map LONG values as.

    The default value is wstring.

    *)
  7. map_jsonb_as_clob : boolean_optional option;
    (*

    When true, DMS migrates JSONB values as CLOB.

    The default value is false.

    *)
  8. map_boolean_as_boolean : boolean_optional option;
    (*

    When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as varchar(5). You must set this setting on both the source and target endpoints for it to take effect.

    The default value is false.

    *)
  9. trim_space_in_char : boolean_optional option;
    (*

    Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

    *)
  10. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.

    *)
  11. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  12. plugin_name : plugin_name_value option;
    (*

    Specifies the plugin to use to create a replication slot.

    The default value is pglogical.

    *)
  13. slot_name : string_ option;
    (*

    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.

    When used with the CdcStartPosition request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of CdcStartPosition. If the specified slot doesn't exist or the task doesn't have a valid 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 Guide. For more information about using CdcStartPosition, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.

    *)
  14. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  15. server_name : string_ option;
    (*

    The host name of the endpoint database.

    For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances, in the

     {{:https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html}Endpoint}.Address

    field.

    For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters, in the Endpoint field.

    *)
  16. port : integer_optional option;
    (*

    Endpoint TCP port. The default is 5432.

    *)
  17. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  18. heartbeat_frequency : integer_optional option;
    (*

    Sets the WAL heartbeat frequency (in minutes).

    The default value is 5 minutes.

    *)
  19. heartbeat_schema : string_ option;
    (*

    Sets the schema in which the heartbeat artifacts are created.

    The default value is public.

    *)
  20. heartbeat_enable : boolean_optional option;
    (*

    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps restart_lsn moving and prevents storage full scenarios.

    The default value is false.

    *)
  21. fail_tasks_on_lob_truncation : boolean_optional option;
    (*

    When set to true, this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize.

    The default value is false.

    If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

    *)
  22. execute_timeout : integer_optional option;
    (*

    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.

    Example: executeTimeout=100;

    *)
  23. ddl_artifacts_schema : string_ option;
    (*

    The schema in which the operational DDL database artifacts are created.

    The default value is public.

    Example: ddlArtifactsSchema=xyzddlschema;

    *)
  24. database_name : string_ option;
    (*

    Database name for the endpoint.

    *)
  25. max_file_size : integer_optional option;
    (*

    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.

    The default value is 32,768 KB (32 MB).

    Example: maxFileSize=512

    *)
  26. capture_ddls : boolean_optional option;
    (*

    To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.

    The default value is true.

    If this value is set to N, you don't have to create tables or triggers on the source database.

    *)
  27. after_connect_script : string_ option;
    (*

    For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.

    Example: afterConnectScript=SET session_replication_role='replica'

    *)
}

Provides information that defines a PostgreSQL endpoint.

type nonrec pending_maintenance_actions = resource_pending_maintenance_actions list
type nonrec availability_zones_list = string_ list
type nonrec orderable_replication_instance = {
  1. release_status : release_status_values option;
    (*

    The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

    DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

    *)
  2. availability_zones : availability_zones_list option;
    (*

    List of Availability Zones for this replication instance.

    *)
  3. included_allocated_storage : integer option;
    (*

    The amount of storage (in gigabytes) that is allocated for the replication instance.

    *)
  4. default_allocated_storage : integer option;
    (*

    The default amount of storage (in gigabytes) that is allocated for the replication instance.

    *)
  5. max_allocated_storage : integer option;
    (*

    The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

    *)
  6. min_allocated_storage : integer option;
    (*

    The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

    *)
  7. storage_type : string_ option;
    (*

    The type of storage used by the replication instance.

    *)
  8. replication_instance_class : replication_instance_class option;
    (*

    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.

    *)
  9. engine_version : string_ option;
    (*

    The version of the replication engine.

    *)
}

In response to the DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.

type nonrec orderable_replication_instance_list = orderable_replication_instance list
type nonrec integer_list = integer list
type nonrec char_length_semantics =
  1. | BYTE
  2. | CHAR
  3. | DEFAULT
type nonrec oracle_authentication_method =
  1. | Kerberos
  2. | Password
type nonrec oracle_settings = {
  1. authentication_method : oracle_authentication_method option;
    (*

    Specifies the authentication method to be used with Oracle.

    *)
  2. open_transaction_window : integer_optional option;
    (*

    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.

    *)
  3. convert_timestamp_with_zone_to_ut_c : boolean_optional option;
    (*

    When true, converts timestamps with the timezone datatype to their UTC value.

    *)
  4. trim_space_in_char : boolean_optional option;
    (*

    Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

    *)
  5. secrets_manager_oracle_asm_secret_id : string_ option;
    (*

    Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

    *)
  6. secrets_manager_oracle_asm_access_role_arn : string_ option;
    (*

    Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUser, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  7. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.

    *)
  8. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  9. use_logminer_reader : boolean_optional option;
    (*

    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default). Set this attribute to False if you want to access the redo logs as a binary file. When you set UseLogminerReader to False, also set UseBfile to True. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.

    *)
  10. use_direct_path_full_load : boolean_optional option;
    (*

    Set this attribute to True to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.

    *)
  11. use_b_file : boolean_optional option;
    (*

    Set this attribute to True to capture change data using the Binary Reader utility. Set UseLogminerReader to False to set this attribute to True. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC.

    *)
  12. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  13. standby_delay_time : integer_optional option;
    (*

    Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.

    In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.

    *)
  14. spatial_data_option_to_geo_json_function_name : string_ option;
    (*

    Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName to call it instead.

    *)
  15. server_name : string_ option;
    (*

    Fully qualified domain name of the endpoint.

    For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the

     {{:https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html}Endpoint}.Address

    field.

    *)
  16. security_db_encryption_name : string_ option;
    (*

    For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

    *)
  17. security_db_encryption : secret_string option;
    (*

    For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the

     {i TDE_Password}

    part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

    *)
  18. retry_interval : integer_optional option;
    (*

    Specifies the number of seconds that the system waits before resending a query.

    Example: retryInterval=6;

    *)
  19. read_table_space_name : boolean_optional option;
    (*

    When set to true, this attribute supports tablespace replication.

    *)
  20. port : integer_optional option;
    (*

    Endpoint TCP port.

    *)
  21. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  22. number_datatype_scale : integer_optional option;
    (*

    Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.

    Example: numberDataTypeScale=12

    *)
  23. fail_tasks_on_lob_truncation : boolean_optional option;
    (*

    When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.

    If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

    *)
  24. direct_path_parallel_load : boolean_optional option;
    (*

    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.

    *)
  25. database_name : string_ option;
    (*

    Database name for the endpoint.

    *)
  26. char_length_semantics : char_length_semantics option;
    (*

    Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes.

    Example: charLengthSemantics=CHAR;

    *)
  27. asm_user : string_ option;
    (*

    For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

    *)
  28. asm_server : string_ option;
    (*

    For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

    *)
  29. asm_password : secret_string option;
    (*

    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the

     {i asm_user_password}

    value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

    *)
  30. archived_logs_only : boolean_optional option;
    (*

    When this field is set to True, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.

    *)
  31. direct_path_no_log : boolean_optional option;
    (*

    When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.

    *)
  32. enable_homogenous_tablespace : boolean_optional option;
    (*

    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.

    *)
  33. replace_path_prefix : boolean_optional option;
    (*

    Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.

    *)
  34. use_path_prefix : string_ option;
    (*

    Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.

    *)
  35. oracle_path_prefix : string_ option;
    (*

    Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.

    *)
  36. use_alternate_folder_for_online : boolean_optional option;
    (*

    Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.

    *)
  37. access_alternate_directly : boolean_optional option;
    (*

    Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.

    *)
  38. read_ahead_blocks : integer_optional option;
    (*

    Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).

    *)
  39. parallel_asm_read_threads : integer_optional option;
    (*

    Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.

    *)
  40. allow_select_nested_tables : boolean_optional option;
    (*

    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.

    *)
  41. extra_archived_log_dest_ids : integer_list option;
    (*

    Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the dest_id column in the v$archived_log view. Use this setting with the archivedLogDestId extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.

    This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.

    archivedLogDestId=1; ExtraArchivedLogDestIds=[2]

    In a primary-to-multiple-standby setup, you might apply the following settings.

    archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]

    Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

    *)
  42. additional_archived_log_dest_id : integer_optional option;
    (*

    Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.

    Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

    *)
  43. archived_log_dest_id : integer_optional option;
    (*

    Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.

    *)
  44. add_supplemental_logging : boolean_optional option;
    (*

    Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.

    If you use this option, you still need to enable database-level supplemental logging.

    *)
}

Provides information that defines an Oracle endpoint.

type nonrec oracle_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. secrets_manager_security_db_encryption_access_role_arn : string_ option;
    (*

    The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.

    *)
  4. secrets_manager_security_db_encryption_secret_id : string_ option;
    (*

    The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.

    *)
  5. secrets_manager_oracle_asm_access_role_arn : string_ option;
    (*

    The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.

    *)
  6. secrets_manager_oracle_asm_secret_id : string_ option;
    (*

    The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.

    Required only if your data provider uses the Oracle ASM server.

    *)
  7. asm_server : string_ option;
    (*

    The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

    *)
  8. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  9. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the Oracle data provider. The default value is none.

    *)
  10. database_name : string_ option;
    (*

    The database name on the Oracle data provider.

    *)
  11. port : integer_optional option;
    (*

    The port value for the Oracle data provider.

    *)
  12. server_name : string_ option;
    (*

    The name of the Oracle server.

    *)
}

Provides information that defines an Oracle data provider.

type nonrec nesting_level_value =
  1. | ONE
  2. | NONE
type nonrec neptune_settings = {
  1. iam_auth_enabled : boolean_optional option;
    (*

    If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.

    *)
  2. max_retry_count : integer_optional option;
    (*

    The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.

    *)
  3. max_file_size : integer_optional option;
    (*

    The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.

    *)
  4. error_retry_duration : integer_optional option;
    (*

    The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.

    *)
  5. s3_bucket_folder : string_;
    (*

    A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName

    *)
  6. s3_bucket_name : string_;
    (*

    The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.

    *)
  7. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service User Guide.

    *)
}

Provides information that defines an Amazon Neptune endpoint.

type nonrec my_sql_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  4. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the MySQL data provider. The default value is none.

    *)
  5. port : integer_optional option;
    (*

    The port value for the MySQL data provider.

    *)
  6. server_name : string_ option;
    (*

    The name of the MySQL server.

    *)
}

Provides information that defines a MySQL data provider.

type nonrec my_sql_authentication_method =
  1. | IAM
  2. | Password
type nonrec my_sql_settings = {
  1. authentication_method : my_sql_authentication_method option;
    (*

    This attribute allows you to specify the authentication method as "iam auth".

    *)
  2. service_access_role_arn : string_ option;
    (*

    The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.

    *)
  3. execute_timeout : integer_optional option;
    (*

    Sets the client statement timeout (in seconds) for a MySQL source endpoint.

    *)
  4. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

    *)
  5. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  6. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  7. server_timezone : string_ option;
    (*

    Specifies the time zone for the source MySQL database.

    Example: serverTimezone=US/Pacific;

    Note: Do not enclose time zones in single quotes.

    *)
  8. server_name : string_ option;
    (*

    The host name of the endpoint database.

    For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances, in the

     {{:https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html}Endpoint}.Address

    field.

    For an Aurora MySQL instance, this is the output of DescribeDBClusters, in the Endpoint field.

    *)
  9. port : integer_optional option;
    (*

    Endpoint TCP port.

    *)
  10. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  11. parallel_load_threads : integer_optional option;
    (*

    Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.

    Example: parallelLoadThreads=1

    *)
  12. max_file_size : integer_optional option;
    (*

    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

    Example: maxFileSize=512

    *)
  13. target_db_type : target_db_type option;
    (*

    Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify SPECIFIC_DATABASE, specify the database name using the DatabaseName parameter of the Endpoint object.

    Example: targetDbType=MULTIPLE_DATABASES

    *)
  14. events_poll_interval : integer_optional option;
    (*

    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.

    Example: eventsPollInterval=5;

    In the example, DMS checks for changes in the binary logs every five seconds.

    *)
  15. database_name : string_ option;
    (*

    Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

    *)
  16. clean_source_metadata_on_mismatch : boolean_optional option;
    (*

    Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance.

    *)
  17. after_connect_script : string_ option;
    (*

    Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.

    For this parameter, provide the code of the script itself, not the name of a file containing the script.

    *)
}

Provides information that defines a MySQL endpoint.

type nonrec move_replication_task_response = {
  1. replication_task : replication_task option;
    (*

    The replication task that was moved.

    *)
}
type nonrec move_replication_task_message = {
  1. target_replication_instance_arn : string_;
    (*

    The ARN of the replication instance where you want to move the task to.

    *)
  2. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the task that you want to move.

    *)
}
type nonrec auth_type_value =
  1. | PASSWORD
  2. | NO
type nonrec auth_mechanism_value =
  1. | SCRAM_SHA_1
  2. | MONGODB_CR
  3. | DEFAULT
type nonrec mongo_db_settings = {
  1. replicate_shard_collections : boolean_optional option;
    (*

    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.
    *)
  2. use_update_look_up : boolean_optional option;
    (*

    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.

    *)
  3. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

    *)
  4. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  5. kms_key_id : string_ option;
    (*

    The KMS key identifier that is used to encrypt the content 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.

    *)
  6. auth_source : string_ option;
    (*

    The MongoDB database name. This setting isn't used when AuthType is set to "no".

    The default is "admin".

    *)
  7. docs_to_investigate : string_ option;
    (*

    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".

    Must be a positive value greater than 0. Default value is 1000.

    *)
  8. extract_doc_id : string_ option;
    (*

    Specifies the document ID. Use this setting when NestingLevel is set to "none".

    Default value is "false".

    *)
  9. nesting_level : nesting_level_value option;
    (*

    Specifies either document or table mode.

    Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.

    *)
  10. auth_mechanism : auth_mechanism_value option;
    (*

    The authentication mechanism you use to access the MongoDB source endpoint.

    For the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For MongoDB version 3.x or later, "default" is "scram_sha_1". This setting isn't used when AuthType is set to "no".

    *)
  11. auth_type : auth_type_value option;
    (*

    The authentication type you use to access the MongoDB source endpoint.

    When when set to "no", user name and password parameters are not used and can be empty.

    *)
  12. database_name : string_ option;
    (*

    The database name on the MongoDB source endpoint.

    *)
  13. port : integer_optional option;
    (*

    The port value for the MongoDB source endpoint.

    *)
  14. server_name : string_ option;
    (*

    The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the server name for any of the servers in the replication set.

    *)
  15. password : secret_string option;
    (*

    The password for the user account you use to access the MongoDB source endpoint.

    *)
  16. username : string_ option;
    (*

    The user name you use to access the MongoDB source endpoint.

    *)
}

Provides information that defines a MongoDB endpoint.

type nonrec mongo_db_data_provider_settings = {
  1. auth_mechanism : auth_mechanism_value option;
    (*

    The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

    *)
  2. auth_source : string_ option;
    (*

    The MongoDB database name. This setting isn't used when AuthType is set to "no".

    The default is "admin".

    *)
  3. auth_type : auth_type_value option;
    (*

    The authentication type for the database connection. Valid values are PASSWORD or NO.

    *)
  4. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  5. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the MongoDB data provider. The default value is none.

    *)
  6. database_name : string_ option;
    (*

    The database name on the MongoDB data provider.

    *)
  7. port : integer_optional option;
    (*

    The port value for the MongoDB data provider.

    *)
  8. server_name : string_ option;
    (*

    The name of the MongoDB server.

    *)
}

Provides information that defines a MongoDB data provider.

type nonrec modify_replication_task_response = {
  1. replication_task : replication_task option;
    (*

    The replication task that was modified.

    *)
}
type nonrec modify_replication_task_message = {
  1. task_data : string_ option;
    (*

    Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

    *)
  2. cdc_stop_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

    *)
  3. cdc_start_position : string_ option;
    (*

    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.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    *)
  4. cdc_start_time : t_stamp option;
    (*

    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.

    Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

    *)
  5. replication_task_settings : string_ option;
    (*

    JSON file that contains settings for the task, such as task metadata settings.

    *)
  6. table_mappings : string_ option;
    (*

    When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.

    *)
  7. migration_type : migration_type_value option;
    (*

    The migration type. Valid values: full-load | cdc | full-load-and-cdc

    *)
  8. replication_task_identifier : string_ option;
    (*

    The replication task identifier.

    Constraints:

    • Must contain 1-255 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    *)
  9. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
}
type nonrec modify_replication_subnet_group_response = {
  1. replication_subnet_group : replication_subnet_group option;
    (*

    The modified replication subnet group.

    *)
}
type nonrec modify_replication_subnet_group_message = {
  1. subnet_ids : subnet_identifier_list;
    (*

    A list of subnet IDs.

    *)
  2. replication_subnet_group_description : string_ option;
    (*

    A description for the replication instance subnet group.

    *)
  3. replication_subnet_group_identifier : string_;
    (*

    The name of the replication instance subnet group.

    *)
}
type nonrec invalid_subnet = {
  1. message : exception_message option;
}

The subnet provided isn't valid.

type nonrec modify_replication_instance_response = {
  1. replication_instance : replication_instance option;
    (*

    The modified replication instance.

    *)
}
type nonrec modify_replication_instance_message = {
  1. kerberos_authentication_settings : kerberos_authentication_settings option;
    (*

    Specifies the settings required for kerberos authentication when modifying a replication instance.

    *)
  2. network_type : string_ option;
    (*

    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.

    *)
  3. replication_instance_identifier : string_ option;
    (*

    The replication instance identifier. This parameter is stored as a lowercase string.

    *)
  4. auto_minor_version_upgrade : boolean_optional option;
    (*

    A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.

    An outage does result if these factors apply:

    • This parameter is set to true during the maintenance window.
    • A newer minor version is available.
    • DMS has enabled automatic patching for the given engine version.
    *)
  5. allow_major_version_upgrade : boolean_ option;
    (*

    Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.

    This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

    *)
  6. engine_version : string_ option;
    (*

    The engine version number of the replication instance.

    When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

    *)
  7. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  8. preferred_maintenance_window : string_ option;
    (*

    The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

    Default: Uses existing setting

    Format: ddd:hh24:mi-ddd:hh24:mi

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes

    *)
  9. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    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.

    *)
  10. replication_instance_class : replication_instance_class option;
    (*

    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.

    *)
  11. apply_immediately : boolean_ option;
    (*

    Indicates whether the changes should be applied immediately or during the next maintenance window.

    *)
  12. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gigabytes) to be allocated for the replication instance.

    *)
  13. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
}
type nonrec insufficient_resource_capacity_fault = {
  1. message : exception_message option;
}

There are not enough resources allocated to the database migration.

type nonrec modify_replication_config_response = {
  1. replication_config : replication_config option;
    (*

    Information about the serverless replication config that was modified.

    *)
}
type nonrec modify_replication_config_message = {
  1. target_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.

    *)
  2. source_endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.

    *)
  3. compute_config : compute_config option;
    (*

    Configuration parameters for provisioning an DMS Serverless replication.

    *)
  4. supplemental_settings : string_ option;
    (*

    Additional settings for the replication.

    *)
  5. replication_settings : string_ option;
    (*

    The settings for the replication.

    *)
  6. table_mappings : string_ option;
    (*

    Table mappings specified in the replication.

    *)
  7. replication_type : migration_type_value option;
    (*

    The type of replication.

    *)
  8. replication_config_identifier : string_ option;
    (*

    The new replication config to apply to the replication.

    *)
  9. replication_config_arn : string_;
    (*

    The Amazon Resource Name of the replication to modify.

    *)
}
type nonrec data_provider_descriptor = {
  1. data_provider_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the data provider.

    *)
  2. data_provider_name : string_ option;
    (*

    The user-friendly name of the data provider.

    *)
  3. secrets_manager_access_role_arn : string_ option;
    (*

    The ARN of the role used to access Amazon Web Services Secrets Manager.

    *)
  4. secrets_manager_secret_id : string_ option;
    (*

    The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.

    *)
}

Information about a data provider.

type nonrec data_provider_descriptor_list = data_provider_descriptor list
type nonrec migration_project = {
  1. schema_conversion_application_attributes : sc_application_attributes option;
    (*

    The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

    *)
  2. description : string_ option;
    (*

    A user-friendly description of the migration project.

    *)
  3. transformation_rules : string_ option;
    (*

    The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

    *)
  4. instance_profile_name : string_ option;
    (*

    The name of the associated instance profile.

    *)
  5. instance_profile_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the instance profile for your migration project.

    *)
  6. target_data_provider_descriptors : data_provider_descriptor_list option;
    (*

    Information about the target data provider, including the name or ARN, and Secrets Manager parameters.

    *)
  7. source_data_provider_descriptors : data_provider_descriptor_list option;
    (*

    Information about the source data provider, including the name or ARN, and Secrets Manager parameters.

    *)
  8. migration_project_creation_time : iso8601_date_time option;
    (*

    The time when the migration project was created.

    *)
  9. migration_project_arn : string_ option;
    (*

    The ARN string that uniquely identifies the migration project.

    *)
  10. migration_project_name : string_ option;
    (*

    The name of the migration project.

    *)
}

Provides information that defines a migration project.

type nonrec modify_migration_project_response = {
  1. migration_project : migration_project option;
    (*

    The migration project that was modified.

    *)
}
type nonrec data_provider_descriptor_definition = {
  1. secrets_manager_access_role_arn : string_ option;
    (*

    The ARN of the role used to access Amazon Web Services Secrets Manager.

    *)
  2. secrets_manager_secret_id : string_ option;
    (*

    The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.

    *)
  3. data_provider_identifier : string_;
    (*

    The name or Amazon Resource Name (ARN) of the data provider.

    *)
}

Information about a data provider.

type nonrec data_provider_descriptor_definition_list = data_provider_descriptor_definition list
type nonrec modify_migration_project_message = {
  1. schema_conversion_application_attributes : sc_application_attributes option;
    (*

    The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

    *)
  2. description : string_ option;
    (*

    A user-friendly description of the migration project.

    *)
  3. transformation_rules : string_ option;
    (*

    The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

    *)
  4. instance_profile_identifier : string_ option;
    (*

    The name or Amazon Resource Name (ARN) for the instance profile.

    *)
  5. target_data_provider_descriptors : data_provider_descriptor_definition_list option;
    (*

    Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.

    *)
  6. source_data_provider_descriptors : data_provider_descriptor_definition_list option;
    (*

    Information about the source data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.

    *)
  7. migration_project_name : string_ option;
    (*

    A user-friendly name for the migration project.

    *)
  8. migration_project_identifier : string_;
    (*

    The identifier of the migration project. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

    *)
}
type nonrec instance_profile = {
  1. vpc_security_groups : string_list option;
    (*

    The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

    *)
  2. subnet_group_identifier : string_ option;
    (*

    The identifier of the subnet group that is associated with the instance profile.

    *)
  3. instance_profile_creation_time : iso8601_date_time option;
    (*

    The time the instance profile was created.

    *)
  4. description : string_ option;
    (*

    A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

    *)
  5. instance_profile_name : string_ option;
    (*

    The user-friendly name for the instance profile.

    *)
  6. network_type : string_ option;
    (*

    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

    *)
  7. publicly_accessible : boolean_optional option;
    (*

    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.

    *)
  8. kms_key_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.

    If you don't specify a value for the KmsKeyArn parameter, then DMS uses an Amazon Web Services owned encryption key to encrypt your resources.

    *)
  9. availability_zone : string_ option;
    (*

    The Availability Zone where the instance profile runs.

    *)
  10. instance_profile_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.

    *)
}

Provides information that defines an instance profile.

type nonrec modify_instance_profile_response = {
  1. instance_profile : instance_profile option;
    (*

    The instance profile that was modified.

    *)
}
type nonrec modify_instance_profile_message = {
  1. vpc_security_groups : string_list option;
    (*

    Specifies the VPC security groups to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

    *)
  2. subnet_group_identifier : string_ option;
    (*

    A subnet group to associate with the instance profile.

    *)
  3. description : string_ option;
    (*

    A user-friendly description for the instance profile.

    *)
  4. instance_profile_name : string_ option;
    (*

    A user-friendly name for the instance profile.

    *)
  5. network_type : string_ option;
    (*

    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

    *)
  6. publicly_accessible : boolean_optional option;
    (*

    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.

    *)
  7. kms_key_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.

    If you don't specify a value for the KmsKeyArn parameter, then DMS uses an Amazon Web Services owned encryption key to encrypt your resources.

    *)
  8. availability_zone : string_ option;
    (*

    The Availability Zone where the instance profile runs.

    *)
  9. instance_profile_identifier : string_;
    (*

    The identifier of the instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

    *)
}
type nonrec event_categories_list = string_ list
type nonrec event_subscription = {
  1. enabled : boolean_ option;
    (*

    Boolean value that indicates if the event subscription is enabled.

    *)
  2. event_categories_list : event_categories_list option;
    (*

    A lists of event categories.

    *)
  3. source_ids_list : source_ids_list option;
    (*

    A list of source Ids for the event subscription.

    *)
  4. source_type : string_ option;
    (*

    The type of DMS resource that generates events.

    Valid values: replication-instance | replication-server | security-group | replication-task

    *)
  5. subscription_creation_time : string_ option;
    (*

    The time the DMS event notification subscription was created.

    *)
  6. status : string_ option;
    (*

    The status of the DMS event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

    *)
  7. sns_topic_arn : string_ option;
    (*

    The topic ARN of the DMS event notification subscription.

    *)
  8. cust_subscription_id : string_ option;
    (*

    The DMS event notification subscription Id.

    *)
  9. customer_aws_id : string_ option;
    (*

    The Amazon Web Services customer account associated with the DMS event notification subscription.

    *)
}

Describes an event notification subscription created by the CreateEventSubscription operation.

type nonrec modify_event_subscription_response = {
  1. event_subscription : event_subscription option;
    (*

    The modified event subscription.

    *)
}
type nonrec modify_event_subscription_message = {
  1. enabled : boolean_optional option;
    (*

    A Boolean value; set to true to activate the subscription.

    *)
  2. event_categories : event_categories_list option;
    (*

    A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.

    *)
  3. source_type : string_ option;
    (*

    The type of DMS resource that generates the events you want to subscribe to.

    Valid values: replication-instance | replication-task

    *)
  4. sns_topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    *)
  5. subscription_name : string_;
    (*

    The name of the DMS event notification subscription to be modified.

    *)
}
type nonrec kms_throttling_fault = {
  1. message : exception_message option;
}

This request triggered KMS request throttling.

type nonrec dynamo_db_settings = {
  1. service_access_role_arn : string_;
    (*

    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

    *)
}

Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.

type nonrec dms_transfer_settings = {
  1. bucket_name : string_ option;
    (*

    The name of the S3 bucket to use.

    *)
  2. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

    *)
}

The settings in JSON format for the DMS Transfer type source endpoint.

type nonrec message_format_value =
  1. | JSON_UNFORMATTED
  2. | JSON
type nonrec kinesis_settings = {
  1. use_large_integer_value : boolean_optional option;
    (*

    Specifies using the large integer value with Kinesis.

    *)
  2. no_hex_prefix : boolean_optional option;
    (*

    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

    *)
  3. include_null_and_empty : boolean_optional option;
    (*

    Include NULL and empty columns for records migrated to the endpoint. The default is false.

    *)
  4. include_control_details : boolean_optional option;
    (*

    Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.

    *)
  5. include_table_alter_operations : boolean_optional option;
    (*

    Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

    *)
  6. partition_include_schema_table : boolean_optional option;
    (*

    Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false.

    *)
  7. include_partition_value : boolean_optional option;
    (*

    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.

    *)
  8. include_transaction_details : boolean_optional option;
    (*

    Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

    *)
  9. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.

    *)
  10. message_format : message_format_value option;
    (*

    The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

    *)
  11. stream_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

    *)
}

Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

type nonrec kafka_security_protocol =
  1. | SASL_SSL
  2. | SSL_ENCRYPTION
  3. | SSL_AUTHENTICATION
  4. | PLAINTEXT
type nonrec kafka_sasl_mechanism =
  1. | PLAIN
  2. | SCRAM_SHA_512
type nonrec kafka_ssl_endpoint_identification_algorithm =
  1. | HTTPS
  2. | NONE
type nonrec kafka_settings = {
  1. use_large_integer_value : boolean_optional option;
    (*

    Specifies using the large integer value with Kafka.

    *)
  2. ssl_endpoint_identification_algorithm : kafka_ssl_endpoint_identification_algorithm option;
    (*

    Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.

    *)
  3. sasl_mechanism : kafka_sasl_mechanism option;
    (*

    For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.

    *)
  4. no_hex_prefix : boolean_optional option;
    (*

    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

    *)
  5. sasl_password : secret_string option;
    (*

    The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

    *)
  6. sasl_username : string_ option;
    (*

    The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

    *)
  7. ssl_ca_certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.

    *)
  8. ssl_client_key_password : secret_string option;
    (*

    The password for the client private key used to securely connect to a Kafka target endpoint.

    *)
  9. ssl_client_key_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

    *)
  10. ssl_client_certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

    *)
  11. security_protocol : kafka_security_protocol option;
    (*

    Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.

    *)
  12. include_null_and_empty : boolean_optional option;
    (*

    Include NULL and empty columns for records migrated to the endpoint. The default is false.

    *)
  13. message_max_bytes : integer_optional option;
    (*

    The maximum size in bytes for records created on the endpoint The default is 1,000,000.

    *)
  14. include_control_details : boolean_optional option;
    (*

    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.

    *)
  15. include_table_alter_operations : boolean_optional option;
    (*

    Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

    *)
  16. partition_include_schema_table : boolean_optional option;
    (*

    Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false.

    *)
  17. include_partition_value : boolean_optional option;
    (*

    Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.

    *)
  18. include_transaction_details : boolean_optional option;
    (*

    Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

    *)
  19. message_format : message_format_value option;
    (*

    The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

    *)
  20. topic : string_ option;
    (*

    The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.

    *)
  21. broker : string_ option;
    (*

    A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form

     {i broker-hostname-or-ip}:{i port}

    . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.

    *)
}

Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

type nonrec elasticsearch_settings = {
  1. use_new_mapping_type : boolean_optional option;
    (*

    Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

    *)
  2. error_retry_duration : integer_optional option;
    (*

    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

    *)
  3. full_load_error_percentage : integer_optional option;
    (*

    The maximum percentage of records that can fail to be written before a full load operation stops.

    To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

    *)
  4. endpoint_uri : string_;
    (*

    The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

    *)
  5. service_access_role_arn : string_;
    (*

    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

    *)
}

Provides information that defines an OpenSearch endpoint.

type nonrec microsoft_sql_server_settings = {
  1. authentication_method : sql_server_authentication_method option;
    (*

    Specifies the authentication method to be used with Microsoft SQL Server.

    *)
  2. force_lob_lookup : boolean_optional option;
    (*

    Forces LOB lookup on inline LOB.

    *)
  3. tlog_access_mode : tlog_access_mode option;
    (*

    Indicates the mode used to fetch CDC data.

    *)
  4. trim_space_in_char : boolean_optional option;
    (*

    Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. Setting TrimSpaceInChar does not left-trim data. The default value is true.

    *)
  5. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.

    *)
  6. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  7. use_third_party_backup_device : boolean_optional option;
    (*

    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.

    *)
  8. use_bcp_full_load : boolean_optional option;
    (*

    Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.

    *)
  9. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  10. server_name : string_ option;
    (*

    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the

     {{:https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html}Endpoint}.Address

    field.

    *)
  11. safeguard_policy : safeguard_policy option;
    (*

    Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.

    Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.

    Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.

    *)
  12. read_backup_only : boolean_optional option;
    (*

    When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.

    *)
  13. query_single_always_on_node : boolean_optional option;
    (*

    Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.

    *)
  14. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  15. control_tables_file_group : string_ option;
    (*

    Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.

    *)
  16. database_name : string_ option;
    (*

    Database name for the endpoint.

    *)
  17. bcp_packet_size : integer_optional option;
    (*

    The maximum size of the packets (in bytes) used to transfer data using BCP.

    *)
  18. port : integer_optional option;
    (*

    Endpoint TCP port.

    *)
}

Provides information that defines a Microsoft SQL Server endpoint.

type nonrec ibm_db2_settings = {
  1. keep_csv_files : boolean_optional option;
    (*

    If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.

    The default value is false.

    *)
  2. max_file_size : integer_optional option;
    (*

    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.

    *)
  3. write_buffer_size : integer_optional option;
    (*

    The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB).

    *)
  4. load_timeout : integer_optional option;
    (*

    The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).

    *)
  5. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.

    *)
  6. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  7. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  8. max_k_bytes_per_read : integer_optional option;
    (*

    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.

    *)
  9. current_lsn : string_ option;
    (*

    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.

    *)
  10. set_data_capture_changes : boolean_optional option;
    (*

    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.

    *)
  11. server_name : string_ option;
    (*

    Fully qualified domain name of the endpoint.

    *)
  12. port : integer_optional option;
    (*

    Endpoint TCP port. The default value is 50000.

    *)
  13. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  14. database_name : string_ option;
    (*

    Database name for the endpoint.

    *)
}

Provides information that defines an IBM Db2 LUW endpoint.

type nonrec doc_db_settings = {
  1. replicate_shard_collections : boolean_optional option;
    (*

    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.
    *)
  2. use_update_look_up : boolean_optional option;
    (*

    If 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.

    *)
  3. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.

    *)
  4. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  5. kms_key_id : string_ option;
    (*

    The KMS key identifier that is used to encrypt the content 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.

    *)
  6. docs_to_investigate : integer_optional option;
    (*

    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".

    Must be a positive value greater than 0. Default value is 1000.

    *)
  7. extract_doc_id : boolean_optional option;
    (*

    Specifies the document ID. Use this setting when NestingLevel is set to "none".

    Default value is "false".

    *)
  8. nesting_level : nesting_level_value option;
    (*

    Specifies either document or table mode.

    Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.

    *)
  9. database_name : string_ option;
    (*

    The database name on the DocumentDB source endpoint.

    *)
  10. port : integer_optional option;
    (*

    The port value for the DocumentDB source endpoint.

    *)
  11. server_name : string_ option;
    (*

    The name of the server on the DocumentDB source endpoint.

    *)
  12. password : secret_string option;
    (*

    The password for the user account you use to access the DocumentDB source endpoint.

    *)
  13. username : string_ option;
    (*

    The user name you use to access the DocumentDB source endpoint.

    *)
}

Provides information that defines a DocumentDB endpoint.

type nonrec gcp_my_sql_settings = {
  1. secrets_manager_secret_id : string_ option;
    (*

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

    *)
  2. secrets_manager_access_role_arn : string_ option;
    (*

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

    *)
  3. username : string_ option;
    (*

    Endpoint connection user name.

    *)
  4. server_timezone : string_ option;
    (*

    Specifies the time zone for the source MySQL database.

    Example: serverTimezone=US/Pacific;

    Note: Do not enclose time zones in single quotes.

    *)
  5. server_name : string_ option;
    (*

    The MySQL host name.

    *)
  6. port : integer_optional option;
    (*

    Endpoint TCP port.

    *)
  7. password : secret_string option;
    (*

    Endpoint connection password.

    *)
  8. parallel_load_threads : integer_optional option;
    (*

    Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.

    Example: parallelLoadThreads=1

    *)
  9. max_file_size : integer_optional option;
    (*

    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

    Example: maxFileSize=512

    *)
  10. target_db_type : target_db_type option;
    (*

    Specifies where to migrate source tables on the target, either to a single database or multiple databases.

    Example: targetDbType=MULTIPLE_DATABASES

    *)
  11. events_poll_interval : integer_optional option;
    (*

    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.

    Example: eventsPollInterval=5;

    In the example, DMS checks for changes in the binary logs every five seconds.

    *)
  12. database_name : string_ option;
    (*

    Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

    *)
  13. clean_source_metadata_on_mismatch : boolean_optional option;
    (*

    Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance.

    *)
  14. after_connect_script : string_ option;
    (*

    Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.

    For this parameter, provide the code of the script itself, not the name of a file containing the script.

    *)
}

Settings in JSON format for the source GCP MySQL endpoint.

type nonrec lakehouse_settings = {
  1. arn : string_;
    (*

    The Amazon Resource Name (ARN) of the Lakehouse resource that serves as the target for this endpoint.

    *)
}

Provides information that defines a Lakehouse endpoint. This endpoint type is used for zero-ETL integrations with Lakehouse data warehouses.

type nonrec endpoint = {
  1. lakehouse_settings : lakehouse_settings option;
    (*

    Settings in JSON format for the target Lakehouse endpoint. This parameter applies to endpoints that are automatically created by DMS for a Lakehouse data warehouse as part of a zero-ETL integration.

    *)
  2. timestream_settings : timestream_settings option;
    (*

    The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

    *)
  3. gcp_my_sql_settings : gcp_my_sql_settings option;
    (*

    Settings in JSON format for the source GCP MySQL endpoint.

    *)
  4. redis_settings : redis_settings option;
    (*

    The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

    *)
  5. doc_db_settings : doc_db_settings option;
  6. ibm_db2_settings : ibm_db2_settings option;
    (*

    The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

    *)
  7. microsoft_sql_server_settings : microsoft_sql_server_settings option;
    (*

    The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

    *)
  8. sybase_settings : sybase_settings option;
    (*

    The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

    *)
  9. oracle_settings : oracle_settings option;
    (*

    The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

    *)
  10. my_sql_settings : my_sql_settings option;
    (*

    The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

    *)
  11. postgre_sql_settings : postgre_sql_settings option;
    (*

    The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

    *)
  12. redshift_settings : redshift_settings option;
    (*

    Settings for the Amazon Redshift endpoint.

    *)
  13. neptune_settings : neptune_settings option;
    (*

    The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

    *)
  14. elasticsearch_settings : elasticsearch_settings option;
    (*

    The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.

    *)
  15. kafka_settings : kafka_settings option;
    (*

    The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

    *)
  16. kinesis_settings : kinesis_settings option;
    (*

    The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

    *)
  17. mongo_db_settings : mongo_db_settings option;
    (*

    The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

    *)
  18. dms_transfer_settings : dms_transfer_settings option;
    (*

    The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

    *)
  19. s3_settings : s3_settings option;
    (*

    The settings for the S3 target endpoint. For more information, see the S3Settings structure.

    *)
  20. dynamo_db_settings : dynamo_db_settings option;
    (*

    The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

    *)
  21. is_read_only : boolean_optional option;
    (*

    Indicates whether the endpoint is read-only. When set to true, this endpoint is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only endpoints through their associated zero-ETL integration.

    *)
  22. external_id : string_ option;
    (*

    Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

    *)
  23. external_table_definition : string_ option;
    (*

    The external table definition.

    *)
  24. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

    *)
  25. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the endpoint. The default value is none.

    *)
  26. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

    *)
  27. endpoint_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
  28. kms_key_id : string_ option;
    (*

    An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

    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.

    *)
  29. status : string_ option;
    (*

    The status of the endpoint.

    *)
  30. extra_connection_attributes : string_ option;
    (*

    Additional connection attributes used to connect to the endpoint.

    *)
  31. database_name : string_ option;
    (*

    The name of the database at the endpoint.

    *)
  32. port : integer_optional option;
    (*

    The port value used to access the endpoint.

    *)
  33. server_name : string_ option;
    (*

    The name of the server at the endpoint.

    *)
  34. username : string_ option;
    (*

    The user name used to connect to the endpoint.

    *)
  35. engine_display_name : string_ option;
    (*

    The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

    *)
  36. engine_name : string_ option;
    (*

    The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

    *)
  37. endpoint_type : replication_endpoint_type_value option;
    (*

    The type of endpoint. Valid values are source and target.

    *)
  38. endpoint_identifier : string_ option;
    (*

    The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

    *)
}

Describes an endpoint of a database instance in response to operations such as the following:

  • CreateEndpoint
  • DescribeEndpoint
  • ModifyEndpoint
type nonrec modify_endpoint_response = {
  1. endpoint : endpoint option;
    (*

    The modified endpoint.

    *)
}
type nonrec modify_endpoint_message = {
  1. timestream_settings : timestream_settings option;
    (*

    Settings in JSON format for the target Amazon Timestream endpoint.

    *)
  2. gcp_my_sql_settings : gcp_my_sql_settings option;
    (*

    Settings in JSON format for the source GCP MySQL endpoint.

    *)
  3. exact_settings : boolean_optional option;
    (*

    If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

    • It replaces any endpoint settings that already exist with new values, for settings with the same names.
    • It creates new endpoint settings that you specify in the call, for settings with different names.

    For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

    However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

    *)
  4. redis_settings : redis_settings option;
    (*

    Settings in JSON format for the Redis target endpoint.

    *)
  5. doc_db_settings : doc_db_settings option;
    (*

    Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

    *)
  6. ibm_db2_settings : ibm_db2_settings option;
    (*

    Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

    *)
  7. microsoft_sql_server_settings : microsoft_sql_server_settings option;
    (*

    Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

    *)
  8. sybase_settings : sybase_settings option;
    (*

    Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

    *)
  9. oracle_settings : oracle_settings option;
    (*

    Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

    *)
  10. my_sql_settings : my_sql_settings option;
    (*

    Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

    *)
  11. postgre_sql_settings : postgre_sql_settings option;
    (*

    Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

    *)
  12. redshift_settings : redshift_settings option;
  13. neptune_settings : neptune_settings option;
    (*

    Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

    *)
  14. elasticsearch_settings : elasticsearch_settings option;
    (*

    Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

    *)
  15. kafka_settings : kafka_settings option;
    (*

    Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

    *)
  16. kinesis_settings : kinesis_settings option;
    (*

    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

    *)
  17. mongo_db_settings : mongo_db_settings option;
    (*

    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

    *)
  18. dms_transfer_settings : dms_transfer_settings option;
    (*

    The settings in JSON format for the DMS transfer type of source endpoint.

    Attributes include the following:

    • serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
    • BucketName - The name of the S3 bucket to use.

    Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

    JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

    *)
  19. s3_settings : s3_settings option;
    (*

    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

    *)
  20. dynamo_db_settings : dynamo_db_settings option;
    (*

    Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

    *)
  21. external_table_definition : string_ option;
    (*

    The external table definition.

    *)
  22. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

    *)
  23. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the endpoint. The default value is none.

    *)
  24. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  25. extra_connection_attributes : string_ option;
    (*

    Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

    *)
  26. database_name : string_ option;
    (*

    The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

    *)
  27. port : integer_optional option;
    (*

    The port used by the endpoint database.

    *)
  28. server_name : string_ option;
    (*

    The name of the server where the endpoint database resides.

    *)
  29. password : secret_string option;
    (*

    The password to be used to login to the endpoint database.

    *)
  30. username : string_ option;
    (*

    The user name to be used to login to the endpoint database.

    *)
  31. engine_name : string_ option;
    (*

    The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

    *)
  32. endpoint_type : replication_endpoint_type_value option;
    (*

    The type of endpoint. Valid values are source and target.

    *)
  33. endpoint_identifier : string_ option;
    (*

    The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

    *)
  34. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}
type nonrec microsoft_sql_server_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  4. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none.

    *)
  5. database_name : string_ option;
    (*

    The database name on the Microsoft SQL Server data provider.

    *)
  6. port : integer_optional option;
    (*

    The port value for the Microsoft SQL Server data provider.

    *)
  7. server_name : string_ option;
    (*

    The name of the Microsoft SQL Server server.

    *)
}

Provides information that defines a Microsoft SQL Server data provider.

type nonrec doc_db_data_provider_settings = {
  1. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  2. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the DocumentDB data provider. The default value is none.

    *)
  3. database_name : string_ option;
    (*

    The database name on the DocumentDB data provider.

    *)
  4. port : integer_optional option;
    (*

    The port value for the DocumentDB data provider.

    *)
  5. server_name : string_ option;
    (*

    The name of the source DocumentDB server.

    *)
}

Provides information that defines a DocumentDB data provider.

type nonrec maria_db_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  4. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the MariaDB data provider. The default value is none.

    *)
  5. port : integer_optional option;
    (*

    The port value for the MariaDB data provider

    *)
  6. server_name : string_ option;
    (*

    The name of the MariaDB server.

    *)
}

Provides information that defines a MariaDB data provider.

type nonrec ibm_db2_luw_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. security_mechanism : integer_optional option;
    (*

    The security mechanism used for authenticating the connection to the IBM DB2 LUW database server. You can provide an integer value corresponding to a specific security mechanism, or leave this parameter empty to use the default behavior.

    *)
  4. encryption_algorithm : integer_optional option;
    (*

    The encryption algorithm used for securing the connection to the IBM DB2 LUW database server. You can provide an integer value corresponding to a specific encryption algorithm, or leave this parameter empty to use the default behavior.

    *)
  5. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  6. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the DB2 LUW data provider. The default value is none. Valid Values: none and verify-ca.

    *)
  7. database_name : string_ option;
    (*

    The database name on the DB2 LUW data provider.

    *)
  8. port : integer_optional option;
    (*

    The port value for the DB2 LUW data provider.

    *)
  9. server_name : string_ option;
    (*

    The name of the DB2 LUW server.

    *)
}

Provides information about an IBM DB2 LUW data provider.

type nonrec ibm_db2z_os_data_provider_settings = {
  1. s3_access_role_arn : string_ option;
    (*

    The ARN for the role the application uses to access its Amazon S3 bucket.

    *)
  2. s3_path : string_ option;
    (*

    The path for the Amazon S3 bucket that the application uses for accessing the user-defined schema.

    *)
  3. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    *)
  4. ssl_mode : dms_ssl_mode_value option;
    (*

    The SSL mode used to connect to the DB2 for z/OS data provider. The default value is none. Valid Values: none and verify-ca.

    *)
  5. database_name : string_ option;
    (*

    The database name on the DB2 for z/OS data provider.

    *)
  6. port : integer_optional option;
    (*

    The port value for the DB2 for z/OS data provider.

    *)
  7. server_name : string_ option;
    (*

    The name of the DB2 for z/OS server.

    *)
}

Provides information about an IBM DB2 for z/OS data provider.

type nonrec data_provider_settings =
  1. | MongoDbSettings of mongo_db_data_provider_settings
    (*

    Provides information that defines a MongoDB data provider.

    *)
  2. | IbmDb2zOsSettings of ibm_db2z_os_data_provider_settings
    (*

    Provides information that defines an IBM DB2 for z/OS data provider.

    *)
  3. | IbmDb2LuwSettings of ibm_db2_luw_data_provider_settings
    (*

    Provides information that defines an IBM DB2 LUW data provider.

    *)
  4. | MariaDbSettings of maria_db_data_provider_settings
    (*

    Provides information that defines a MariaDB data provider.

    *)
  5. | DocDbSettings of doc_db_data_provider_settings
  6. | MicrosoftSqlServerSettings of microsoft_sql_server_data_provider_settings
  7. | SybaseAseSettings of sybase_ase_data_provider_settings
  8. | OracleSettings of oracle_data_provider_settings
  9. | MySqlSettings of my_sql_data_provider_settings
  10. | PostgreSqlSettings of postgre_sql_data_provider_settings
  11. | RedshiftSettings of redshift_data_provider_settings

Provides information that defines a data provider.

type nonrec data_provider = {
  1. settings : data_provider_settings option;
    (*

    The settings in JSON format for a data provider.

    *)
  2. virtual : boolean_optional option;
    (*

    Indicates whether the data provider is virtual.

    *)
  3. engine : string_ option;
    (*

    The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

    *)
  4. description : string_ option;
    (*

    A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

    *)
  5. data_provider_creation_time : iso8601_date_time option;
    (*

    The time the data provider was created.

    *)
  6. data_provider_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the data provider.

    *)
  7. data_provider_name : string_ option;
    (*

    The name of the data provider.

    *)
}

Provides information that defines a data provider.

type nonrec modify_data_provider_response = {
  1. data_provider : data_provider option;
    (*

    The data provider that was modified.

    *)
}
type nonrec modify_data_provider_message = {
  1. settings : data_provider_settings option;
    (*

    The settings in JSON format for a data provider.

    *)
  2. exact_settings : boolean_optional option;
    (*

    If this attribute is Y, the current call to ModifyDataProvider replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyDataProvider does two things:

    • It replaces any data provider settings that already exist with new values, for settings with the same names.
    • It creates new data provider settings that you specify in the call, for settings with different names.
    *)
  3. virtual : boolean_optional option;
    (*

    Indicates whether the data provider is virtual.

    *)
  4. engine : string_ option;
    (*

    The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

    *)
  5. description : string_ option;
    (*

    A user-friendly description of the data provider.

    *)
  6. data_provider_name : string_ option;
    (*

    The name of the data provider.

    *)
  7. data_provider_identifier : string_;
    (*

    The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

    *)
}
type nonrec modify_data_migration_response = {
  1. data_migration : data_migration option;
    (*

    Information about the modified data migration.

    *)
}
type nonrec modify_data_migration_message = {
  1. selection_rules : secret_string option;
    (*

    A JSON-formatted string that defines what objects to include and exclude from the migration.

    *)
  2. number_of_jobs : integer_optional option;
    (*

    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

    *)
  3. target_data_settings : target_data_settings option;
    (*

    The new information about the target data provider for the data migration.

    *)
  4. source_data_settings : source_data_settings option;
    (*

    The new information about the source data provider for the data migration.

    *)
  5. data_migration_type : migration_type_value option;
    (*

    The new migration type for the data migration.

    *)
  6. service_access_role_arn : string_ option;
    (*

    The new service access role ARN for the data migration.

    *)
  7. enable_cloudwatch_logs : boolean_optional option;
    (*

    Whether to enable Cloudwatch logs for the data migration.

    *)
  8. data_migration_name : string_ option;
    (*

    The new name for the data migration.

    *)
  9. data_migration_identifier : string_;
    (*

    The identifier (name or ARN) of the data migration to modify.

    *)
}
type nonrec modify_conversion_configuration_response = {
  1. migration_project_identifier : string_ option;
    (*

    The name or Amazon Resource Name (ARN) of the modified configuration.

    *)
}
type nonrec modify_conversion_configuration_message = {
  1. conversion_configuration : string_;
    (*

    The new conversion configuration.

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec migration_project_list = migration_project list
type nonrec metadata_model_reference = {
  1. selection_rules : string_ option;
    (*

    The JSON string representing metadata model location.

    *)
  2. metadata_model_name : string_ option;
    (*

    The name of the metadata model.

    *)
}

A reference to a metadata model, including its name and selection rules for location identification.

type nonrec metadata_model_reference_list = metadata_model_reference list
type nonrec marker = string
type nonrec list_tags_for_resource_response = {
  1. tag_list : tag_list option;
    (*

    A list of tags for the resource.

    *)
}
type nonrec arn_list = string_ list
type nonrec list_tags_for_resource_message = {
  1. resource_arn_list : arn_list option;
    (*

    List of ARNs that identify multiple DMS resources that you want to list tags for. This returns a list of keys (tag names) and their associated tag values. It also returns each tag's associated ResourceArn value, which is the ARN of the resource for which each listed tag is created.

    *)
  2. resource_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource to list tags for. This returns a list of keys (names of tags) created for the resource and their associated tag values.

    *)
}
type nonrec limitation = {
  1. type_ : string_ option;
    (*

    The type of the limitation, such as action required, upgrade required, and limited feature.

    *)
  2. impact : string_ option;
    (*

    The impact of the limitation. You can use this parameter to prioritize limitations that you want to address. Valid values include "Blocker", "High", "Medium", and "Low".

    *)
  3. description : string_ option;
    (*

    A description of the limitation. Provides additional information about the limitation, and includes recommended actions that you can take to address or avoid this limitation.

    *)
  4. name : string_ option;
    (*

    The name of the limitation. Describes unsupported database features, migration action items, and other limitations.

    *)
  5. engine_name : string_ option;
    (*

    The name of the target engine that Fleet Advisor should use in the target engine recommendation. Valid values include "rds-aurora-mysql", "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and "rds-postgresql".

    *)
  6. database_id : string_ option;
    (*

    The identifier of the source database.

    *)
}

Provides information about the limitations of target Amazon Web Services engines.

Your source database might include features that the target Amazon Web Services engine doesn't support. Fleet Advisor lists these features as limitations. You should consider these limitations during database migration. For each limitation, Fleet Advisor recommends an action that you can take to address or avoid this limitation.

type nonrec limitation_list = limitation list
type nonrec inventory_data = {
  1. number_of_schemas : integer_optional option;
    (*

    The number of schemas in the Fleet Advisor collector inventory.

    *)
  2. number_of_databases : integer_optional option;
    (*

    The number of databases in the Fleet Advisor collector inventory.

    *)
}

Describes a Fleet Advisor collector inventory.

type nonrec invalid_certificate_fault = {
  1. message : exception_message option;
}

The certificate was not valid.

type nonrec instance_profile_list = instance_profile list
type nonrec individual_assessment_name_list = string_ list
type nonrec certificate_wallet = bytes
type nonrec certificate = {
  1. kms_key_id : string_ option;
    (*

    An KMS key identifier that is used to encrypt the certificate.

    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.

    *)
  2. key_length : integer_optional option;
    (*

    The key length of the cryptographic algorithm being used.

    *)
  3. signing_algorithm : string_ option;
    (*

    The signing algorithm for the certificate.

    *)
  4. valid_to_date : t_stamp option;
    (*

    The final date that the certificate is valid.

    *)
  5. valid_from_date : t_stamp option;
    (*

    The beginning date that the certificate is valid.

    *)
  6. certificate_owner : string_ option;
    (*

    The owner of the certificate.

    *)
  7. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the certificate.

    *)
  8. certificate_wallet : certificate_wallet option;
    (*

    The location of an imported Oracle Wallet certificate for use with SSL. Example: filebase64("${path.root}/rds-ca-2019-root.sso")

    *)
  9. certificate_pem : string_ option;
    (*

    The contents of a .pem file, which contains an X.509 certificate.

    *)
  10. certificate_creation_date : t_stamp option;
    (*

    The date that the certificate was created.

    *)
  11. certificate_identifier : string_ option;
    (*

    A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

    *)
}

The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

type nonrec import_certificate_response = {
  1. certificate : certificate option;
    (*

    The certificate to be uploaded.

    *)
}
type nonrec import_certificate_message = {
  1. kms_key_id : string_ option;
    (*

    An KMS key identifier that is used to encrypt the certificate.

    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.

    *)
  2. tags : tag_list option;
    (*

    The tags associated with the certificate.

    *)
  3. certificate_wallet : certificate_wallet option;
    (*

    The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso file using the fileb:// prefix. You can't provide the certificate inline.

    Example: filebase64("${path.root}/rds-ca-2019-root.sso")

    *)
  4. certificate_pem : secret_string option;
    (*

    The contents of a .pem file, which contains an X.509 certificate.

    *)
  5. certificate_identifier : string_;
    (*

    A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

    *)
}
type nonrec get_target_selection_rules_response = {
  1. target_selection_rules : string_ option;
    (*

    The JSON string representing the counterpart selection rules in the target.

    *)
}
type nonrec get_target_selection_rules_message = {
  1. selection_rules : string_;
    (*

    The JSON string representing the source selection rules for conversion. Selection rules must contain only supported metadata model types. For more information, see Selection Rules in the DMS User Guide.

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec fleet_advisor_schema_object_response = {
  1. code_size : long_optional option;
    (*

    The size level of the code in a schema object in a Fleet Advisor collector inventory.

    *)
  2. code_line_count : long_optional option;
    (*

    The number of lines of code in a schema object in a Fleet Advisor collector inventory.

    *)
  3. number_of_objects : long_optional option;
    (*

    The number of objects in a schema object in a Fleet Advisor collector inventory.

    *)
  4. object_type : string_ option;
    (*

    The type of the schema object, as reported by the database engine. Examples include the following:

    • function
    • trigger
    • SYSTEM_TABLE
    • QUEUE
    *)
  5. schema_id : string_ option;
    (*

    The ID of a schema object in a Fleet Advisor collector inventory.

    *)
}

Describes a schema object in a Fleet Advisor collector inventory.

type nonrec fleet_advisor_schema_object_list = fleet_advisor_schema_object_response list
type nonrec fleet_advisor_schema_list = schema_response list
type nonrec fleet_advisor_lsa_analysis_response = {
  1. status : string_ option;
    (*

    The status of an LSA analysis run by a Fleet Advisor collector.

    *)
  2. lsa_analysis_id : string_ option;
    (*

    The ID of an LSA analysis run by a Fleet Advisor collector.

    *)
}

Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.

type nonrec fleet_advisor_lsa_analysis_response_list = fleet_advisor_lsa_analysis_response list
type nonrec filter_value_list = string_ list
type nonrec filter = {
  1. values : filter_value_list;
    (*

    The filter value, which can specify one or more values used to narrow the returned results.

    *)
  2. name : string_;
    (*

    The name of the filter as specified for a Describe* or similar operation.

    *)
}

Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

type nonrec filter_list = filter list
type nonrec export_metadata_model_assessment_result_entry = {
  1. object_ur_l : string_ option;
    (*

    The URL for the object containing the exported metadata model assessment.

    *)
  2. s3_object_key : string_ option;
    (*

    The object key for the object containing the exported metadata model assessment.

    *)
}

Provides information about an exported metadata model assessment.

type nonrec export_metadata_model_assessment_response = {
  1. csv_report : export_metadata_model_assessment_result_entry option;
    (*

    The Amazon S3 details for an assessment exported in CSV format.

    *)
  2. pdf_report : export_metadata_model_assessment_result_entry option;
    (*

    The Amazon S3 details for an assessment exported in PDF format.

    *)
}
type nonrec assessment_report_type =
  1. | CSV
  2. | PDF
type nonrec assessment_report_types_list = assessment_report_type list
type nonrec export_metadata_model_assessment_message = {
  1. assessment_report_types : assessment_report_types_list option;
    (*

    The file format of the assessment file.

    *)
  2. file_name : string_ option;
    (*

    The name of the assessment file to create in your Amazon S3 bucket.

    *)
  3. selection_rules : string_;
    (*

    A value that specifies the database objects to assess.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec event_subscriptions_list = event_subscription list
type nonrec event = {
  1. date : t_stamp option;
    (*

    The date of the event.

    *)
  2. event_categories : event_categories_list option;
    (*

    The event categories available for the specified source type.

    *)
  3. message : string_ option;
    (*

    The event message.

    *)
  4. source_type : source_type option;
    (*

    The type of DMS resource that generates events.

    Valid values: replication-instance | endpoint | replication-task

    *)
  5. source_identifier : string_ option;
    (*

    The identifier of an event source.

    *)
}

Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the DMS resource type.

type nonrec event_list = event list
type nonrec event_category_group = {
  1. event_categories : event_categories_list option;
    (*

    A list of event categories from a source type that you've chosen.

    *)
  2. source_type : string_ option;
    (*

    The type of DMS resource that generates events.

    Valid values: replication-instance | replication-server | security-group | replication-task

    *)
}

Lists categories of events subscribed to, and generated by, the applicable DMS resource type. This data type appears in response to the DescribeEventCategories action.

type nonrec event_category_group_list = event_category_group list
type nonrec available_upgrades_list = string_ list
type nonrec engine_version = {
  1. available_upgrades : available_upgrades_list option;
    (*

    The list of valid replication instance versions that you can upgrade to.

    *)
  2. force_upgrade_date : t_stamp option;
    (*

    The date when the replication instance will have a version upgrade forced.

    *)
  3. deprecation_date : t_stamp option;
    (*

    The date when the replication instance version will be deprecated and can no longer be requested.

    *)
  4. auto_upgrade_date : t_stamp option;
    (*

    The date when the replication instance will be automatically upgraded. This setting only applies if the auto-minor-version setting is enabled.

    *)
  5. launch_date : t_stamp option;
    (*

    The date when the replication instance version became publicly available.

    *)
  6. release_status : release_status_values option;
    (*

    The release status of the replication instance version.

    *)
  7. lifecycle : string_ option;
    (*

    The lifecycle status of the replication instance version. Valid values are DEPRECATED, DEFAULT_VERSION, and ACTIVE.

    *)
  8. version : string_ option;
    (*

    The version number of the replication instance.

    *)
}

Provides information about a replication instance version.

type nonrec engine_version_list = engine_version list
type nonrec endpoint_setting_type_value =
  1. | ENUM
  2. | INTEGER
  3. | BOOLEAN
  4. | STRING
type nonrec endpoint_setting_enum_values = string_ list
type nonrec endpoint_setting = {
  1. default_value : string_ option;
    (*

    The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.

    *)
  2. int_value_max : integer_optional option;
    (*

    The maximum value of an endpoint setting that is of type int.

    *)
  3. int_value_min : integer_optional option;
    (*

    The minimum value of an endpoint setting that is of type int.

    *)
  4. applicability : string_ option;
    (*

    The relevance or validity of an endpoint setting for an engine name and its endpoint type.

    *)
  5. units : string_ option;
    (*

    The unit of measure for this endpoint setting.

    *)
  6. sensitive : boolean_optional option;
    (*

    A value that marks this endpoint setting as sensitive.

    *)
  7. enum_values : endpoint_setting_enum_values option;
    (*

    Enumerated values to use for this endpoint.

    *)
  8. type_ : endpoint_setting_type_value option;
    (*

    The type of endpoint. Valid values are source and target.

    *)
  9. name : string_ option;
    (*

    The name that you want to give the endpoint settings.

    *)
}

Endpoint settings.

type nonrec endpoint_settings_list = endpoint_setting list
type nonrec endpoint_list = endpoint list
type nonrec describe_table_statistics_response = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. table_statistics : table_statistics_list option;
    (*

    The table statistics.

    *)
  3. replication_task_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
}
type nonrec describe_table_statistics_message = {
  1. filters : filter_list option;
    (*

    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.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication task.

    *)
}
type nonrec describe_schemas_response = {
  1. schemas : schema_list option;
    (*

    The described schema.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_schemas_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}
type nonrec describe_replications_response = {
  1. replications : replication_list option;
    (*

    The replication descriptions.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replications_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the replications.

    Valid filter names: replication-config-arn | replication-config-id

    *)
}
type nonrec describe_replication_tasks_response = {
  1. replication_tasks : replication_task_list option;
    (*

    A description of the replication tasks.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_tasks_message = {
  1. without_settings : boolean_optional option;
    (*

    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).

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. filters : filter_list option;
    (*

    Filters applied to replication tasks.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    *)
}
type nonrec describe_replication_task_individual_assessments_response = {
  1. replication_task_individual_assessments : replication_task_individual_assessment_list option;
    (*

    One or more individual assessments as specified by Filters.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_task_individual_assessments_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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

    *)
}
type nonrec describe_replication_task_assessment_runs_response = {
  1. replication_task_assessment_runs : replication_task_assessment_run_list option;
    (*

    One or more premigration assessment runs as specified by Filters.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_task_assessment_runs_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    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

    *)
}
type nonrec describe_replication_task_assessment_results_response = {
  1. replication_task_assessment_results : replication_task_assessment_result_list option;
    (*

    The task assessment report.

    *)
  2. bucket_name : string_ option;
    (*
    • The Amazon S3 bucket where the task assessment report is located.
    *)
  3. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_task_assessment_results_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. replication_task_arn : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_table_statistics_response = {
  1. replication_table_statistics : replication_table_statistics_list option;
    (*

    Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. replication_config_arn : string_ option;
    (*

    The Amazon Resource Name of the replication config.

    *)
}
type nonrec describe_replication_table_statistics_message = {
  1. filters : filter_list option;
    (*

    Filters applied to the replication table statistics.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. max_records : integer_optional option;
    (*

    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.

    *)
  4. replication_config_arn : string_;
    (*

    The replication config to describe.

    *)
}
type nonrec describe_replication_subnet_groups_response = {
  1. replication_subnet_groups : replication_subnet_groups option;
    (*

    A description of the replication subnet groups.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_subnet_groups_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to replication subnet groups.

    Valid filter names: replication-subnet-group-id

    *)
}
type nonrec describe_replication_instances_response = {
  1. replication_instances : replication_instance_list option;
    (*

    The replication instances described.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_instances_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to replication instances.

    Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

    *)
}
type nonrec describe_replication_instance_task_logs_response = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. replication_instance_task_logs : replication_instance_task_logs_list option;
    (*

    An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).

    *)
  3. replication_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
}
type nonrec describe_replication_instance_task_logs_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
}
type nonrec describe_replication_configs_response = {
  1. replication_configs : replication_config_list option;
    (*

    Returned configuration parameters that describe each provisioned DMS Serverless replication.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_replication_configs_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the replication configs.

    *)
}
type nonrec describe_refresh_schemas_status_response = {
  1. refresh_schemas_status : refresh_schemas_status option;
    (*

    The status of the schema.

    *)
}
type nonrec describe_refresh_schemas_status_message = {
  1. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}
type nonrec describe_recommendations_response = {
  1. recommendations : recommendation_list option;
    (*

    The list of recommendations of target engines that Fleet Advisor created for the source database.

    *)
  2. next_token : string_ option;
    (*

    The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the MaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_recommendations_request = {
  1. next_token : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the target engine recommendations described in the form of key-value pairs.

    Valid filter names: database-id | engine-name

    *)
}
type nonrec describe_recommendation_limitations_response = {
  1. limitations : limitation_list option;
    (*

    The list of limitations for recommendations of target Amazon Web Services engines.

    *)
  2. next_token : string_ option;
    (*

    The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the MaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_recommendation_limitations_request = {
  1. next_token : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the limitations described in the form of key-value pairs.

    Valid filter names: database-id | engine-name

    *)
}
type nonrec describe_pending_maintenance_actions_response = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. pending_maintenance_actions : pending_maintenance_actions option;
    (*

    The pending maintenance action.

    *)
}
type nonrec describe_pending_maintenance_actions_message = {
  1. max_records : integer_optional option;
    (*

    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.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
  3. filters : filter_list option;
  4. replication_instance_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
}
type nonrec describe_orderable_replication_instances_response = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. orderable_replication_instances : orderable_replication_instance_list option;
    (*

    The order-able replication instances available.

    *)
}
type nonrec describe_orderable_replication_instances_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
}
type nonrec describe_migration_projects_response = {
  1. migration_projects : migration_project_list option;
    (*

    A description of migration projects.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_migration_projects_message = {
  1. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the migration projects described in the form of key-value pairs.

    Valid filter names and values:

    • instance-profile-identifier, instance profile arn or name
    • data-provider-identifier, data provider arn or name
    • migration-project-identifier, migration project arn or name
    *)
}
type nonrec describe_metadata_model_response = {
  1. definition : string_ option;
    (*

    The SQL text of the metadata model. This field might not be populated for some metadata models.

    *)
  2. target_metadata_models : metadata_model_reference_list option;
    (*

    A list of counterpart metadata models in the target. This field is populated only when Origin is SOURCE and after the object has been converted by DMS Schema Conversion.

    *)
  3. metadata_model_type : string_ option;
    (*

    The type of the metadata model.

    *)
  4. metadata_model_name : string_ option;
    (*

    The name of the metadata model.

    *)
}
type nonrec describe_metadata_model_message = {
  1. origin : origin_type_value;
    (*

    Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
  3. selection_rules : string_;
    (*

    The JSON string that specifies which metadata model to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.

    *)
}
type nonrec describe_metadata_model_imports_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A paginated list of metadata model imports.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_metadata_model_imports_message = {
  1. max_records : integer_optional option;
    (*

    A paginated list of metadata model imports.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the metadata model imports described in the form of key-value pairs.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec describe_metadata_model_exports_to_target_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A paginated list of metadata model exports.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_metadata_model_exports_to_target_message = {
  1. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the metadata model exports described in the form of key-value pairs.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec describe_metadata_model_exports_as_script_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A paginated list of metadata model exports.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_metadata_model_exports_as_script_message = {
  1. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the metadata model exports described in the form of key-value pairs.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec describe_metadata_model_creations_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A list of metadata model creation requests. The ExportSqlDetails field will never be populated for the DescribeMetadataModelCreations operation.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned, there are more metadata model creation requests available.

    *)
}
type nonrec describe_metadata_model_creations_message = {
  1. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of metadata model creation requests to include in the response. If more requests exist than the specified MaxRecords value, a pagination token is provided in the response so that you can retrieve the remaining results.

    *)
  3. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned by a previous response, there are more metadata model creation requests available.

    *)
  4. filters : filter_list option;
    (*

    Filters applied to the metadata model creation requests described in the form of key-value pairs. The supported filters are request-id and status.

    *)
}
type nonrec describe_metadata_model_conversions_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A paginated list of metadata model conversions.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_metadata_model_conversions_message = {
  1. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the metadata model conversions described in the form of key-value pairs.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec describe_metadata_model_children_response = {
  1. metadata_model_children : metadata_model_reference_list option;
    (*

    A list of child metadata models.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of metadata model children. If a marker is returned, there are more metadata model children available.

    *)
}
type nonrec describe_metadata_model_children_message = {
  1. max_records : integer_optional option;
    (*

    The maximum number of metadata model children to include in the response. If more items exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that indicates where the next page should start. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  3. origin : origin_type_value;
    (*

    Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
  5. selection_rules : string_;
    (*

    The JSON string that specifies which metadata model's children to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.

    *)
}
type nonrec describe_metadata_model_assessments_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A paginated list of metadata model assessments for the specified migration project.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_metadata_model_assessments_message = {
  1. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the metadata model assessments described in the form of key-value pairs.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The name or Amazon Resource Name (ARN) of the migration project.

    *)
}
type nonrec describe_instance_profiles_response = {
  1. instance_profiles : instance_profile_list option;
    (*

    A description of instance profiles.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_instance_profiles_message = {
  1. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the instance profiles described in the form of key-value pairs.

    Valid filter names and values: instance-profile-identifier, instance profile arn or name

    *)
}
type nonrec describe_fleet_advisor_schemas_response = {
  1. next_token : string_ option;
    (*

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. fleet_advisor_schemas : fleet_advisor_schema_list option;
    (*

    A collection of SchemaResponse objects.

    *)
}
type nonrec describe_fleet_advisor_schemas_request = {
  1. next_token : string_ option;
    (*

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    Sets the maximum number of records returned in the response.

    *)
  3. filters : filter_list option;
    (*

    If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:

    • complexity – The schema's complexity, for example Simple.
    • database-id – The ID of the schema's database.
    • database-ip-address – The IP address of the schema's database.
    • database-name – The name of the schema's database.
    • database-engine – The name of the schema database's engine.
    • original-schema-name – The name of the schema's database's main schema.
    • schema-id – The ID of the schema, for example 15.
    • schema-name – The name of the schema.
    • server-ip-address – The IP address of the schema database's server.

    An example is: describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"

    *)
}
type nonrec describe_fleet_advisor_schema_object_summary_response = {
  1. next_token : string_ option;
    (*

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. fleet_advisor_schema_objects : fleet_advisor_schema_object_list option;
    (*

    A collection of FleetAdvisorSchemaObjectResponse objects.

    *)
}
type nonrec describe_fleet_advisor_schema_object_summary_request = {
  1. next_token : string_ option;
    (*

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

    Sets the maximum number of records returned in the response.

    *)
  3. filters : filter_list option;
    (*

    If you specify any of the following filters, the output includes information for only those schema objects that meet the filter criteria:

    • schema-id – The ID of the schema, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.

    Example: describe-fleet-advisor-schema-object-summary --filter Name="schema-id",Values="50"

    *)
}
type nonrec describe_fleet_advisor_lsa_analysis_response = {
  1. next_token : string_ option;
    (*

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. analysis : fleet_advisor_lsa_analysis_response_list option;
    (*

    A list of FleetAdvisorLsaAnalysisResponse objects.

    *)
}
type nonrec describe_fleet_advisor_lsa_analysis_request = {
  1. next_token : string_ option;
    (*

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    Sets the maximum number of records returned in the response.

    *)
}
type nonrec database_instance_software_details_response = {
  1. tooltip : string_ option;
    (*

    Information about the database engine software, for example Mainstream support ends on November 14th, 2024.

    *)
  2. os_architecture : integer_optional option;
    (*

    The operating system architecture of the database.

    *)
  3. support_level : string_ option;
    (*

    The support level of the database, for example Mainstream support.

    *)
  4. service_pack : string_ option;
    (*

    The service pack level of the database.

    *)
  5. engine_edition : string_ option;
    (*

    The database engine edition of a database in a Fleet Advisor collector inventory, for example Express.

    *)
  6. engine_version : string_ option;
    (*

    The database engine version of a database in a Fleet Advisor collector inventory, for example 2019.

    *)
  7. engine : string_ option;
    (*

    The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft SQL Server.

    *)
}

Describes an inventory database instance for a Fleet Advisor collector.

type nonrec collector_short_info_response = {
  1. collector_name : string_ option;
    (*

    The name of the Fleet Advisor collector.

    *)
  2. collector_referenced_id : string_ option;
    (*

    The reference ID of the Fleet Advisor collector.

    *)
}

Briefly describes a Fleet Advisor collector.

type nonrec collectors_list = collector_short_info_response list
type nonrec database_response = {
  1. collectors : collectors_list option;
    (*

    A list of collectors associated with the database.

    *)
  2. software_details : database_instance_software_details_response option;
    (*

    The software details of a database in a Fleet Advisor collector inventory, such as database engine and version.

    *)
  3. server : server_short_info_response option;
    (*

    The server name of a database in a Fleet Advisor collector inventory.

    *)
  4. number_of_schemas : long_optional option;
    (*

    The number of schemas in a Fleet Advisor collector inventory database.

    *)
  5. ip_address : string_ option;
    (*

    The IP address of a database in a Fleet Advisor collector inventory.

    *)
  6. database_name : string_ option;
    (*

    The name of a database in a Fleet Advisor collector inventory.

    *)
  7. database_id : string_ option;
    (*

    The ID of a database in a Fleet Advisor collector inventory.

    *)
}

Describes a database in a Fleet Advisor collector inventory.

type nonrec database_list = database_response list
type nonrec describe_fleet_advisor_databases_response = {
  1. next_token : string_ option;
    (*

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. databases : database_list option;
    (*

    Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.

    *)
}
type nonrec describe_fleet_advisor_databases_request = {
  1. next_token : string_ option;
    (*

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    Sets the maximum number of records returned in the response.

    *)
  3. filters : filter_list option;
    (*

    If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:

    • database-id – The ID of the database.
    • database-name – The name of the database.
    • database-engine – The name of the database engine.
    • server-ip-address – The IP address of the database server.
    • database-ip-address – The IP address of the database.
    • collector-name – The name of the associated Fleet Advisor collector.

    An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="45"

    *)
}
type nonrec collector_status =
  1. | ACTIVE
  2. | UNREGISTERED
type nonrec collector_health_check = {
  1. web_collector_granted_role_based_access : boolean_optional option;
    (*

    Whether the role that you provided when creating the Fleet Advisor collector has sufficient permissions to access the Fleet Advisor web collector.

    *)
  2. web_collector_s3_access : boolean_optional option;
    (*

    Whether the web collector can access its Amazon S3 bucket.

    *)
  3. local_collector_s3_access : boolean_optional option;
    (*

    Whether the local collector can access its Amazon S3 bucket.

    *)
  4. collector_status : collector_status option;
    (*

    The status of the Fleet Advisor collector.

    *)
}

Describes the last Fleet Advisor collector health check.

type nonrec collector_response = {
  1. inventory_data : inventory_data option;
  2. modified_date : string_ option;
    (*

    The timestamp when DMS last modified the collector, in the following format: 2022-01-24T19:04:02.596113Z

    *)
  3. created_date : string_ option;
    (*

    The timestamp when you created the collector, in the following format: 2022-01-24T19:04:02.596113Z

    *)
  4. registered_date : string_ option;
    (*

    The timestamp when DMS registered the collector, in the following format: 2022-01-24T19:04:02.596113Z

    *)
  5. last_data_received : string_ option;
    (*

    The timestamp of the last time the collector received data, in the following format: 2022-01-24T19:04:02.596113Z

    *)
  6. collector_health_check : collector_health_check option;
  7. service_access_role_arn : string_ option;
    (*

    The IAM role that grants permissions to access the specified Amazon S3 bucket.

    *)
  8. s3_bucket_name : string_ option;
    (*

    The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

    *)
  9. description : string_ option;
    (*

    A summary description of the Fleet Advisor collector.

    *)
  10. version_status : version_status option;
    (*

    Whether the collector version is up to date.

    *)
  11. collector_version : string_ option;
    (*

    The version of your Fleet Advisor collector, in semantic versioning format, for example 1.0.2

    *)
  12. collector_name : string_ option;
    (*

    The name of the Fleet Advisor collector .

    *)
  13. collector_referenced_id : string_ option;
    (*

    The reference ID of the Fleet Advisor collector.

    *)
}

Describes a Fleet Advisor collector.

type nonrec collector_responses = collector_response list
type nonrec describe_fleet_advisor_collectors_response = {
  1. next_token : string_ option;
    (*

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. collectors : collector_responses option;
    (*

    Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.

    *)
}
type nonrec describe_fleet_advisor_collectors_request = {
  1. next_token : string_ option;
    (*

    If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    Sets the maximum number of records returned in the response.

    *)
  3. filters : filter_list option;
    (*

    If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:

    • collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
    • collector-name – The name of the collector agent.

    An example is: describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"

    *)
}
type nonrec describe_extension_pack_associations_response = {
  1. requests : schema_conversion_request_list option;
    (*

    A paginated list of extension pack associations for the specified migration project.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_extension_pack_associations_message = {
  1. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the extension pack associations described in the form of key-value pairs.

    *)
  4. migration_project_identifier : migration_project_identifier;
    (*

    The name or Amazon Resource Name (ARN) for the migration project.

    *)
}
type nonrec describe_events_response = {
  1. events : event_list option;
    (*

    The events described.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_events_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to events. The only valid filter is replication-instance-id.

    *)
  4. event_categories : event_categories_list option;
    (*

    A list of event categories for the source type that you've chosen.

    *)
  5. duration : integer_optional option;
    (*

    The duration of the events to be listed.

    *)
  6. end_time : t_stamp option;
    (*

    The end time for the events to be listed.

    *)
  7. start_time : t_stamp option;
    (*

    The start time for the events to be listed.

    *)
  8. source_type : source_type option;
    (*

    The type of DMS resource that generates events.

    Valid values: replication-instance | replication-task

    *)
  9. source_identifier : string_ option;
    (*

    The identifier of an event source.

    *)
}
type nonrec describe_event_subscriptions_response = {
  1. event_subscriptions_list : event_subscriptions_list option;
    (*

    A list of event subscriptions.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_event_subscriptions_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to event subscriptions.

    Valid filter names: event-subscription-arn | event-subscription-id

    *)
  4. subscription_name : string_ option;
    (*

    The name of the DMS event subscription to be described.

    *)
}
type nonrec describe_event_categories_response = {
  1. event_category_group_list : event_category_group_list option;
    (*

    A list of event categories.

    *)
}
type nonrec describe_event_categories_message = {
  1. filters : filter_list option;
    (*

    Filters applied to the event categories.

    *)
  2. source_type : string_ option;
    (*

    The type of DMS resource that generates events.

    Valid values: replication-instance | replication-task

    *)
}
type nonrec describe_engine_versions_response = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. engine_versions : engine_version_list option;
    (*

    Returned EngineVersion objects that describe the replication instance engine versions used in the project.

    *)
}
type nonrec describe_engine_versions_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
}
type nonrec describe_endpoints_response = {
  1. endpoints : endpoint_list option;
    (*

    Endpoint description.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_endpoints_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the endpoints.

    Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

    *)
}
type nonrec describe_endpoint_types_response = {
  1. supported_endpoint_types : supported_endpoint_type_list option;
    (*

    The types of endpoints that are supported.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_endpoint_types_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the endpoint types.

    Valid filter names: engine-name | endpoint-type

    *)
}
type nonrec describe_endpoint_settings_response = {
  1. endpoint_settings : endpoint_settings_list option;
    (*

    Descriptions of the endpoint settings available for your source or target database engine.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_endpoint_settings_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. engine_name : string_;
    (*

    The database engine used for your source or target endpoint.

    *)
}
type nonrec data_provider_list = data_provider list
type nonrec describe_data_providers_response = {
  1. data_providers : data_provider_list option;
    (*

    A description of data providers.

    *)
  2. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
}
type nonrec describe_data_providers_message = {
  1. marker : string_ option;
    (*

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the data providers described in the form of key-value pairs.

    Valid filter names and values: data-provider-identifier, data provider arn or name

    *)
}
type nonrec data_migrations = data_migration list
type nonrec describe_data_migrations_response = {
  1. marker : marker option;
    (*

    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.

    *)
  2. data_migrations : data_migrations option;
    (*

    Returns information about the data migrations used in the project.

    *)
}
type nonrec describe_data_migrations_message = {
  1. without_statistics : boolean_optional option;
    (*

    An option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose true; otherwise, choose false (the default).

    *)
  2. without_settings : boolean_optional option;
    (*

    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).

    *)
  3. marker : marker option;
    (*

    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.

    *)
  4. max_records : integer_optional option;
    (*

    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.

    *)
  5. filters : filter_list option;
    (*

    Filters applied to the data migrations.

    *)
}
type nonrec describe_conversion_configuration_response = {
  1. conversion_configuration : string_ option;
    (*

    The configuration parameters for the schema conversion project.

    *)
  2. migration_project_identifier : string_ option;
    (*

    The name or Amazon Resource Name (ARN) for the schema conversion project.

    *)
}
type nonrec describe_conversion_configuration_message = {
  1. migration_project_identifier : migration_project_identifier;
    (*

    The name or Amazon Resource Name (ARN) for the schema conversion project to describe.

    *)
}
type nonrec connection_list = connection list
type nonrec describe_connections_response = {
  1. connections : connection_list option;
    (*

    A description of the connections.

    *)
  2. marker : string_ option;
    (*

    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.

    *)
}
type nonrec describe_connections_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. filters : filter_list option;
    (*

    The filters applied to the connection.

    Valid filter names: endpoint-arn | replication-instance-arn

    *)
}
type nonrec certificate_list = certificate list
type nonrec describe_certificates_response = {
  1. certificates : certificate_list option;
    (*

    The Secure Sockets Layer (SSL) certificates associated with the replication instance.

    *)
  2. marker : string_ option;
    (*

    The pagination token.

    *)
}
type nonrec describe_certificates_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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: 10

    *)
  3. filters : filter_list option;
    (*

    Filters applied to the certificates described in the form of key-value pairs. Valid values are certificate-arn and certificate-id.

    *)
}
type nonrec describe_applicable_individual_assessments_response = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. individual_assessment_names : individual_assessment_name_list option;
    (*

    List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.

    *)
}
type nonrec describe_applicable_individual_assessments_message = {
  1. marker : string_ option;
    (*

    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.

    *)
  2. max_records : integer_optional option;
    (*

    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.

    *)
  3. migration_type : migration_type_value option;
    (*

    Name of the migration type that each provided individual assessment must support.

    *)
  4. target_engine_name : string_ option;
    (*

    Name of a database engine that the specified replication instance supports as a target.

    *)
  5. source_engine_name : string_ option;
    (*

    Name of a database engine that the specified replication instance supports as a source.

    *)
  6. replication_config_arn : string_ option;
    (*

    Amazon Resource Name (ARN) of a serverless replication on which you want to base the default list of individual assessments.

    *)
  7. replication_instance_arn : string_ option;
    (*

    ARN of a replication instance on which you want to base the default list of individual assessments.

    *)
  8. replication_task_arn : string_ option;
    (*

    Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.

    *)
}
type nonrec account_quota = {
  1. max : long option;
    (*

    The maximum allowed value for the quota.

    *)
  2. used : long option;
    (*

    The amount currently used toward the quota maximum.

    *)
  3. account_quota_name : string_ option;
    (*

    The name of the DMS quota for this Amazon Web Services account.

    *)
}

Describes a quota for an Amazon Web Services account, for example the number of replication instances allowed.

type nonrec account_quota_list = account_quota list
type nonrec describe_account_attributes_response = {
  1. unique_account_identifier : string_ option;
    (*

    A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket name is the following:

    dms-{i AccountNumber}-{i UniqueAccountIdentifier}.

    Here is an example name for this default S3 bucket: dms-111122223333-c44445555666.

    DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.

    *)
  2. account_quotas : account_quota_list option;
    (*

    Account quota information.

    *)
}
type nonrec describe_account_attributes_message = unit
type nonrec delete_replication_task_response = {
  1. replication_task : replication_task option;
    (*

    The deleted replication task.

    *)
}
type nonrec delete_replication_task_message = {
  1. replication_task_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication task to be deleted.

    *)
}
type nonrec delete_replication_task_assessment_run_response = {
  1. replication_task_assessment_run : replication_task_assessment_run option;
    (*

    The ReplicationTaskAssessmentRun object for the deleted assessment run.

    *)
}
type nonrec delete_replication_task_assessment_run_message = {
  1. replication_task_assessment_run_arn : string_;
    (*

    Amazon Resource Name (ARN) of the premigration assessment run to be deleted.

    *)
}
type nonrec delete_replication_subnet_group_response = unit
type nonrec delete_replication_subnet_group_message = {
  1. replication_subnet_group_identifier : string_;
    (*

    The subnet group name of the replication instance.

    *)
}
type nonrec delete_replication_instance_response = {
  1. replication_instance : replication_instance option;
    (*

    The replication instance that was deleted.

    *)
}
type nonrec delete_replication_instance_message = {
  1. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance to be deleted.

    *)
}
type nonrec delete_replication_config_response = {
  1. replication_config : replication_config option;
    (*

    Configuration parameters returned for the DMS Serverless replication after it is deleted.

    *)
}
type nonrec delete_replication_config_message = {
  1. replication_config_arn : string_;
    (*

    The replication config to delete.

    *)
}
type nonrec delete_migration_project_response = {
  1. migration_project : migration_project option;
    (*

    The migration project that was deleted.

    *)
}
type nonrec delete_migration_project_message = {
  1. migration_project_identifier : string_;
    (*

    The name or Amazon Resource Name (ARN) of the migration project to delete.

    *)
}
type nonrec delete_instance_profile_response = {
  1. instance_profile : instance_profile option;
    (*

    The instance profile that was deleted.

    *)
}
type nonrec delete_instance_profile_message = {
  1. instance_profile_identifier : string_;
    (*

    The identifier of the instance profile to delete.

    *)
}
type nonrec delete_fleet_advisor_databases_response = {
  1. database_ids : string_list option;
    (*

    The IDs of the databases that the operation deleted.

    *)
}
type nonrec delete_fleet_advisor_databases_request = {
  1. database_ids : string_list;
    (*

    The IDs of the Fleet Advisor collector databases to delete.

    *)
}
type nonrec collector_not_found_fault = {
  1. message : exception_message option;
}

The specified collector doesn't exist.

type nonrec delete_collector_request = {
  1. collector_referenced_id : string_;
    (*

    The reference ID of the Fleet Advisor collector to delete.

    *)
}
type nonrec delete_event_subscription_response = {
  1. event_subscription : event_subscription option;
    (*

    The event subscription that was deleted.

    *)
}
type nonrec delete_event_subscription_message = {
  1. subscription_name : string_;
    (*

    The name of the DMS event notification subscription to be deleted.

    *)
}
type nonrec delete_endpoint_response = {
  1. endpoint : endpoint option;
    (*

    The endpoint that was deleted.

    *)
}
type nonrec delete_endpoint_message = {
  1. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}
type nonrec delete_data_provider_response = {
  1. data_provider : data_provider option;
    (*

    The data provider that was deleted.

    *)
}
type nonrec delete_data_provider_message = {
  1. data_provider_identifier : string_;
    (*

    The identifier of the data provider to delete.

    *)
}
type nonrec delete_data_migration_response = {
  1. data_migration : data_migration option;
    (*

    The deleted data migration.

    *)
}
type nonrec delete_data_migration_message = {
  1. data_migration_identifier : string_;
    (*

    The identifier (name or ARN) of the data migration to delete.

    *)
}
type nonrec delete_connection_response = {
  1. connection : connection option;
    (*

    The connection that is being deleted.

    *)
}
type nonrec delete_connection_message = {
  1. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the replication instance.

    *)
  2. endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

    *)
}
type nonrec delete_certificate_response = {
  1. certificate : certificate option;
    (*

    The Secure Sockets Layer (SSL) certificate.

    *)
}
type nonrec delete_certificate_message = {
  1. certificate_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the certificate.

    *)
}
type nonrec create_replication_task_response = {
  1. replication_task : replication_task option;
    (*

    The replication task that was created.

    *)
}
type nonrec create_replication_task_message = {
  1. resource_identifier : string_ option;
    (*

    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.

    *)
  2. task_data : string_ option;
    (*

    Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

    *)
  3. tags : tag_list option;
    (*

    One or more tags to be assigned to the replication task.

    *)
  4. cdc_stop_position : string_ option;
    (*

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

    *)
  5. cdc_start_position : string_ option;
    (*

    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.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    *)
  6. cdc_start_time : t_stamp option;
    (*

    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.

    Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

    *)
  7. replication_task_settings : string_ option;
    (*

    Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.

    *)
  8. table_mappings : string_;
    (*

    The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.

    *)
  9. migration_type : migration_type_value;
    (*

    The migration type. Valid values: full-load | cdc | full-load-and-cdc

    *)
  10. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of a replication instance.

    *)
  11. target_endpoint_arn : string_;
    (*

    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

    *)
  12. source_endpoint_arn : string_;
    (*

    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

    *)
  13. replication_task_identifier : string_;
    (*

    An identifier for the replication task.

    Constraints:

    • Must contain 1-255 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    *)
}
type nonrec create_replication_subnet_group_response = {
  1. replication_subnet_group : replication_subnet_group option;
    (*

    The replication subnet group that was created.

    *)
}
type nonrec create_replication_subnet_group_message = {
  1. tags : tag_list option;
    (*

    One or more tags to be assigned to the subnet group.

    *)
  2. subnet_ids : subnet_identifier_list;
    (*

    Two or more subnet IDs to be assigned to the subnet group.

    *)
  3. replication_subnet_group_description : string_;
    (*

    The description for the subnet group.

    Constraints: This parameter Must not contain non-printable control characters.

    *)
  4. replication_subnet_group_identifier : string_;
    (*

    The name for the replication subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be "default".

    Example: mySubnetgroup

    *)
}
type nonrec create_replication_instance_response = {
  1. replication_instance : replication_instance option;
    (*

    The replication instance that was created.

    *)
}
type nonrec create_replication_instance_message = {
  1. kerberos_authentication_settings : kerberos_authentication_settings option;
    (*

    Specifies the settings required for kerberos authentication when creating the replication instance.

    *)
  2. network_type : string_ option;
    (*

    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.

    *)
  3. resource_identifier : string_ option;
    (*

    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.

    *)
  4. dns_name_servers : string_ option;
    (*

    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"

    *)
  5. publicly_accessible : boolean_optional option;
    (*

    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.

    *)
  6. kms_key_id : string_ option;
    (*

    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.

    *)
  7. tags : tag_list option;
    (*

    One or more tags to be assigned to the replication instance.

    *)
  8. auto_minor_version_upgrade : boolean_optional option;
    (*

    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

    *)
  9. engine_version : string_ option;
    (*

    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.

    *)
  10. multi_a_z : boolean_optional option;
    (*

    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.

    *)
  11. preferred_maintenance_window : string_ option;
    (*

    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.

    *)
  12. replication_subnet_group_identifier : string_ option;
    (*

    A subnet group to associate with the replication instance.

    *)
  13. availability_zone : string_ option;
    (*

    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.

    *)
  14. vpc_security_group_ids : vpc_security_group_id_list option;
    (*

    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.

    *)
  15. replication_instance_class : replication_instance_class;
    (*

    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.

    *)
  16. allocated_storage : integer_optional option;
    (*

    The amount of storage (in gigabytes) to be initially allocated for the replication instance.

    *)
  17. replication_instance_identifier : string_;
    (*

    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

    *)
}
type nonrec create_replication_config_response = {
  1. replication_config : replication_config option;
    (*

    Configuration parameters returned from the DMS Serverless replication after it is created.

    *)
}
type nonrec create_replication_config_message = {
  1. tags : tag_list option;
    (*

    One or more optional tags associated with resources used by the DMS Serverless replication. For more information, see Tagging resources in Database Migration Service.

    *)
  2. resource_identifier : string_ option;
    (*

    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.

    *)
  3. supplemental_settings : string_ option;
    (*

    Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.

    *)
  4. replication_settings : string_ option;
    (*

    Optional JSON settings for DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.

    *)
  5. table_mappings : string_;
    (*

    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.

    *)
  6. replication_type : migration_type_value;
    (*

    The type of DMS Serverless replication to provision using this replication configuration.

    Possible values:

    • "full-load"
    • "cdc"
    • "full-load-and-cdc"
    *)
  7. compute_config : compute_config;
    (*

    Configuration parameters for provisioning an DMS Serverless replication.

    *)
  8. target_endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.

    *)
  9. source_endpoint_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the source endpoint for this DMS Serverless replication configuration.

    *)
  10. replication_config_identifier : string_;
    (*

    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.

    *)
}
type nonrec create_migration_project_response = {
  1. migration_project : migration_project option;
    (*

    The migration project that was created.

    *)
}
type nonrec create_migration_project_message = {
  1. schema_conversion_application_attributes : sc_application_attributes option;
    (*

    The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

    *)
  2. tags : tag_list option;
    (*

    One or more tags to be assigned to the migration project.

    *)
  3. description : string_ option;
    (*

    A user-friendly description of the migration project.

    *)
  4. transformation_rules : string_ option;
    (*

    The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

    *)
  5. instance_profile_identifier : string_;
    (*

    The identifier of the associated instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

    *)
  6. target_data_provider_descriptors : data_provider_descriptor_definition_list;
    (*

    Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.

    *)
  7. source_data_provider_descriptors : data_provider_descriptor_definition_list;
    (*

    Information about the source data provider, including the name, ARN, and Secrets Manager parameters.

    *)
  8. migration_project_name : string_ option;
    (*

    A user-friendly name for the migration project.

    *)
}
type nonrec create_instance_profile_response = {
  1. instance_profile : instance_profile option;
    (*

    The instance profile that was created.

    *)
}
type nonrec create_instance_profile_message = {
  1. vpc_security_groups : string_list option;
    (*

    Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

    *)
  2. subnet_group_identifier : string_ option;
    (*

    A subnet group to associate with the instance profile.

    *)
  3. description : string_ option;
    (*

    A user-friendly description of the instance profile.

    *)
  4. instance_profile_name : string_ option;
    (*

    A user-friendly name for the instance profile.

    *)
  5. network_type : string_ option;
    (*

    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

    *)
  6. tags : tag_list option;
    (*

    One or more tags to be assigned to the instance profile.

    *)
  7. publicly_accessible : boolean_optional option;
    (*

    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.

    *)
  8. kms_key_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.

    If you don't specify a value for the KmsKeyArn parameter, then DMS uses an Amazon Web Services owned encryption key to encrypt your resources.

    *)
  9. availability_zone : string_ option;
    (*

    The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.

    *)
}
type nonrec create_fleet_advisor_collector_response = {
  1. s3_bucket_name : string_ option;
    (*

    The Amazon S3 bucket that the collector uses to store inventory metadata.

    *)
  2. service_access_role_arn : string_ option;
    (*

    The IAM role that grants permissions to access the specified Amazon S3 bucket.

    *)
  3. description : string_ option;
    (*

    A summary description of the Fleet Advisor collector.

    *)
  4. collector_name : string_ option;
    (*

    The name of the new Fleet Advisor collector.

    *)
  5. collector_referenced_id : string_ option;
    (*

    The unique ID of the new Fleet Advisor collector, for example: 22fda70c-40d5-4acf-b233-a495bd8eb7f5

    *)
}
type nonrec create_fleet_advisor_collector_request = {
  1. s3_bucket_name : string_;
    (*

    The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

    *)
  2. service_access_role_arn : string_;
    (*

    The IAM role that grants permissions to access the specified Amazon S3 bucket.

    *)
  3. description : string_ option;
    (*

    A summary description of your Fleet Advisor collector.

    *)
  4. collector_name : string_;
    (*

    The name of your Fleet Advisor collector (for example, sample-collector).

    *)
}
type nonrec create_event_subscription_response = {
  1. event_subscription : event_subscription option;
    (*

    The event subscription that was created.

    *)
}
type nonrec create_event_subscription_message = {
  1. tags : tag_list option;
    (*

    One or more tags to be assigned to the event subscription.

    *)
  2. enabled : boolean_optional option;
    (*

    A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

    *)
  3. source_ids : source_ids_list option;
    (*

    A list of identifiers for which DMS provides notification events.

    If you don't specify a value, notifications are provided for all sources.

    If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.

    *)
  4. event_categories : event_categories_list option;
    (*

    A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.

    *)
  5. source_type : string_ option;
    (*

    The type of DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value isn't specified, all events are returned.

    Valid values: replication-instance | replication-task

    *)
  6. sns_topic_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    *)
  7. subscription_name : string_;
    (*

    The name of the DMS event notification subscription. This name must be less than 255 characters.

    *)
}
type nonrec create_endpoint_response = {
  1. endpoint : endpoint option;
    (*

    The endpoint that was created.

    *)
}
type nonrec create_endpoint_message = {
  1. timestream_settings : timestream_settings option;
    (*

    Settings in JSON format for the target Amazon Timestream endpoint.

    *)
  2. gcp_my_sql_settings : gcp_my_sql_settings option;
    (*

    Settings in JSON format for the source GCP MySQL endpoint.

    *)
  3. redis_settings : redis_settings option;
    (*

    Settings in JSON format for the target Redis endpoint.

    *)
  4. doc_db_settings : doc_db_settings option;
  5. resource_identifier : string_ option;
    (*

    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.

    *)
  6. ibm_db2_settings : ibm_db2_settings option;
    (*

    Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

    *)
  7. microsoft_sql_server_settings : microsoft_sql_server_settings option;
    (*

    Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

    *)
  8. sybase_settings : sybase_settings option;
    (*

    Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

    *)
  9. oracle_settings : oracle_settings option;
    (*

    Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

    *)
  10. my_sql_settings : my_sql_settings option;
    (*

    Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

    *)
  11. postgre_sql_settings : postgre_sql_settings option;
    (*

    Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

    *)
  12. redshift_settings : redshift_settings option;
  13. neptune_settings : neptune_settings option;
    (*

    Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

    *)
  14. elasticsearch_settings : elasticsearch_settings option;
    (*

    Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

    *)
  15. kafka_settings : kafka_settings option;
    (*

    Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

    *)
  16. kinesis_settings : kinesis_settings option;
    (*

    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

    *)
  17. mongo_db_settings : mongo_db_settings option;
    (*

    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

    *)
  18. dms_transfer_settings : dms_transfer_settings option;
    (*

    The settings in JSON format for the DMS transfer type of source endpoint.

    Possible settings include the following:

    • ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
    • BucketName - The name of the S3 bucket to use.

    Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string

    JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

    *)
  19. s3_settings : s3_settings option;
    (*

    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

    *)
  20. dynamo_db_settings : dynamo_db_settings option;
    (*

    Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

    *)
  21. external_table_definition : string_ option;
    (*

    The external table definition.

    *)
  22. service_access_role_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

    *)
  23. ssl_mode : dms_ssl_mode_value option;
    (*

    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

    *)
  24. certificate_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the certificate.

    *)
  25. tags : tag_list option;
    (*

    One or more tags to be assigned to the endpoint.

    *)
  26. kms_key_id : string_ option;
    (*

    An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

    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.

    *)
  27. extra_connection_attributes : string_ option;
    (*

    Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

    *)
  28. database_name : string_ option;
    (*

    The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

    *)
  29. port : integer_optional option;
    (*

    The port used by the endpoint database.

    *)
  30. server_name : string_ option;
    (*

    The name of the server where the endpoint database resides.

    *)
  31. password : secret_string option;
    (*

    The password to be used to log in to the endpoint database.

    *)
  32. username : string_ option;
    (*

    The user name to be used to log in to the endpoint database.

    *)
  33. engine_name : string_;
    (*

    The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", "babelfish", redshift-serverless, aurora-serverless, aurora-postgresql-serverless, gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.

    *)
  34. endpoint_type : replication_endpoint_type_value;
    (*

    The type of endpoint. Valid values are source and target.

    *)
  35. endpoint_identifier : string_;
    (*

    The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

    *)
}
type nonrec create_data_provider_response = {
  1. data_provider : data_provider option;
    (*

    The data provider that was created.

    *)
}
type nonrec create_data_provider_message = {
  1. tags : tag_list option;
    (*

    One or more tags to be assigned to the data provider.

    *)
  2. settings : data_provider_settings;
    (*

    The settings in JSON format for a data provider.

    *)
  3. virtual : boolean_optional option;
    (*

    Indicates whether the data provider is virtual.

    *)
  4. engine : string_;
    (*

    The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

    *)
  5. description : string_ option;
    (*

    A user-friendly description of the data provider.

    *)
  6. data_provider_name : string_ option;
    (*

    A user-friendly name for the data provider.

    *)
}
type nonrec create_data_migration_response = {
  1. data_migration : data_migration option;
    (*

    Information about the created data migration.

    *)
}
type nonrec create_data_migration_message = {
  1. selection_rules : secret_string option;
    (*

    An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.

    *)
  2. tags : tag_list option;
    (*

    One or more tags to be assigned to the data migration.

    *)
  3. number_of_jobs : integer_optional option;
    (*

    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

    *)
  4. target_data_settings : target_data_settings option;
    (*

    Specifies information about the target data provider.

    *)
  5. source_data_settings : source_data_settings option;
    (*

    Specifies information about the source data provider.

    *)
  6. enable_cloudwatch_logs : boolean_optional option;
    (*

    Specifies whether to enable CloudWatch logs for the data migration.

    *)
  7. service_access_role_arn : string_;
    (*

    The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.

    *)
  8. data_migration_type : migration_type_value;
    (*

    Specifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

    *)
  9. migration_project_identifier : string_;
    (*

    An identifier for the migration project.

    *)
  10. data_migration_name : string_ option;
    (*

    A user-friendly name for the data migration. Data migration names have the following constraints:

    • Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.
    • Can't end with a hyphen or contain two consecutive hyphens.
    • Length must be from 1 to 255 characters.
    *)
}
type nonrec cancel_replication_task_assessment_run_response = {
  1. replication_task_assessment_run : replication_task_assessment_run option;
    (*

    The ReplicationTaskAssessmentRun object for the canceled assessment run.

    *)
}
type nonrec cancel_replication_task_assessment_run_message = {
  1. replication_task_assessment_run_arn : string_;
    (*

    Amazon Resource Name (ARN) of the premigration assessment run to be canceled.

    *)
}
type nonrec cancel_metadata_model_creation_response = {
  1. request : schema_conversion_request option;
}
type nonrec cancel_metadata_model_creation_message = {
  1. request_identifier : string_;
    (*

    The identifier for the metadata model creation operation to cancel. This operation was initiated by StartMetadataModelCreation.

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec cancel_metadata_model_conversion_response = {
  1. request : schema_conversion_request option;
}
type nonrec cancel_metadata_model_conversion_message = {
  1. request_identifier : string_;
    (*

    The identifier for the metadata model conversion operation to cancel. This operation was initiated by StartMetadataModelConversion.

    *)
  2. migration_project_identifier : migration_project_identifier;
    (*

    The migration project name or Amazon Resource Name (ARN).

    *)
}
type nonrec batch_start_recommendations_error_entry = {
  1. code : string_ option;
    (*

    The code of an error that occurred during the analysis of the source database.

    *)
  2. message : string_ option;
    (*

    The information about the error.

    *)
  3. database_id : string_ option;
    (*

    The identifier of the source database.

    *)
}

Provides information about the errors that occurred during the analysis of the source database.

type nonrec batch_start_recommendations_error_entry_list = batch_start_recommendations_error_entry list
type nonrec batch_start_recommendations_response = {
  1. error_entries : batch_start_recommendations_error_entry_list option;
    (*

    A list with error details about the analysis of each source database.

    *)
}
type nonrec batch_start_recommendations_request = {
  1. data : start_recommendations_request_entry_list option;
    (*

    Provides information about source databases to analyze. After this analysis, Fleet Advisor recommends target engines for each source database.

    *)
}
type nonrec apply_pending_maintenance_action_response = {
  1. resource_pending_maintenance_actions : resource_pending_maintenance_actions option;
    (*

    The DMS resource that the pending maintenance action will be applied to.

    *)
}
type nonrec apply_pending_maintenance_action_message = {
  1. opt_in_type : string_;
    (*

    A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request of type immediate.

    Valid values:

    • immediate - Apply the maintenance action immediately.
    • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
    • undo-opt-in - Cancel any existing next-maintenance opt-in requests.
    *)
  2. apply_action : string_;
    (*

    The pending maintenance action to apply to this resource.

    Valid values: os-upgrade, system-update, db-upgrade, os-patch

    *)
  3. replication_instance_arn : string_;
    (*

    The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to.

    *)
}
type nonrec add_tags_to_resource_response = unit
type nonrec add_tags_to_resource_message = {
  1. tags : tag_list;
    (*

    One or more tags to be assigned to the resource.

    *)
  2. resource_arn : string_;
    (*

    Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).

    For DMS, you can tag a replication instance, an endpoint, or a replication task.

    *)
}

Associates a set of tags with an DMS resource.