Table of Contents
A low-level client representing AWS Database Migration Service
AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.
For more information about AWS DMS, see What Is AWS Database Migration Service? in the AWS Database Migration User Guide.
import boto3
client = boto3.client('dms')
These are the available methods:
Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see ` Tag https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html`__ data type description.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).
For AWS DMS, you can tag a replication instance, an endpoint, or a replication task.
[REQUIRED]
One or more tags to be assigned to the resource.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
dict
Response Syntax
{}
Response Structure
Exceptions
Examples
Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.
response = client.add_tags_to_resource(
# Required. Use the ARN of the resource you want to tag.
ResourceArn='arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
# Required. Use the Key/Value pair format.
Tags=[
{
'Key': 'Acount',
'Value': '1633456',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Applies a pending maintenance action to a resource (for example, to a replication instance).
See also: AWS API Documentation
Request Syntax
response = client.apply_pending_maintenance_action(
ReplicationInstanceArn='string',
ApplyAction='string',
OptInType='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to.
[REQUIRED]
The pending maintenance action to apply to this resource.
[REQUIRED]
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:
dict
Response Syntax
{
'ResourcePendingMaintenanceActions': {
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
}
Response Structure
(dict) --
ResourcePendingMaintenanceActions (dict) --
The AWS DMS resource that the pending maintenance action will be applied to.
ResourceIdentifier (string) --
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 AWS DMS in the DMS documentation.
PendingMaintenanceActionDetails (list) --
Detailed information about the pending maintenance action.
(dict) --
Describes a maintenance action pending for an AWS DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.
Action (string) --
The type of pending maintenance action that is available for the resource.
AutoAppliedAfterDate (datetime) --
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.
ForcedApplyDate (datetime) --
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.
OptInStatus (string) --
The type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
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 .
Description (string) --
A description providing more detail about the maintenance action.
Exceptions
Check if an operation can be paginated.
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
See also: AWS API Documentation
Request Syntax
response = client.cancel_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
{
'ReplicationTaskAssessmentRun': {
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string'
}
}
Response Structure
The ReplicationTaskAssessmentRun object for the canceled assessment run.
Amazon Resource Name (ARN) of this assessment run.
ARN of the migration task associated with this premigration assessment run.
Assessment run status.
This status can have one of the following values:
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
Indication of the completion progress for the individual assessments specified to run.
The number of individual assessments that are specified to run.
The number of individual assessments that have completed, successfully or not.
Last message generated by an individual assessment failure.
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
Amazon S3 bucket where AWS DMS stores the results of this assessment run.
Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment run.
Encryption mode used to encrypt the assessment run results.
ARN of the AWS KMS encryption key used to encrypt the assessment run results.
Unique name of the assessment run.
Exceptions
Creates an endpoint using the provided settings.
See also: AWS API Documentation
Request Syntax
response = client.create_endpoint(
EndpointIdentifier='string',
EndpointType='source'|'target',
EngineName='string',
Username='string',
Password='string',
ServerName='string',
Port=123,
DatabaseName='string',
ExtraConnectionAttributes='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CertificateArn='string',
SslMode='none'|'require'|'verify-ca'|'verify-full',
ServiceAccessRoleArn='string',
ExternalTableDefinition='string',
DynamoDbSettings={
'ServiceAccessRoleArn': 'string'
},
S3Settings={
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
DmsTransferSettings={
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
MongoDbSettings={
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
KinesisSettings={
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
KafkaSettings={
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
ElasticsearchSettings={
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
NeptuneSettings={
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
RedshiftSettings={
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
PostgreSQLSettings={
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
MySQLSettings={
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
OracleSettings={
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
SybaseSettings={
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
MicrosoftSQLServerSettings={
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
IBMDb2Settings={
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
ResourceIdentifier='string',
DocDbSettings={
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
)
[REQUIRED]
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.
[REQUIRED]
The type of endpoint. Valid values are source and target .
[REQUIRED]
The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "docdb" , "sqlserver" , and "neptune" .
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
One or more tags to be assigned to the endpoint.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
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 AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) used by the service access IAM role.
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 AWS DMS in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
Specifies how tables are defined in the S3 source files only.
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
The name of the S3 bucket.
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.
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
The format of the data that you want to use for output. You can choose one of the following:
The type of encoding you are using:
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.
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).
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.
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
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.
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
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 partitoning, see Using date-based folder partitioning .
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 .
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
The IAM role that has permission to access the Amazon S3 bucket.
The name of the S3 bucket to use.
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
The user name you use to access the MongoDB source endpoint.
The password for the user account you use to access the MongoDB source endpoint.
The name of the server on the MongoDB source endpoint.
The port value for the MongoDB source endpoint.
The database name on the MongoDB source endpoint.
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.
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" .
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
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 .
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
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).
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
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 .
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
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 .
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 .
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
Include NULL and empty columns for records migrated to the endpoint. The default is false .
Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
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).
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 .
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
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 .
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 .
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Include NULL and empty columns for records migrated to the endpoint. The default is false .
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 .
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
The password for the client private key used to securely connect to a Kafka target endpoint.
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
The secure username 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.
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.
Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide .
The Amazon Resource Name (ARN) used by service to access the IAM role.
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
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. Elasticsearch 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.
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
The number of milliseconds for AWS 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.
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
If you want AWS 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 .
Provides information that defines an Amazon Redshift endpoint.
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.
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
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 .
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
The name of the Amazon Redshift data warehouse (service) that you are working with.
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 .
A value that specifies whether AWS 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 .
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
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 .
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.
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
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).
The password for the user named in the username property.
The port number for Amazon Redshift. The default value is 5439.
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 .
A list of characters that you want to replace. Use with ReplaceChars .
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
The name of the Amazon Redshift cluster you are using.
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
The AWS 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.
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 .
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 .
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 .
An Amazon Redshift user name for a registered user.
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).
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
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 AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
Database name for the endpoint.
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
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 AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
Database name for the endpoint.
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
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.
Example: parallelLoadThreads=1
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
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 AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.
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.
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
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.
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).
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.
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.
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.
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.
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.
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
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.
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
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 .
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 .
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;
Database name for the endpoint.
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
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.
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
Endpoint connection password.
Endpoint TCP port.
When set to true , this attribute supports tablespace replication.
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
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 AWS DMS in the AWS Database Migration Service User Guide .
Fully qualified domain name of the endpoint.
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.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
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 AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.
Database name for the endpoint.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
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 AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.
Endpoint TCP port.
The maximum size of the packets (in bytes) used to transfer data using BCP.
Database name for the endpoint.
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Endpoint connection password.
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.
When this attribute is set to Y , AWS 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.
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
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.
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
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 AWS DMS in the AWS Database Migration Service User Guide.
Database name for the endpoint.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
Provides information that defines a DocumentDB endpoint.
The user name you use to access the DocumentDB source endpoint.
The password for the user account you use to access the DocumentDB source endpoint.
The name of the server on the DocumentDB source endpoint.
The port value for the DocumentDB source endpoint.
The database name on the DocumentDB source endpoint.
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
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 .
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
dict
Response Syntax
{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'KinesisSettings': {
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
'KafkaSettings': {
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
'ElasticsearchSettings': {
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
'NeptuneSettings': {
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
'RedshiftSettings': {
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'PostgreSQLSettings': {
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MySQLSettings': {
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'OracleSettings': {
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
'SybaseSettings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MicrosoftSQLServerSettings': {
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'IBMDb2Settings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'DocDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint that was created.
EndpointIdentifier (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.
EndpointType (string) --
The type of endpoint. Valid values are source and target .
EngineName (string) --
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint. The default value is none .
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
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.
DynamoDbSettings (dict) --
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
ExternalTableDefinition (string) --
Specifies how tables are defined in the S3 source files only.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
CsvDelimiter (string) --
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
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.
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
ServerSideEncryptionKmsKeyId (string) --
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
DataFormat (string) --
The format of the data that you want to use for output. You can choose one of the following:
EncodingType (string) --
The type of encoding you are using:
DictPageSizeLimit (integer) --
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.
RowGroupLength (integer) --
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).
DataPageSize (integer) --
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.
ParquetVersion (string) --
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
EnableStatistics (boolean) --
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.
IncludeOpForFullLoad (boolean) --
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
CdcInsertsOnly (boolean) --
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
TimestampColumnName (string) --
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
ParquetTimestampInMillisecond (boolean) --
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
CdcInsertsAndUpdates (boolean) --
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
DatePartitionEnabled (boolean) --
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 partitoning, see Using date-based folder partitioning .
DatePartitionSequence (string) --
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 .
DatePartitionDelimiter (string) --
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
UseCsvNoSupValue (boolean) --
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
CsvNoSupValue (string) --
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
PreserveTransactions (boolean) --
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
CdcPath (string) --
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
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.
AuthMechanism (string) --
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" .
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (string) --
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 .
AuthSource (string) --
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
KinesisSettings (dict) --
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
StreamArn (string) --
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat (string) --
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).
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
KafkaSettings (dict) --
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
Broker (string) --
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
Topic (string) --
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
MessageFormat (string) --
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).
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
MessageMaxBytes (integer) --
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
SecurityProtocol (string) --
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 .
SslClientCertificateArn (string) --
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
SslClientKeyArn (string) --
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
SslClientKeyPassword (string) --
The password for the client private key used to securely connect to a Kafka target endpoint.
SslCaCertificateArn (string) --
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
SaslUsername (string) --
The secure username 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.
SaslPassword (string) --
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.
ElasticsearchSettings (dict) --
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by service to access the IAM role.
EndpointUri (string) --
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
FullLoadErrorPercentage (integer) --
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. Elasticsearch 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.
ErrorRetryDuration (integer) --
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
NeptuneSettings (dict) --
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
S3BucketName (string) --
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
S3BucketFolder (string) --
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
ErrorRetryDuration (integer) --
The number of milliseconds for AWS 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.
MaxFileSize (integer) --
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
MaxRetryCount (integer) --
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
IamAuthEnabled (boolean) --
If you want AWS 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 .
RedshiftSettings (dict) --
Settings for the Amazon Redshift endpoint.
AcceptAnyDate (boolean) --
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.
AfterConnectScript (string) --
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
BucketFolder (string) --
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
BucketName (string) --
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
CaseSensitiveNames (boolean) --
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
CompUpdate (boolean) --
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 .
ConnectionTimeout (integer) --
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
DatabaseName (string) --
The name of the Amazon Redshift data warehouse (service) that you are working with.
DateFormat (string) --
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 .
EmptyAsNull (boolean) --
A value that specifies whether AWS 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 .
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
ExplicitIds (boolean) --
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 .
FileTransferUploadStreams (integer) --
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.
LoadTimeout (integer) --
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
MaxFileSize (integer) --
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).
Password (string) --
The password for the user named in the username property.
Port (integer) --
The port number for Amazon Redshift. The default value is 5439.
RemoveQuotes (boolean) --
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 .
ReplaceInvalidChars (string) --
A list of characters that you want to replace. Use with ReplaceChars .
ReplaceChars (string) --
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
ServerName (string) --
The name of the Amazon Redshift cluster you are using.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
ServerSideEncryptionKmsKeyId (string) --
The AWS 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.
TimeFormat (string) --
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 .
TrimBlanks (boolean) --
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 .
TruncateColumns (boolean) --
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 .
Username (string) --
An Amazon Redshift user name for a registered user.
WriteBufferSize (integer) --
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).
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
PostgreSQLSettings (dict) --
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
AfterConnectScript (string) --
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
CaptureDdls (boolean) --
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
DatabaseName (string) --
Database name for the endpoint.
DdlArtifactsSchema (string) --
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
ExecuteTimeout (integer) --
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
FailTasksOnLobTruncation (boolean) --
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SlotName (string) --
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
MySQLSettings (dict) --
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
AfterConnectScript (string) --
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
CleanSourceMetadataOnMismatch (boolean) --
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
DatabaseName (string) --
Database name for the endpoint.
EventsPollInterval (integer) --
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
TargetDbType (string) --
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
ParallelLoadThreads (integer) --
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.
Example: parallelLoadThreads=1
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
ServerTimezone (string) --
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
OracleSettings (dict) --
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
AddSupplementalLogging (boolean) --
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.
ArchivedLogDestId (integer) --
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
AdditionalArchivedLogDestId (integer) --
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
AllowSelectNestedTables (boolean) --
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
ParallelAsmReadThreads (integer) --
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.
ReadAheadBlocks (integer) --
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).
AccessAlternateDirectly (boolean) --
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.
UseAlternateFolderForOnline (boolean) --
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.
OraclePathPrefix (string) --
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.
UsePathPrefix (string) --
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.
ReplacePathPrefix (boolean) --
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.
EnableHomogenousTablespace (boolean) --
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
DirectPathNoLog (boolean) --
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.
ArchivedLogsOnly (boolean) --
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
AsmPassword (string) --
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
AsmServer (string) --
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 .
AsmUser (string) --
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 .
CharLengthSemantics (string) --
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;
DatabaseName (string) --
Database name for the endpoint.
DirectPathParallelLoad (boolean) --
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
FailTasksOnLobTruncation (boolean) --
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.
NumberDatatypeScale (integer) --
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
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ReadTableSpaceName (boolean) --
When set to true , this attribute supports tablespace replication.
RetryInterval (integer) --
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
SecurityDbEncryption (string) --
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
SecurityDbEncryptionName (string) --
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 AWS DMS in the AWS Database Migration Service User Guide .
ServerName (string) --
Fully qualified domain name of the endpoint.
SpatialDataOptionToGeoJsonFunctionName (string) --
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.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
SecretsManagerOracleAsmAccessRoleArn (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerOracleAsmSecretId (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
SybaseSettings (dict) --
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
MicrosoftSQLServerSettings (dict) --
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
Port (integer) --
Endpoint TCP port.
BcpPacketSize (integer) --
The maximum size of the packets (in bytes) used to transfer data using BCP.
DatabaseName (string) --
Database name for the endpoint.
ControlTablesFileGroup (string) --
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Password (string) --
Endpoint connection password.
QuerySingleAlwaysOnNode (boolean) --
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.
ReadBackupOnly (boolean) --
When this attribute is set to Y , AWS 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.
SafeguardPolicy (string) --
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
UseBcpFullLoad (boolean) --
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.
UseThirdPartyBackupDevice (boolean) --
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
IBMDb2Settings (dict) --
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
SetDataCaptureChanges (boolean) --
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
CurrentLsn (string) --
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
MaxKBytesPerRead (integer) --
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
DocDbSettings (dict) --
Provides information that defines a DocumentDB endpoint.
Username (string) --
The user name you use to access the DocumentDB source endpoint.
Password (string) --
The password for the user account you use to access the DocumentDB source endpoint.
ServerName (string) --
The name of the server on the DocumentDB source endpoint.
Port (integer) --
The port value for the DocumentDB source endpoint.
DatabaseName (string) --
The database name on the DocumentDB source endpoint.
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (boolean) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (integer) --
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 .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
Exceptions
Examples
Creates an endpoint using the provided settings.
response = client.create_endpoint(
CertificateArn='',
DatabaseName='testdb',
EndpointIdentifier='test-endpoint-1',
EndpointType='source',
EngineName='mysql',
ExtraConnectionAttributes='',
KmsKeyId='arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
Password='pasword',
Port=3306,
ServerName='mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
SslMode='require',
Tags=[
{
'Key': 'Acount',
'Value': '143327655',
},
],
Username='username',
)
print(response)
Expected Output:
{
'Endpoint': {
'EndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
'EndpointIdentifier': 'test-endpoint-1',
'EndpointType': 'source',
'EngineName': 'mysql',
'KmsKeyId': 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
'Port': 3306,
'ServerName': 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
'Status': 'active',
'Username': 'username',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates an AWS DMS event notification subscription.
You can specify the type of source (SourceType ) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds ) that triggers the events, and provide a list of event categories (EventCategories ) for events you want to be notified of. If you specify both the SourceType and SourceIds , such as SourceType = replication-instance and SourceIdentifier = my-replinstance , you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier , you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier , you will be notified of events generated from all AWS DMS sources belonging to your customer account.
For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
See also: AWS API Documentation
Request Syntax
response = client.create_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
SourceIds=[
'string',
],
Enabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the AWS DMS event notification subscription. This name must be less than 255 characters.
[REQUIRED]
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.
The type of AWS 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
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 AWS Database Migration Service User Guide.
A list of identifiers for which AWS 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.
One or more tags to be assigned to the event subscription.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
}
}
Response Structure
(dict) --
EventSubscription (dict) --
The event subscription that was created.
CustomerAwsId (string) --
The AWS customer account associated with the AWS DMS event notification subscription.
CustSubscriptionId (string) --
The AWS DMS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the AWS DMS event notification subscription.
Status (string) --
The status of the AWS 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 AWS 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.
SubscriptionCreationTime (string) --
The time the AWS DMS event notification subscription was created.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
SourceIdsList (list) --
A list of source Ids for the event subscription.
EventCategoriesList (list) --
A lists of event categories.
Enabled (boolean) --
Boolean value that indicates if the event subscription is enabled.
Exceptions
Creates the replication instance using the specified parameters.
AWS DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API . For information on the required permissions, see IAM Permissions Needed to Use AWS DMS .
See also: AWS API Documentation
Request Syntax
response = client.create_replication_instance(
ReplicationInstanceIdentifier='string',
AllocatedStorage=123,
ReplicationInstanceClass='string',
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
ReplicationSubnetGroupIdentifier='string',
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
PubliclyAccessible=True|False,
DnsNameServers='string',
ResourceIdentifier='string'
)
[REQUIRED]
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
[REQUIRED]
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 AWS DMS replication instance for your migration .
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.
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 AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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.
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
One or more tags to be assigned to the replication instance.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that was created.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt 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 AWS DMS replication instance for your migration .
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
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 AWS DMS replication instance for your migration .
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
PubliclyAccessible (boolean) --
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 .
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
Exceptions
Examples
Creates the replication instance using the specified parameters.
response = client.create_replication_instance(
AllocatedStorage=123,
AutoMinorVersionUpgrade=True,
AvailabilityZone='',
EngineVersion='',
KmsKeyId='',
MultiAZ=True,
PreferredMaintenanceWindow='',
PubliclyAccessible=True,
ReplicationInstanceClass='',
ReplicationInstanceIdentifier='',
ReplicationSubnetGroupIdentifier='',
Tags=[
{
'Key': 'string',
'Value': 'string',
},
],
VpcSecurityGroupIds=[
],
)
print(response)
Expected Output:
{
'ReplicationInstance': {
'AllocatedStorage': 5,
'AutoMinorVersionUpgrade': True,
'EngineVersion': '1.5.0',
'KmsKeyId': 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
'PendingModifiedValues': {
},
'PreferredMaintenanceWindow': 'sun:06:00-sun:14:00',
'PubliclyAccessible': True,
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationInstanceClass': 'dms.t2.micro',
'ReplicationInstanceIdentifier': 'test-rep-1',
'ReplicationInstanceStatus': 'creating',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupDescription': 'default',
'ReplicationSubnetGroupIdentifier': 'default',
'SubnetGroupStatus': 'Complete',
'Subnets': [
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1d',
},
'SubnetIdentifier': 'subnet-f6dd91af',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1b',
},
'SubnetIdentifier': 'subnet-3605751d',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1c',
},
'SubnetIdentifier': 'subnet-c2daefb5',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1e',
},
'SubnetIdentifier': 'subnet-85e90cb8',
'SubnetStatus': 'Active',
},
],
'VpcId': 'vpc-6741a603',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a replication subnet group given a list of the subnet IDs in a VPC.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string',
ReplicationSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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, spaces, underscores, or hyphens. Must not be "default".
Example: mySubnetgroup
[REQUIRED]
The description for the subnet group.
[REQUIRED]
One or more subnet IDs to be assigned to the subnet group.
One or more tags to be assigned to the subnet group.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
dict
Response Syntax
{
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
}
}
Response Structure
(dict) --
ReplicationSubnetGroup (dict) --
The replication subnet group that was created.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
Exceptions
Examples
Creates a replication subnet group given a list of the subnet IDs in a VPC.
response = client.create_replication_subnet_group(
ReplicationSubnetGroupDescription='US West subnet group',
ReplicationSubnetGroupIdentifier='us-west-2ab-vpc-215ds366',
SubnetIds=[
'subnet-e145356n',
'subnet-58f79200',
],
Tags=[
{
'Key': 'Acount',
'Value': '145235',
},
],
)
print(response)
Expected Output:
{
'ReplicationSubnetGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a replication task using the specified parameters.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_task(
ReplicationTaskIdentifier='string',
SourceEndpointArn='string',
TargetEndpointArn='string',
ReplicationInstanceArn='string',
MigrationType='full-load'|'cdc'|'full-load-and-cdc',
TableMappings='string',
ReplicationTaskSettings='string',
CdcStartTime=datetime(2015, 1, 1),
CdcStartPosition='string',
CdcStopPosition='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
TaskData='string',
ResourceIdentifier='string'
)
[REQUIRED]
An identifier for the replication task.
Constraints:
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
[REQUIRED]
The Amazon Resource Name (ARN) of a replication instance.
[REQUIRED]
The migration type. Valid values: full-load | cdc | full-load-and-cdc
[REQUIRED]
The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide.
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”
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”
Note
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 AWS DMS .
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 “
One or more tags to be assigned to the replication task.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
dict
Response Syntax
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task that was created.
ReplicationTaskIdentifier (string) --
The user-assigned replication task identifier or name.
Constraints:
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
MigrationType (string) --
The type of migration.
TableMappings (string) --
Table mappings specified in the task.
ReplicationTaskSettings (string) --
The settings for the replication task.
Status (string) --
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
LastFailureMessage (string) --
The last error (failure) message generated for the replication task.
StopReason (string) --
The reason the replication task was stopped. This response parameter can return one of the following values:
ReplicationTaskCreationDate (datetime) --
The date the replication task was created.
ReplicationTaskStartDate (datetime) --
The date the replication task is scheduled to start.
CdcStartPosition (string) --
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”
CdcStopPosition (string) --
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 “
RecoveryCheckpoint (string) --
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.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats (dict) --
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent (integer) --
The percent complete for the full load migration task.
ElapsedTimeMillis (integer) --
The elapsed time of the task, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this task.
TablesLoading (integer) --
The number of tables currently loading for this task.
TablesQueued (integer) --
The number of tables queued for this task.
TablesErrored (integer) --
The number of errors that have occurred during this task.
FreshStartDate (datetime) --
The date the replication task was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
StopDate (datetime) --
The date the replication task was stopped.
FullLoadStartDate (datetime) --
The date the replication task full load was started.
FullLoadFinishDate (datetime) --
The date the replication task full load was completed.
TaskData (string) --
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 AWS Database Migration Service User Guide.
TargetReplicationInstanceArn (string) --
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Examples
Creates a replication task using the specified parameters.
response = client.create_replication_task(
CdcStartTime=datetime(2016, 12, 14, 18, 25, 43, 2, 349, 0),
MigrationType='full-load',
ReplicationInstanceArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
ReplicationTaskIdentifier='task1',
ReplicationTaskSettings='',
SourceEndpointArn='arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
TableMappings='file://mappingfile.json',
Tags=[
{
'Key': 'Acount',
'Value': '24352226',
},
],
TargetEndpointArn='arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
)
print(response)
Expected Output:
{
'ReplicationTask': {
'MigrationType': 'full-load',
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationTaskArn': 'arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM',
'ReplicationTaskCreationDate': datetime(2016, 12, 14, 18, 25, 43, 2, 349, 0),
'ReplicationTaskIdentifier': 'task1',
'ReplicationTaskSettings': '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}',
'SourceEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
'Status': 'creating',
'TableMappings': 'file://mappingfile.json',
'TargetEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified certificate.
See also: AWS API Documentation
Request Syntax
response = client.delete_certificate(
CertificateArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the deleted certificate.
{
'Certificate': {
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
}
}
Response Structure
The Secure Sockets Layer (SSL) certificate.
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 date that the certificate was created.
The contents of a .pem file, which contains an X.509 certificate.
The location of an imported Oracle Wallet certificate for use with SSL.
The Amazon Resource Name (ARN) for the certificate.
The owner of the certificate.
The beginning date that the certificate is valid.
The final date that the certificate is valid.
The signing algorithm for the certificate.
The key length of the cryptographic algorithm being used.
Exceptions
Examples
Deletes the specified certificate.
response = client.delete_certificate(
CertificateArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ',
)
print(response)
Expected Output:
{
'Certificate': {
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes the connection between a replication instance and an endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
EndpointArn='string',
ReplicationInstanceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
dict
Response Syntax
{
'Connection': {
'ReplicationInstanceArn': 'string',
'EndpointArn': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'EndpointIdentifier': 'string',
'ReplicationInstanceIdentifier': 'string'
}
}
Response Structure
(dict) --
Connection (dict) --
The connection that is being deleted.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
EndpointArn (string) --
The ARN string that uniquely identifies the endpoint.
Status (string) --
The connection status. This parameter can return one of the following values:
LastFailureMessage (string) --
The error message when the connection last failed.
EndpointIdentifier (string) --
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.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Exceptions
Deletes the specified endpoint.
Note
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
EndpointArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'KinesisSettings': {
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
'KafkaSettings': {
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
'ElasticsearchSettings': {
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
'NeptuneSettings': {
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
'RedshiftSettings': {
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'PostgreSQLSettings': {
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MySQLSettings': {
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'OracleSettings': {
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
'SybaseSettings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MicrosoftSQLServerSettings': {
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'IBMDb2Settings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'DocDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
}
}
Response Structure
The endpoint that was deleted.
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.
The type of endpoint. Valid values are source and target .
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
The user name used to connect to the endpoint.
The name of the server at the endpoint.
The port value used to access the endpoint.
The name of the database at the endpoint.
Additional connection attributes used to connect to the endpoint.
The status of the endpoint.
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
The SSL mode used to connect to the endpoint. The default value is none .
The Amazon Resource Name (ARN) used by the service access IAM role.
The external table definition.
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.
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
The Amazon Resource Name (ARN) used by the service access IAM role.
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
Specifies how tables are defined in the S3 source files only.
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
The name of the S3 bucket.
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.
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
The format of the data that you want to use for output. You can choose one of the following:
The type of encoding you are using:
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.
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).
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.
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
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.
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
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 partitoning, see Using date-based folder partitioning .
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 .
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
The IAM role that has permission to access the Amazon S3 bucket.
The name of the S3 bucket to use.
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
The user name you use to access the MongoDB source endpoint.
The password for the user account you use to access the MongoDB source endpoint.
The name of the server on the MongoDB source endpoint.
The port value for the MongoDB source endpoint.
The database name on the MongoDB source endpoint.
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.
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" .
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
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 .
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
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).
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
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 .
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
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 .
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 .
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
Include NULL and empty columns for records migrated to the endpoint. The default is false .
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
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).
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 .
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
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 .
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 .
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Include NULL and empty columns for records migrated to the endpoint. The default is false .
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 .
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
The password for the client private key used to securely connect to a Kafka target endpoint.
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
The secure username 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.
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.
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
The Amazon Resource Name (ARN) used by service to access the IAM role.
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
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. Elasticsearch 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.
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
The number of milliseconds for AWS 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.
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
If you want AWS 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 .
Settings for the Amazon Redshift endpoint.
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.
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
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 .
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
The name of the Amazon Redshift data warehouse (service) that you are working with.
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 .
A value that specifies whether AWS 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 .
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
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 .
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.
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
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).
The password for the user named in the username property.
The port number for Amazon Redshift. The default value is 5439.
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 .
A list of characters that you want to replace. Use with ReplaceChars .
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
The name of the Amazon Redshift cluster you are using.
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
The AWS 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.
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 .
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 .
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 .
An Amazon Redshift user name for a registered user.
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).
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
Database name for the endpoint.
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
Database name for the endpoint.
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
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.
Example: parallelLoadThreads=1
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
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.
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
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.
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).
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.
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.
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.
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.
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.
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
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.
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
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 .
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 .
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;
Database name for the endpoint.
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
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.
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
Endpoint connection password.
Endpoint TCP port.
When set to true , this attribute supports tablespace replication.
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
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 AWS DMS in the AWS Database Migration Service User Guide .
Fully qualified domain name of the endpoint.
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.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
Database name for the endpoint.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
Endpoint TCP port.
The maximum size of the packets (in bytes) used to transfer data using BCP.
Database name for the endpoint.
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Endpoint connection password.
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.
When this attribute is set to Y , AWS 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.
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
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.
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
Database name for the endpoint.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
Provides information that defines a DocumentDB endpoint.
The user name you use to access the DocumentDB source endpoint.
The password for the user account you use to access the DocumentDB source endpoint.
The name of the server on the DocumentDB source endpoint.
The port value for the DocumentDB source endpoint.
The database name on the DocumentDB source endpoint.
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
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 .
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
Exceptions
Examples
Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
response = client.delete_endpoint(
EndpointArn='arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
)
print(response)
Expected Output:
{
'Endpoint': {
'EndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
'EndpointIdentifier': 'test-endpoint-1',
'EndpointType': 'source',
'EngineName': 'mysql',
'KmsKeyId': 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
'Port': 3306,
'ServerName': 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
'Status': 'active',
'Username': 'username',
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes an AWS DMS event subscription.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_subscription(
SubscriptionName='string'
)
[REQUIRED]
The name of the DMS event notification subscription to be deleted.
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
}
}
Response Structure
The event subscription that was deleted.
The AWS customer account associated with the AWS DMS event notification subscription.
The AWS DMS event notification subscription Id.
The topic ARN of the AWS DMS event notification subscription.
The status of the AWS 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 AWS 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.
The time the AWS DMS event notification subscription was created.
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
A list of source Ids for the event subscription.
A lists of event categories.
Boolean value that indicates if the event subscription is enabled.
Exceptions
Deletes the specified replication instance.
Note
You must delete any migration tasks that are associated with the replication instance before you can delete it.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_instance(
ReplicationInstanceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance to be deleted.
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string'
}
}
Response Structure
The replication instance that was deleted.
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt 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 AWS DMS replication instance for your migration .
The status of the replication instance. The possible return values include:
The amount of storage (in gigabytes) that is allocated for the replication instance.
The time the replication instance was created.
The VPC security group for the instance.
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
The VPC security group ID.
The status of the VPC security group.
The Availability Zone for the instance.
The subnet group for the replication instance.
The identifier of the replication instance subnet group.
A description for the replication subnet group.
The ID of the VPC.
The status of the subnet group.
The subnets that are in the subnet group.
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
The subnet identifier.
The Availability Zone of the subnet.
The name of the Availability Zone.
The status of the subnet.
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
The pending modification values.
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 AWS DMS replication instance for your migration .
The amount of storage (in gigabytes) that is allocated for the replication instance.
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
The engine version number of the replication instance.
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The Amazon Resource Name (ARN) of the replication instance.
The public IP address of the replication instance.
The private IP address of the replication instance.
One or more public IP addresses for the replication instance.
One or more private IP addresses for the replication instance.
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 .
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
The expiration date of the free replication instance that is part of the Free DMS program.
The DNS name servers supported for the replication instance to access your on-premise source or target database.
Exceptions
Examples
Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
response = client.delete_replication_instance(
ReplicationInstanceArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
)
print(response)
Expected Output:
{
'ReplicationInstance': {
'AllocatedStorage': 5,
'AutoMinorVersionUpgrade': True,
'EngineVersion': '1.5.0',
'KmsKeyId': 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
'PendingModifiedValues': {
},
'PreferredMaintenanceWindow': 'sun:06:00-sun:14:00',
'PubliclyAccessible': True,
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationInstanceClass': 'dms.t2.micro',
'ReplicationInstanceIdentifier': 'test-rep-1',
'ReplicationInstanceStatus': 'creating',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupDescription': 'default',
'ReplicationSubnetGroupIdentifier': 'default',
'SubnetGroupStatus': 'Complete',
'Subnets': [
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1d',
},
'SubnetIdentifier': 'subnet-f6dd91af',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1b',
},
'SubnetIdentifier': 'subnet-3605751d',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1c',
},
'SubnetIdentifier': 'subnet-c2daefb5',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1e',
},
'SubnetIdentifier': 'subnet-85e90cb8',
'SubnetStatus': 'Active',
},
],
'VpcId': 'vpc-6741a603',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes a subnet group.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string'
)
[REQUIRED]
The subnet group name of the replication instance.
{}
Response Structure
Exceptions
Examples
Deletes a replication subnet group.
response = client.delete_replication_subnet_group(
ReplicationSubnetGroupIdentifier='us-west-2ab-vpc-215ds366',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified replication task.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_task(
ReplicationTaskArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task to be deleted.
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
The deleted replication task.
The user-assigned replication task identifier or name.
Constraints:
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
The ARN that uniquely identifies the endpoint.
The ARN of the replication instance.
The type of migration.
Table mappings specified in the task.
The settings for the replication task.
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
The last error (failure) message generated for the replication task.
The reason the replication task was stopped. This response parameter can return one of the following values:
The date the replication task was created.
The date the replication task is scheduled to start.
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”
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 “
Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
The Amazon Resource Name (ARN) of the replication task.
The statistics for the task, including elapsed time, tables loaded, and table errors.
The percent complete for the full load migration task.
The elapsed time of the task, in milliseconds.
The number of tables loaded for this task.
The number of tables currently loading for this task.
The number of tables queued for this task.
The number of errors that have occurred during this task.
The date the replication task was started either with a fresh start or a target reload.
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
The date the replication task was stopped.
The date the replication task full load was started.
The date the replication task full load was completed.
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 AWS Database Migration Service User Guide.
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Examples
Deletes the specified replication task.
response = client.delete_replication_task(
ReplicationTaskArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
)
print(response)
Expected Output:
{
'ReplicationTask': {
'MigrationType': 'full-load',
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationTaskArn': 'arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM',
'ReplicationTaskCreationDate': datetime(2016, 12, 14, 18, 25, 43, 2, 349, 0),
'ReplicationTaskIdentifier': 'task1',
'ReplicationTaskSettings': '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}',
'SourceEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
'Status': 'creating',
'TableMappings': 'file://mappingfile.json',
'TargetEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes the record of a single premigration assessment run.
This operation removes all metadata that AWS DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
{
'ReplicationTaskAssessmentRun': {
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string'
}
}
Response Structure
The ReplicationTaskAssessmentRun object for the deleted assessment run.
Amazon Resource Name (ARN) of this assessment run.
ARN of the migration task associated with this premigration assessment run.
Assessment run status.
This status can have one of the following values:
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
Indication of the completion progress for the individual assessments specified to run.
The number of individual assessments that are specified to run.
The number of individual assessments that have completed, successfully or not.
Last message generated by an individual assessment failure.
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
Amazon S3 bucket where AWS DMS stores the results of this assessment run.
Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment run.
Encryption mode used to encrypt the assessment run results.
ARN of the AWS KMS encryption key used to encrypt the assessment run results.
Unique name of the assessment run.
Exceptions
Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.
This command does not take any parameters.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_attributes()
{
'AccountQuotas': [
{
'AccountQuotaName': 'string',
'Used': 123,
'Max': 123
},
],
'UniqueAccountIdentifier': 'string'
}
Response Structure
Account quota information.
Describes a quota for an AWS account, for example, the number of replication instances allowed.
The name of the AWS DMS quota for this AWS account.
The amount currently used toward the quota maximum.
The maximum allowed value for the quota.
A unique AWS DMS identifier for an account in a particular AWS 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 AWS Region. The format of this S3 bucket name is the following: dms-*AccountNumber* -*UniqueAccountIdentifier* . Here is an example name for this default S3 bucket: dms-111122223333-c44445555666 .
Note
AWS DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
Examples
Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.
response = client.describe_account_attributes(
)
print(response)
Expected Output:
{
'AccountQuotas': [
{
'AccountQuotaName': 'ReplicationInstances',
'Max': 20,
'Used': 0,
},
{
'AccountQuotaName': 'AllocatedStorage',
'Max': 20,
'Used': 0,
},
{
'AccountQuotaName': 'Endpoints',
'Max': 20,
'Used': 0,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.
To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.
If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
See also: AWS API Documentation
Request Syntax
response = client.describe_applicable_individual_assessments(
ReplicationTaskArn='string',
ReplicationInstanceArn='string',
SourceEngineName='string',
TargetEngineName='string',
MigrationType='full-load'|'cdc'|'full-load-and-cdc',
MaxRecords=123,
Marker='string'
)
dict
Response Syntax
{
'IndividualAssessmentNames': [
'string',
],
'Marker': 'string'
}
Response Structure
(dict) --
IndividualAssessmentNames (list) --
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 AWS Database Migration Service User Guide.
Marker (string) --
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 .
Exceptions
Provides a description of the certificate.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificates(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
Filters applied to the certificates described in the form of key-value pairs.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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
dict
Response Syntax
{
'Marker': 'string',
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
},
]
}
Response Structure
(dict) --
Marker (string) --
The pagination token.
Certificates (list) --
The Secure Sockets Layer (SSL) certificates associated with the replication instance.
(dict) --
The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.
CertificateIdentifier (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.
CertificateCreationDate (datetime) --
The date that the certificate was created.
CertificatePem (string) --
The contents of a .pem file, which contains an X.509 certificate.
CertificateWallet (bytes) --
The location of an imported Oracle Wallet certificate for use with SSL.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
CertificateOwner (string) --
The owner of the certificate.
ValidFromDate (datetime) --
The beginning date that the certificate is valid.
ValidToDate (datetime) --
The final date that the certificate is valid.
SigningAlgorithm (string) --
The signing algorithm for the certificate.
KeyLength (integer) --
The key length of the cryptographic algorithm being used.
Exceptions
Examples
Provides a description of the certificate.
response = client.describe_certificates(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Certificates': [
],
'Marker': '',
'ResponseMetadata': {
'...': '...',
},
}
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'Connections': [
{
'ReplicationInstanceArn': 'string',
'EndpointArn': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'EndpointIdentifier': 'string',
'ReplicationInstanceIdentifier': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Connections (list) --
A description of the connections.
(dict) --
Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
EndpointArn (string) --
The ARN string that uniquely identifies the endpoint.
Status (string) --
The connection status. This parameter can return one of the following values:
LastFailureMessage (string) --
The error message when the connection last failed.
EndpointIdentifier (string) --
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.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Exceptions
Examples
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
response = client.describe_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Connections': [
{
'EndpointArn': 'arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
'EndpointIdentifier': 'testsrc1',
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationInstanceIdentifier': 'test',
'Status': 'successful',
},
],
'Marker': '',
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoint_settings(
EngineName='string',
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The databse engine used for your source or target endpoint.
dict
Response Syntax
{
'Marker': 'string',
'EndpointSettings': [
{
'Name': 'string',
'Type': 'string'|'boolean'|'integer'|'enum',
'EnumValues': [
'string',
],
'Sensitive': True|False,
'Units': 'string',
'Applicability': 'string',
'IntValueMin': 123,
'IntValueMax': 123
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
EndpointSettings (list) --
Descriptions of the endpoint settings available for your source or target database engine.
(dict) --
Endpoint settings.
Name (string) --
The name that you want to give the endpoint settings.
Type (string) --
The type of endpoint. Valid values are source and target .
EnumValues (list) --
Enumerated values to use for this endpoint.
Sensitive (boolean) --
A value that marks this endpoint setting as sensitive.
Units (string) --
The unit of measure for this endpoint setting.
Applicability (string) --
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
IntValueMin (integer) --
The minimum value of an endpoint setting that is of type int .
IntValueMax (integer) --
The maximum value of an endpoint setting that is of type int .
Returns information about the type of endpoints available.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoint_types(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'SupportedEndpointTypes': [
{
'EngineName': 'string',
'SupportsCDC': True|False,
'EndpointType': 'source'|'target',
'ReplicationInstanceEngineMinimumVersion': 'string',
'EngineDisplayName': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
SupportedEndpointTypes (list) --
The types of endpoints that are supported.
(dict) --
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.
EngineName (string) --
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
SupportsCDC (boolean) --
Indicates if Change Data Capture (CDC) is supported.
EndpointType (string) --
The type of endpoint. Valid values are source and target .
ReplicationInstanceEngineMinimumVersion (string) --
The earliest AWS DMS engine version that supports this endpoint engine. Note that endpoint engines released with AWS DMS versions earlier than 3.1.1 do not return a value for this parameter.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Examples
Returns information about the type of endpoints available.
response = client.describe_endpoint_types(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Marker': '',
'SupportedEndpointTypes': [
],
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the endpoints for your account in the current region.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoints(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'Endpoints': [
{
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'KinesisSettings': {
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
'KafkaSettings': {
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
'ElasticsearchSettings': {
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
'NeptuneSettings': {
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
'RedshiftSettings': {
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'PostgreSQLSettings': {
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MySQLSettings': {
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'OracleSettings': {
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
'SybaseSettings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MicrosoftSQLServerSettings': {
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'IBMDb2Settings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'DocDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Endpoints (list) --
Endpoint description.
(dict) --
Describes an endpoint of a database instance in response to operations such as the following:
EndpointIdentifier (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.
EndpointType (string) --
The type of endpoint. Valid values are source and target .
EngineName (string) --
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint. The default value is none .
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
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.
DynamoDbSettings (dict) --
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
ExternalTableDefinition (string) --
Specifies how tables are defined in the S3 source files only.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
CsvDelimiter (string) --
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
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.
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
ServerSideEncryptionKmsKeyId (string) --
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
DataFormat (string) --
The format of the data that you want to use for output. You can choose one of the following:
EncodingType (string) --
The type of encoding you are using:
DictPageSizeLimit (integer) --
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.
RowGroupLength (integer) --
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).
DataPageSize (integer) --
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.
ParquetVersion (string) --
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
EnableStatistics (boolean) --
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.
IncludeOpForFullLoad (boolean) --
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
CdcInsertsOnly (boolean) --
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
TimestampColumnName (string) --
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
ParquetTimestampInMillisecond (boolean) --
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
CdcInsertsAndUpdates (boolean) --
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
DatePartitionEnabled (boolean) --
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 partitoning, see Using date-based folder partitioning .
DatePartitionSequence (string) --
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 .
DatePartitionDelimiter (string) --
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
UseCsvNoSupValue (boolean) --
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
CsvNoSupValue (string) --
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
PreserveTransactions (boolean) --
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
CdcPath (string) --
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
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.
AuthMechanism (string) --
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" .
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (string) --
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 .
AuthSource (string) --
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
KinesisSettings (dict) --
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
StreamArn (string) --
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat (string) --
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).
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
KafkaSettings (dict) --
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
Broker (string) --
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
Topic (string) --
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
MessageFormat (string) --
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).
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
MessageMaxBytes (integer) --
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
SecurityProtocol (string) --
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 .
SslClientCertificateArn (string) --
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
SslClientKeyArn (string) --
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
SslClientKeyPassword (string) --
The password for the client private key used to securely connect to a Kafka target endpoint.
SslCaCertificateArn (string) --
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
SaslUsername (string) --
The secure username 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.
SaslPassword (string) --
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.
ElasticsearchSettings (dict) --
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by service to access the IAM role.
EndpointUri (string) --
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
FullLoadErrorPercentage (integer) --
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. Elasticsearch 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.
ErrorRetryDuration (integer) --
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
NeptuneSettings (dict) --
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
S3BucketName (string) --
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
S3BucketFolder (string) --
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
ErrorRetryDuration (integer) --
The number of milliseconds for AWS 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.
MaxFileSize (integer) --
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
MaxRetryCount (integer) --
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
IamAuthEnabled (boolean) --
If you want AWS 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 .
RedshiftSettings (dict) --
Settings for the Amazon Redshift endpoint.
AcceptAnyDate (boolean) --
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.
AfterConnectScript (string) --
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
BucketFolder (string) --
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
BucketName (string) --
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
CaseSensitiveNames (boolean) --
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
CompUpdate (boolean) --
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 .
ConnectionTimeout (integer) --
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
DatabaseName (string) --
The name of the Amazon Redshift data warehouse (service) that you are working with.
DateFormat (string) --
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 .
EmptyAsNull (boolean) --
A value that specifies whether AWS 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 .
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
ExplicitIds (boolean) --
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 .
FileTransferUploadStreams (integer) --
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.
LoadTimeout (integer) --
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
MaxFileSize (integer) --
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).
Password (string) --
The password for the user named in the username property.
Port (integer) --
The port number for Amazon Redshift. The default value is 5439.
RemoveQuotes (boolean) --
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 .
ReplaceInvalidChars (string) --
A list of characters that you want to replace. Use with ReplaceChars .
ReplaceChars (string) --
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
ServerName (string) --
The name of the Amazon Redshift cluster you are using.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
ServerSideEncryptionKmsKeyId (string) --
The AWS 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.
TimeFormat (string) --
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 .
TrimBlanks (boolean) --
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 .
TruncateColumns (boolean) --
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 .
Username (string) --
An Amazon Redshift user name for a registered user.
WriteBufferSize (integer) --
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).
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
PostgreSQLSettings (dict) --
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
AfterConnectScript (string) --
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
CaptureDdls (boolean) --
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
DatabaseName (string) --
Database name for the endpoint.
DdlArtifactsSchema (string) --
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
ExecuteTimeout (integer) --
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
FailTasksOnLobTruncation (boolean) --
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SlotName (string) --
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
MySQLSettings (dict) --
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
AfterConnectScript (string) --
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
CleanSourceMetadataOnMismatch (boolean) --
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
DatabaseName (string) --
Database name for the endpoint.
EventsPollInterval (integer) --
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
TargetDbType (string) --
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
ParallelLoadThreads (integer) --
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.
Example: parallelLoadThreads=1
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
ServerTimezone (string) --
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
OracleSettings (dict) --
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
AddSupplementalLogging (boolean) --
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.
ArchivedLogDestId (integer) --
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
AdditionalArchivedLogDestId (integer) --
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
AllowSelectNestedTables (boolean) --
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
ParallelAsmReadThreads (integer) --
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.
ReadAheadBlocks (integer) --
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).
AccessAlternateDirectly (boolean) --
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.
UseAlternateFolderForOnline (boolean) --
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.
OraclePathPrefix (string) --
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.
UsePathPrefix (string) --
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.
ReplacePathPrefix (boolean) --
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.
EnableHomogenousTablespace (boolean) --
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
DirectPathNoLog (boolean) --
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.
ArchivedLogsOnly (boolean) --
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
AsmPassword (string) --
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
AsmServer (string) --
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 .
AsmUser (string) --
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 .
CharLengthSemantics (string) --
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;
DatabaseName (string) --
Database name for the endpoint.
DirectPathParallelLoad (boolean) --
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
FailTasksOnLobTruncation (boolean) --
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.
NumberDatatypeScale (integer) --
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
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ReadTableSpaceName (boolean) --
When set to true , this attribute supports tablespace replication.
RetryInterval (integer) --
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
SecurityDbEncryption (string) --
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
SecurityDbEncryptionName (string) --
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 AWS DMS in the AWS Database Migration Service User Guide .
ServerName (string) --
Fully qualified domain name of the endpoint.
SpatialDataOptionToGeoJsonFunctionName (string) --
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.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
SecretsManagerOracleAsmAccessRoleArn (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerOracleAsmSecretId (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
SybaseSettings (dict) --
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
MicrosoftSQLServerSettings (dict) --
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
Port (integer) --
Endpoint TCP port.
BcpPacketSize (integer) --
The maximum size of the packets (in bytes) used to transfer data using BCP.
DatabaseName (string) --
Database name for the endpoint.
ControlTablesFileGroup (string) --
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Password (string) --
Endpoint connection password.
QuerySingleAlwaysOnNode (boolean) --
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.
ReadBackupOnly (boolean) --
When this attribute is set to Y , AWS 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.
SafeguardPolicy (string) --
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
UseBcpFullLoad (boolean) --
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.
UseThirdPartyBackupDevice (boolean) --
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
IBMDb2Settings (dict) --
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
SetDataCaptureChanges (boolean) --
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
CurrentLsn (string) --
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
MaxKBytesPerRead (integer) --
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
DocDbSettings (dict) --
Provides information that defines a DocumentDB endpoint.
Username (string) --
The user name you use to access the DocumentDB source endpoint.
Password (string) --
The password for the user account you use to access the DocumentDB source endpoint.
ServerName (string) --
The name of the server on the DocumentDB source endpoint.
Port (integer) --
The port value for the DocumentDB source endpoint.
DatabaseName (string) --
The database name on the DocumentDB source endpoint.
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (boolean) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (integer) --
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 .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
Exceptions
Examples
Returns information about the endpoints for your account in the current region.
response = client.describe_endpoints(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Endpoints': [
],
'Marker': '',
'ResponseMetadata': {
'...': '...',
},
}
Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_categories(
SourceType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-task
Filters applied to the event categories.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
dict
Response Syntax
{
'EventCategoryGroupList': [
{
'SourceType': 'string',
'EventCategories': [
'string',
]
},
]
}
Response Structure
(dict) --
EventCategoryGroupList (list) --
A list of event categories.
(dict) --
Lists categories of events subscribed to, and generated by, the applicable AWS DMS resource type. This data type appears in response to the ` DescribeEventCategories https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html`__ action.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
EventCategories (list) --
A list of event categories from a source type that you've chosen.
Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName , SNSTopicARN , CustomerID , SourceType , SourceID , CreationTime , and Status .
If you specify SubscriptionName , this action lists the description for that subscription.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_subscriptions(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
Filters applied to event subscriptions.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
EventSubscriptionsList (list) --
A list of event subscriptions.
(dict) --
Describes an event notification subscription created by the CreateEventSubscription operation.
CustomerAwsId (string) --
The AWS customer account associated with the AWS DMS event notification subscription.
CustSubscriptionId (string) --
The AWS DMS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the AWS DMS event notification subscription.
Status (string) --
The status of the AWS 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 AWS 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.
SubscriptionCreationTime (string) --
The time the AWS DMS event notification subscription was created.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
SourceIdsList (list) --
A list of source Ids for the event subscription.
EventCategoriesList (list) --
A lists of event categories.
Enabled (boolean) --
Boolean value that indicates if the event subscription is enabled.
Exceptions
Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
See also: AWS API Documentation
Request Syntax
response = client.describe_events(
SourceIdentifier='string',
SourceType='replication-instance',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-task
A list of event categories for the source type that you've chosen.
Filters applied to events.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'replication-instance',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Events (list) --
The events described.
(dict) --
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 AWS DMS resource type.
SourceIdentifier (string) --
The identifier of an event source.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | endpoint | replication-task
Message (string) --
The event message.
EventCategories (list) --
The event categories available for the specified source type.
Date (datetime) --
The date of the event.
Returns information about the replication instance types that can be created in the specified region.
See also: AWS API Documentation
Request Syntax
response = client.describe_orderable_replication_instances(
MaxRecords=123,
Marker='string'
)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'OrderableReplicationInstances': [
{
'EngineVersion': 'string',
'ReplicationInstanceClass': 'string',
'StorageType': 'string',
'MinAllocatedStorage': 123,
'MaxAllocatedStorage': 123,
'DefaultAllocatedStorage': 123,
'IncludedAllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'ReleaseStatus': 'beta'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
OrderableReplicationInstances (list) --
The order-able replication instances available.
(dict) --
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.
EngineVersion (string) --
The version of the replication engine.
ReplicationInstanceClass (string) --
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 AWS DMS replication instance for your migration .
StorageType (string) --
The type of storage used by the replication instance.
MinAllocatedStorage (integer) --
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
MaxAllocatedStorage (integer) --
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
DefaultAllocatedStorage (integer) --
The default amount of storage (in gigabytes) that is allocated for the replication instance.
IncludedAllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
AvailabilityZones (list) --
List of Availability Zones for this replication instance.
ReleaseStatus (string) --
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.
Note
AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Examples
Returns information about the replication instance types that can be created in the specified region.
response = client.describe_orderable_replication_instances(
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Marker': '',
'OrderableReplicationInstances': [
],
'ResponseMetadata': {
'...': '...',
},
}
For internal use only
See also: AWS API Documentation
Request Syntax
response = client.describe_pending_maintenance_actions(
ReplicationInstanceArn='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'PendingMaintenanceActions': [
{
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
PendingMaintenanceActions (list) --
The pending maintenance action.
(dict) --
Identifies an AWS DMS resource and any pending actions for it.
ResourceIdentifier (string) --
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 AWS DMS in the DMS documentation.
PendingMaintenanceActionDetails (list) --
Detailed information about the pending maintenance action.
(dict) --
Describes a maintenance action pending for an AWS DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.
Action (string) --
The type of pending maintenance action that is available for the resource.
AutoAppliedAfterDate (datetime) --
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.
ForcedApplyDate (datetime) --
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.
OptInStatus (string) --
The type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
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 .
Description (string) --
A description providing more detail about the maintenance action.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Exceptions
Returns the status of the RefreshSchemas operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_refresh_schemas_status(
EndpointArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
{
'RefreshSchemasStatus': {
'EndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'Status': 'successful'|'failed'|'refreshing',
'LastRefreshDate': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
}
Response Structure
The status of the schema.
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
The Amazon Resource Name (ARN) of the replication instance.
The status of the schema.
The date the schema was last refreshed.
The last failure message for the schema.
Exceptions
Examples
Returns the status of the refresh-schemas operation.
response = client.describe_refresh_schemas_status(
EndpointArn='',
)
print(response)
Expected Output:
{
'RefreshSchemasStatus': {
},
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the task logs for the specified task.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_instance_task_logs(
ReplicationInstanceArn='string',
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
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.
dict
Response Syntax
{
'ReplicationInstanceArn': 'string',
'ReplicationInstanceTaskLogs': [
{
'ReplicationTaskName': 'string',
'ReplicationTaskArn': 'string',
'ReplicationInstanceTaskLogSize': 123
},
],
'Marker': 'string'
}
Response Structure
(dict) --
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstanceTaskLogs (list) --
An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).
(dict) --
Contains metadata for a replication instance task log.
ReplicationTaskName (string) --
The name of the replication task.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationInstanceTaskLogSize (integer) --
The size, in bytes, of the replication task log.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Exceptions
Returns information about replication instances for your account in the current region.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationInstances': [
{
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
ReplicationInstances (list) --
The replication instances described.
(dict) --
Provides information that defines a replication instance.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt 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 AWS DMS replication instance for your migration .
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
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 AWS DMS replication instance for your migration .
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
PubliclyAccessible (boolean) --
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 .
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
Exceptions
Examples
Returns the status of the refresh-schemas operation.
response = client.describe_replication_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Marker': '',
'ReplicationInstances': [
],
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the replication subnet groups.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_subnet_groups(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationSubnetGroups': [
{
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
ReplicationSubnetGroups (list) --
A description of the replication subnet groups.
(dict) --
Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
Exceptions
Examples
Returns information about the replication subnet groups.
response = client.describe_replication_subnet_groups(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Marker': '',
'ReplicationSubnetGroups': [
],
'ResponseMetadata': {
'...': '...',
},
}
Returns the task assessment results from Amazon S3. This action always returns the latest results.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_task_assessment_results(
ReplicationTaskArn='string',
MaxRecords=123,
Marker='string'
)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'Marker': 'string',
'BucketName': 'string',
'ReplicationTaskAssessmentResults': [
{
'ReplicationTaskIdentifier': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskLastAssessmentDate': datetime(2015, 1, 1),
'AssessmentStatus': 'string',
'AssessmentResultsFile': 'string',
'AssessmentResults': 'string',
'S3ObjectUrl': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
BucketName (string) --
ReplicationTaskAssessmentResults (list) --
The task assessment report.
(dict) --
The task assessment report in JSON format.
ReplicationTaskIdentifier (string) --
The replication task identifier of the task on which the task assessment was run.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskLastAssessmentDate (datetime) --
The date the task assessment was completed.
AssessmentStatus (string) --
The status of the task assessment.
AssessmentResultsFile (string) --
The file containing the results of the task assessment.
AssessmentResults (string) --
The task assessment results in JSON format.
S3ObjectUrl (string) --
The URL of the S3 object containing the task assessment results.
Exceptions
Returns a paginated list of premigration assessment runs based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.
Note
This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_task_assessment_runs(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
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
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationTaskAssessmentRuns': [
{
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
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 .
ReplicationTaskAssessmentRuns (list) --
One or more premigration assessment runs as specified by Filters .
(dict) --
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.
ReplicationTaskAssessmentRunArn (string) --
Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn (string) --
ARN of the migration task associated with this premigration assessment run.
Status (string) --
Assessment run status.
This status can have one of the following values:
ReplicationTaskAssessmentRunCreationDate (datetime) --
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
AssessmentProgress (dict) --
Indication of the completion progress for the individual assessments specified to run.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
Last message generated by an individual assessment failure.
ServiceAccessRoleArn (string) --
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
ResultLocationBucket (string) --
Amazon S3 bucket where AWS DMS stores the results of this assessment run.
ResultLocationFolder (string) --
Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment run.
ResultEncryptionMode (string) --
Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn (string) --
ARN of the AWS KMS encryption key used to encrypt the assessment run results.
AssessmentRunName (string) --
Unique name of the assessment run.
Exceptions
Returns a paginated list of individual assessments based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_task_individual_assessments(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
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
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationTaskIndividualAssessments': [
{
'ReplicationTaskIndividualAssessmentArn': 'string',
'ReplicationTaskAssessmentRunArn': 'string',
'IndividualAssessmentName': 'string',
'Status': 'string',
'ReplicationTaskIndividualAssessmentStartDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Marker (string) --
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 .
ReplicationTaskIndividualAssessments (list) --
One or more individual assessments as specified by Filters .
(dict) --
Provides information that describes an individual assessment from a premigration assessment run.
ReplicationTaskIndividualAssessmentArn (string) --
Amazon Resource Name (ARN) of this individual assessment.
ReplicationTaskAssessmentRunArn (string) --
ARN of the premigration assessment run that is created to run this individual assessment.
IndividualAssessmentName (string) --
Name of this individual assessment.
Status (string) --
Individual assessment status.
This status can have one of the following values:
ReplicationTaskIndividualAssessmentStartDate (datetime) --
Date when this individual assessment was started as part of running the StartReplicationTaskAssessmentRun operation.
Exceptions
Returns information about replication tasks for your account in the current region.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_tasks(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WithoutSettings=True|False
)
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationTasks': [
{
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
ReplicationTasks (list) --
A description of the replication tasks.
(dict) --
Provides information that describes a replication task created by the CreateReplicationTask operation.
ReplicationTaskIdentifier (string) --
The user-assigned replication task identifier or name.
Constraints:
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
MigrationType (string) --
The type of migration.
TableMappings (string) --
Table mappings specified in the task.
ReplicationTaskSettings (string) --
The settings for the replication task.
Status (string) --
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
LastFailureMessage (string) --
The last error (failure) message generated for the replication task.
StopReason (string) --
The reason the replication task was stopped. This response parameter can return one of the following values:
ReplicationTaskCreationDate (datetime) --
The date the replication task was created.
ReplicationTaskStartDate (datetime) --
The date the replication task is scheduled to start.
CdcStartPosition (string) --
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”
CdcStopPosition (string) --
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 “
RecoveryCheckpoint (string) --
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.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats (dict) --
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent (integer) --
The percent complete for the full load migration task.
ElapsedTimeMillis (integer) --
The elapsed time of the task, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this task.
TablesLoading (integer) --
The number of tables currently loading for this task.
TablesQueued (integer) --
The number of tables queued for this task.
TablesErrored (integer) --
The number of errors that have occurred during this task.
FreshStartDate (datetime) --
The date the replication task was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
StopDate (datetime) --
The date the replication task was stopped.
FullLoadStartDate (datetime) --
The date the replication task full load was started.
FullLoadFinishDate (datetime) --
The date the replication task full load was completed.
TaskData (string) --
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 AWS Database Migration Service User Guide.
TargetReplicationInstanceArn (string) --
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Examples
Returns information about replication tasks for your account in the current region.
response = client.describe_replication_tasks(
Filters=[
{
'Name': 'string',
'Values': [
'string',
'string',
],
},
],
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Marker': '',
'ReplicationTasks': [
],
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the schema for the specified endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_schemas(
EndpointArn='string',
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
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.
dict
Response Syntax
{
'Marker': 'string',
'Schemas': [
'string',
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Schemas (list) --
The described schema.
Exceptions
Examples
Returns information about the schema for the specified endpoint.
response = client.describe_schemas(
EndpointArn='',
Marker='',
MaxRecords=123,
)
print(response)
Expected Output:
{
'Marker': '',
'Schemas': [
],
'ResponseMetadata': {
'...': '...',
},
}
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
See also: AWS API Documentation
Request Syntax
response = client.describe_table_statistics(
ReplicationTaskArn='string',
MaxRecords=123,
Marker='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
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.
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.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
dict
Response Syntax
{
'ReplicationTaskArn': 'string',
'TableStatistics': [
{
'SchemaName': 'string',
'TableName': 'string',
'Inserts': 123,
'Deletes': 123,
'Updates': 123,
'Ddls': 123,
'FullLoadRows': 123,
'FullLoadCondtnlChkFailedRows': 123,
'FullLoadErrorRows': 123,
'FullLoadStartTime': datetime(2015, 1, 1),
'FullLoadEndTime': datetime(2015, 1, 1),
'FullLoadReloaded': True|False,
'LastUpdateTime': datetime(2015, 1, 1),
'TableState': 'string',
'ValidationPendingRecords': 123,
'ValidationFailedRecords': 123,
'ValidationSuspendedRecords': 123,
'ValidationState': 'string',
'ValidationStateDetails': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
TableStatistics (list) --
The table statistics.
(dict) --
Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.
SchemaName (string) --
The schema name.
TableName (string) --
The name of the table.
Inserts (integer) --
The number of insert actions performed on a table.
Deletes (integer) --
The number of delete actions performed on a table.
Updates (integer) --
The number of update actions performed on a table.
Ddls (integer) --
The data definition language (DDL) used to build and modify the structure of your tables.
FullLoadRows (integer) --
The number of rows added during the full load operation.
FullLoadCondtnlChkFailedRows (integer) --
The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadErrorRows (integer) --
The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadStartTime (datetime) --
The time when the full load operation started.
FullLoadEndTime (datetime) --
The time when the full load operation completed.
FullLoadReloaded (boolean) --
A value that indicates if the table was reloaded (true ) or loaded as part of a new full load operation (false ).
LastUpdateTime (datetime) --
The last time a table was updated.
TableState (string) --
The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
ValidationPendingRecords (integer) --
The number of records that have yet to be validated.
ValidationFailedRecords (integer) --
The number of records that failed validation.
ValidationSuspendedRecords (integer) --
The number of records that couldn't be validated.
ValidationState (string) --
The validation state of the table.
This parameter can have the following values:
ValidationStateDetails (string) --
Additional details about the state of validation.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Exceptions
Examples
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
response = client.describe_table_statistics(
Marker='',
MaxRecords=123,
ReplicationTaskArn='',
)
print(response)
Expected Output:
{
'Marker': '',
'ReplicationTaskArn': '',
'TableStatistics': [
],
'ResponseMetadata': {
'...': '...',
},
}
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Uploads the specified certificate.
See also: AWS API Documentation
Request Syntax
response = client.import_certificate(
CertificateIdentifier='string',
CertificatePem='string',
CertificateWallet=b'bytes',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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 tags associated with the certificate.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
dict
Response Syntax
{
'Certificate': {
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
}
}
Response Structure
(dict) --
Certificate (dict) --
The certificate to be uploaded.
CertificateIdentifier (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.
CertificateCreationDate (datetime) --
The date that the certificate was created.
CertificatePem (string) --
The contents of a .pem file, which contains an X.509 certificate.
CertificateWallet (bytes) --
The location of an imported Oracle Wallet certificate for use with SSL.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
CertificateOwner (string) --
The owner of the certificate.
ValidFromDate (datetime) --
The beginning date that the certificate is valid.
ValidToDate (datetime) --
The final date that the certificate is valid.
SigningAlgorithm (string) --
The signing algorithm for the certificate.
KeyLength (integer) --
The key length of the cryptographic algorithm being used.
Exceptions
Examples
Uploads the specified certificate.
response = client.import_certificate(
CertificateIdentifier='',
CertificatePem='',
)
print(response)
Expected Output:
{
'Certificate': {
},
'ResponseMetadata': {
'...': '...',
},
}
Lists all metadata tags attached to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see ` Tag https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html`__ data type description.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A list of tags for the resource.
A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
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 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}_.:/=+\-]*)$").
Exceptions
Examples
Lists all tags for an AWS DMS resource.
response = client.list_tags_for_resource(
ResourceArn='',
)
print(response)
Expected Output:
{
'TagList': [
],
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified endpoint.
See also: AWS API Documentation
Request Syntax
response = client.modify_endpoint(
EndpointArn='string',
EndpointIdentifier='string',
EndpointType='source'|'target',
EngineName='string',
Username='string',
Password='string',
ServerName='string',
Port=123,
DatabaseName='string',
ExtraConnectionAttributes='string',
CertificateArn='string',
SslMode='none'|'require'|'verify-ca'|'verify-full',
ServiceAccessRoleArn='string',
ExternalTableDefinition='string',
DynamoDbSettings={
'ServiceAccessRoleArn': 'string'
},
S3Settings={
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
DmsTransferSettings={
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
MongoDbSettings={
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
KinesisSettings={
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
KafkaSettings={
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
ElasticsearchSettings={
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
NeptuneSettings={
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
RedshiftSettings={
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
PostgreSQLSettings={
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
MySQLSettings={
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
OracleSettings={
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
SybaseSettings={
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
MicrosoftSQLServerSettings={
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
IBMDb2Settings={
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
DocDbSettings={
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
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 AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) used by the service access IAM role.
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 AWS DMS in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
Specifies how tables are defined in the S3 source files only.
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
The name of the S3 bucket.
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.
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
The format of the data that you want to use for output. You can choose one of the following:
The type of encoding you are using:
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.
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).
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.
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
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.
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
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 partitoning, see Using date-based folder partitioning .
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 .
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
The settings in JSON format for the DMS transfer type of source endpoint.
Attributes include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
The IAM role that has permission to access the Amazon S3 bucket.
The name of the S3 bucket to use.
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
The user name you use to access the MongoDB source endpoint.
The password for the user account you use to access the MongoDB source endpoint.
The name of the server on the MongoDB source endpoint.
The port value for the MongoDB source endpoint.
The database name on the MongoDB source endpoint.
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.
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" .
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
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 .
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
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).
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
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 .
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
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 .
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 .
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
Include NULL and empty columns for records migrated to the endpoint. The default is false .
Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
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).
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 .
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
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 .
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 .
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Include NULL and empty columns for records migrated to the endpoint. The default is false .
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 .
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
The password for the client private key used to securely connect to a Kafka target endpoint.
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
The secure username 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.
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.
Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) used by service to access the IAM role.
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
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. Elasticsearch 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.
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
The number of milliseconds for AWS 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.
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
If you want AWS 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 .
Provides information that defines an Amazon Redshift endpoint.
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.
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
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 .
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
The name of the Amazon Redshift data warehouse (service) that you are working with.
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 .
A value that specifies whether AWS 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 .
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
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 .
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.
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
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).
The password for the user named in the username property.
The port number for Amazon Redshift. The default value is 5439.
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 .
A list of characters that you want to replace. Use with ReplaceChars .
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
The name of the Amazon Redshift cluster you are using.
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
The AWS 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.
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 .
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 .
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 .
An Amazon Redshift user name for a registered user.
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).
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
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 AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
Database name for the endpoint.
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
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 AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
Database name for the endpoint.
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
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.
Example: parallelLoadThreads=1
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
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 AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.
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.
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
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.
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).
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.
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.
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.
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.
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.
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
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.
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
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 .
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 .
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;
Database name for the endpoint.
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
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.
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
Endpoint connection password.
Endpoint TCP port.
When set to true , this attribute supports tablespace replication.
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
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 AWS DMS in the AWS Database Migration Service User Guide .
Fully qualified domain name of the endpoint.
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.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
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 AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.
Database name for the endpoint.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
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 AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.
Endpoint TCP port.
The maximum size of the packets (in bytes) used to transfer data using BCP.
Database name for the endpoint.
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Endpoint connection password.
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.
When this attribute is set to Y , AWS 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.
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
Fully qualified domain name of the endpoint.
Endpoint connection user name.
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.
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
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 AWS DMS in the AWS Database Migration Service User Guide.
Database name for the endpoint.
Endpoint connection password.
Endpoint TCP port.
Fully qualified domain name of the endpoint.
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Endpoint connection user name.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
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 AWS Database Migration Service in the AWS Database Migration Service User Guide.
The user name you use to access the DocumentDB source endpoint.
The password for the user account you use to access the DocumentDB source endpoint.
The name of the server on the DocumentDB source endpoint.
The port value for the DocumentDB source endpoint.
The database name on the DocumentDB source endpoint.
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
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 .
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
dict
Response Syntax
{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'KinesisSettings': {
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
'KafkaSettings': {
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
'ElasticsearchSettings': {
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
'NeptuneSettings': {
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
'RedshiftSettings': {
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'PostgreSQLSettings': {
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MySQLSettings': {
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'OracleSettings': {
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
'SybaseSettings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MicrosoftSQLServerSettings': {
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'IBMDb2Settings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'DocDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The modified endpoint.
EndpointIdentifier (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.
EndpointType (string) --
The type of endpoint. Valid values are source and target .
EngineName (string) --
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint. The default value is none .
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
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.
DynamoDbSettings (dict) --
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
ExternalTableDefinition (string) --
Specifies how tables are defined in the S3 source files only.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
CsvDelimiter (string) --
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
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.
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
ServerSideEncryptionKmsKeyId (string) --
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
DataFormat (string) --
The format of the data that you want to use for output. You can choose one of the following:
EncodingType (string) --
The type of encoding you are using:
DictPageSizeLimit (integer) --
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.
RowGroupLength (integer) --
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).
DataPageSize (integer) --
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.
ParquetVersion (string) --
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
EnableStatistics (boolean) --
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.
IncludeOpForFullLoad (boolean) --
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
CdcInsertsOnly (boolean) --
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
TimestampColumnName (string) --
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
ParquetTimestampInMillisecond (boolean) --
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
CdcInsertsAndUpdates (boolean) --
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
DatePartitionEnabled (boolean) --
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 partitoning, see Using date-based folder partitioning .
DatePartitionSequence (string) --
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 .
DatePartitionDelimiter (string) --
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
UseCsvNoSupValue (boolean) --
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
CsvNoSupValue (string) --
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
PreserveTransactions (boolean) --
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
CdcPath (string) --
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
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.
AuthMechanism (string) --
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" .
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (string) --
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 .
AuthSource (string) --
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
KinesisSettings (dict) --
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
StreamArn (string) --
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat (string) --
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).
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
KafkaSettings (dict) --
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
Broker (string) --
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
Topic (string) --
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
MessageFormat (string) --
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).
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
MessageMaxBytes (integer) --
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
SecurityProtocol (string) --
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 .
SslClientCertificateArn (string) --
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
SslClientKeyArn (string) --
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
SslClientKeyPassword (string) --
The password for the client private key used to securely connect to a Kafka target endpoint.
SslCaCertificateArn (string) --
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
SaslUsername (string) --
The secure username 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.
SaslPassword (string) --
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.
ElasticsearchSettings (dict) --
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by service to access the IAM role.
EndpointUri (string) --
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
FullLoadErrorPercentage (integer) --
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. Elasticsearch 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.
ErrorRetryDuration (integer) --
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
NeptuneSettings (dict) --
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
S3BucketName (string) --
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
S3BucketFolder (string) --
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
ErrorRetryDuration (integer) --
The number of milliseconds for AWS 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.
MaxFileSize (integer) --
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
MaxRetryCount (integer) --
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
IamAuthEnabled (boolean) --
If you want AWS 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 .
RedshiftSettings (dict) --
Settings for the Amazon Redshift endpoint.
AcceptAnyDate (boolean) --
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.
AfterConnectScript (string) --
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
BucketFolder (string) --
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
BucketName (string) --
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
CaseSensitiveNames (boolean) --
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
CompUpdate (boolean) --
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 .
ConnectionTimeout (integer) --
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
DatabaseName (string) --
The name of the Amazon Redshift data warehouse (service) that you are working with.
DateFormat (string) --
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 .
EmptyAsNull (boolean) --
A value that specifies whether AWS 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 .
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
ExplicitIds (boolean) --
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 .
FileTransferUploadStreams (integer) --
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.
LoadTimeout (integer) --
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
MaxFileSize (integer) --
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).
Password (string) --
The password for the user named in the username property.
Port (integer) --
The port number for Amazon Redshift. The default value is 5439.
RemoveQuotes (boolean) --
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 .
ReplaceInvalidChars (string) --
A list of characters that you want to replace. Use with ReplaceChars .
ReplaceChars (string) --
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
ServerName (string) --
The name of the Amazon Redshift cluster you are using.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
ServerSideEncryptionKmsKeyId (string) --
The AWS 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.
TimeFormat (string) --
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 .
TrimBlanks (boolean) --
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 .
TruncateColumns (boolean) --
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 .
Username (string) --
An Amazon Redshift user name for a registered user.
WriteBufferSize (integer) --
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).
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
PostgreSQLSettings (dict) --
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
AfterConnectScript (string) --
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
CaptureDdls (boolean) --
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
DatabaseName (string) --
Database name for the endpoint.
DdlArtifactsSchema (string) --
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
ExecuteTimeout (integer) --
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
FailTasksOnLobTruncation (boolean) --
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SlotName (string) --
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
MySQLSettings (dict) --
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
AfterConnectScript (string) --
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
CleanSourceMetadataOnMismatch (boolean) --
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
DatabaseName (string) --
Database name for the endpoint.
EventsPollInterval (integer) --
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
TargetDbType (string) --
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
ParallelLoadThreads (integer) --
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.
Example: parallelLoadThreads=1
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
ServerTimezone (string) --
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
OracleSettings (dict) --
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
AddSupplementalLogging (boolean) --
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.
ArchivedLogDestId (integer) --
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
AdditionalArchivedLogDestId (integer) --
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
AllowSelectNestedTables (boolean) --
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
ParallelAsmReadThreads (integer) --
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.
ReadAheadBlocks (integer) --
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).
AccessAlternateDirectly (boolean) --
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.
UseAlternateFolderForOnline (boolean) --
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.
OraclePathPrefix (string) --
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.
UsePathPrefix (string) --
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.
ReplacePathPrefix (boolean) --
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.
EnableHomogenousTablespace (boolean) --
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
DirectPathNoLog (boolean) --
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.
ArchivedLogsOnly (boolean) --
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
AsmPassword (string) --
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
AsmServer (string) --
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 .
AsmUser (string) --
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 .
CharLengthSemantics (string) --
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;
DatabaseName (string) --
Database name for the endpoint.
DirectPathParallelLoad (boolean) --
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
FailTasksOnLobTruncation (boolean) --
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.
NumberDatatypeScale (integer) --
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
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ReadTableSpaceName (boolean) --
When set to true , this attribute supports tablespace replication.
RetryInterval (integer) --
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
SecurityDbEncryption (string) --
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
SecurityDbEncryptionName (string) --
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 AWS DMS in the AWS Database Migration Service User Guide .
ServerName (string) --
Fully qualified domain name of the endpoint.
SpatialDataOptionToGeoJsonFunctionName (string) --
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.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
SecretsManagerOracleAsmAccessRoleArn (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerOracleAsmSecretId (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
SybaseSettings (dict) --
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
MicrosoftSQLServerSettings (dict) --
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
Port (integer) --
Endpoint TCP port.
BcpPacketSize (integer) --
The maximum size of the packets (in bytes) used to transfer data using BCP.
DatabaseName (string) --
Database name for the endpoint.
ControlTablesFileGroup (string) --
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Password (string) --
Endpoint connection password.
QuerySingleAlwaysOnNode (boolean) --
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.
ReadBackupOnly (boolean) --
When this attribute is set to Y , AWS 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.
SafeguardPolicy (string) --
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
UseBcpFullLoad (boolean) --
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.
UseThirdPartyBackupDevice (boolean) --
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
IBMDb2Settings (dict) --
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
SetDataCaptureChanges (boolean) --
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
CurrentLsn (string) --
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
MaxKBytesPerRead (integer) --
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
DocDbSettings (dict) --
Provides information that defines a DocumentDB endpoint.
Username (string) --
The user name you use to access the DocumentDB source endpoint.
Password (string) --
The password for the user account you use to access the DocumentDB source endpoint.
ServerName (string) --
The name of the server on the DocumentDB source endpoint.
Port (integer) --
The port value for the DocumentDB source endpoint.
DatabaseName (string) --
The database name on the DocumentDB source endpoint.
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (boolean) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (integer) --
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 .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
Exceptions
Examples
Modifies the specified endpoint.
response = client.modify_endpoint(
CertificateArn='',
DatabaseName='',
EndpointArn='',
EndpointIdentifier='',
EndpointType='source',
EngineName='',
ExtraConnectionAttributes='',
Password='',
Port=123,
ServerName='',
SslMode='require',
Username='',
)
print(response)
Expected Output:
{
'Endpoint': {
},
'ResponseMetadata': {
'...': '...',
},
}
Modifies an existing AWS DMS event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.modify_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
Enabled=True|False
)
[REQUIRED]
The name of the AWS DMS event notification subscription to be modified.
The type of AWS DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | replication-task
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.
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
}
}
Response Structure
(dict) --
EventSubscription (dict) --
The modified event subscription.
CustomerAwsId (string) --
The AWS customer account associated with the AWS DMS event notification subscription.
CustSubscriptionId (string) --
The AWS DMS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the AWS DMS event notification subscription.
Status (string) --
The status of the AWS 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 AWS 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.
SubscriptionCreationTime (string) --
The time the AWS DMS event notification subscription was created.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
SourceIdsList (list) --
A list of source Ids for the event subscription.
EventCategoriesList (list) --
A lists of event categories.
Enabled (boolean) --
Boolean value that indicates if the event subscription is enabled.
Exceptions
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
See also: AWS API Documentation
Request Syntax
response = client.modify_replication_instance(
ReplicationInstanceArn='string',
AllocatedStorage=123,
ApplyImmediately=True|False,
ReplicationInstanceClass='string',
VpcSecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
AutoMinorVersionUpgrade=True|False,
ReplicationInstanceIdentifier='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
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 AWS DMS replication instance for your migration .
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.
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
The engine version number of the replication instance.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
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.
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:
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The modified replication instance.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt 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 AWS DMS replication instance for your migration .
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
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 AWS DMS replication instance for your migration .
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
PubliclyAccessible (boolean) --
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 .
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
Exceptions
Examples
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
response = client.modify_replication_instance(
AllocatedStorage=123,
AllowMajorVersionUpgrade=True,
ApplyImmediately=True,
AutoMinorVersionUpgrade=True,
EngineVersion='1.5.0',
MultiAZ=True,
PreferredMaintenanceWindow='sun:06:00-sun:14:00',
ReplicationInstanceArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
ReplicationInstanceClass='dms.t2.micro',
ReplicationInstanceIdentifier='test-rep-1',
VpcSecurityGroupIds=[
],
)
print(response)
Expected Output:
{
'ReplicationInstance': {
'AllocatedStorage': 5,
'AutoMinorVersionUpgrade': True,
'EngineVersion': '1.5.0',
'KmsKeyId': 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
'PendingModifiedValues': {
},
'PreferredMaintenanceWindow': 'sun:06:00-sun:14:00',
'PubliclyAccessible': True,
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationInstanceClass': 'dms.t2.micro',
'ReplicationInstanceIdentifier': 'test-rep-1',
'ReplicationInstanceStatus': 'available',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupDescription': 'default',
'ReplicationSubnetGroupIdentifier': 'default',
'SubnetGroupStatus': 'Complete',
'Subnets': [
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1d',
},
'SubnetIdentifier': 'subnet-f6dd91af',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1b',
},
'SubnetIdentifier': 'subnet-3605751d',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1c',
},
'SubnetIdentifier': 'subnet-c2daefb5',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-east-1e',
},
'SubnetIdentifier': 'subnet-85e90cb8',
'SubnetStatus': 'Active',
},
],
'VpcId': 'vpc-6741a603',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Modifies the settings for the specified replication subnet group.
See also: AWS API Documentation
Request Syntax
response = client.modify_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string',
ReplicationSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
[REQUIRED]
The name of the replication instance subnet group.
[REQUIRED]
A list of subnet IDs.
dict
Response Syntax
{
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
}
}
Response Structure
(dict) --
ReplicationSubnetGroup (dict) --
The modified replication subnet group.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
Exceptions
Examples
Modifies the settings for the specified replication subnet group.
response = client.modify_replication_subnet_group(
ReplicationSubnetGroupDescription='',
ReplicationSubnetGroupIdentifier='',
SubnetIds=[
],
)
print(response)
Expected Output:
{
'ReplicationSubnetGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified replication task.
You can't modify the task endpoints. The task must be stopped before you can modify it.
For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_replication_task(
ReplicationTaskArn='string',
ReplicationTaskIdentifier='string',
MigrationType='full-load'|'cdc'|'full-load-and-cdc',
TableMappings='string',
ReplicationTaskSettings='string',
CdcStartTime=datetime(2015, 1, 1),
CdcStartPosition='string',
CdcStopPosition='string',
TaskData='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
The replication task identifier.
Constraints:
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”
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”
Note
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 AWS DMS .
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 “
dict
Response Syntax
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task that was modified.
ReplicationTaskIdentifier (string) --
The user-assigned replication task identifier or name.
Constraints:
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
MigrationType (string) --
The type of migration.
TableMappings (string) --
Table mappings specified in the task.
ReplicationTaskSettings (string) --
The settings for the replication task.
Status (string) --
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
LastFailureMessage (string) --
The last error (failure) message generated for the replication task.
StopReason (string) --
The reason the replication task was stopped. This response parameter can return one of the following values:
ReplicationTaskCreationDate (datetime) --
The date the replication task was created.
ReplicationTaskStartDate (datetime) --
The date the replication task is scheduled to start.
CdcStartPosition (string) --
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”
CdcStopPosition (string) --
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 “
RecoveryCheckpoint (string) --
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.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats (dict) --
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent (integer) --
The percent complete for the full load migration task.
ElapsedTimeMillis (integer) --
The elapsed time of the task, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this task.
TablesLoading (integer) --
The number of tables currently loading for this task.
TablesQueued (integer) --
The number of tables queued for this task.
TablesErrored (integer) --
The number of errors that have occurred during this task.
FreshStartDate (datetime) --
The date the replication task was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
StopDate (datetime) --
The date the replication task was stopped.
FullLoadStartDate (datetime) --
The date the replication task full load was started.
FullLoadFinishDate (datetime) --
The date the replication task full load was completed.
TaskData (string) --
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 AWS Database Migration Service User Guide.
TargetReplicationInstanceArn (string) --
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later AWS DMS version as the current replication instance.
See also: AWS API Documentation
Request Syntax
response = client.move_replication_task(
ReplicationTaskArn='string',
TargetReplicationInstanceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the task that you want to move.
[REQUIRED]
The ARN of the replication instance where you want to move the task to.
dict
Response Syntax
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task that was moved.
ReplicationTaskIdentifier (string) --
The user-assigned replication task identifier or name.
Constraints:
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
MigrationType (string) --
The type of migration.
TableMappings (string) --
Table mappings specified in the task.
ReplicationTaskSettings (string) --
The settings for the replication task.
Status (string) --
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
LastFailureMessage (string) --
The last error (failure) message generated for the replication task.
StopReason (string) --
The reason the replication task was stopped. This response parameter can return one of the following values:
ReplicationTaskCreationDate (datetime) --
The date the replication task was created.
ReplicationTaskStartDate (datetime) --
The date the replication task is scheduled to start.
CdcStartPosition (string) --
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”
CdcStopPosition (string) --
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 “
RecoveryCheckpoint (string) --
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.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats (dict) --
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent (integer) --
The percent complete for the full load migration task.
ElapsedTimeMillis (integer) --
The elapsed time of the task, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this task.
TablesLoading (integer) --
The number of tables currently loading for this task.
TablesQueued (integer) --
The number of tables queued for this task.
TablesErrored (integer) --
The number of errors that have occurred during this task.
FreshStartDate (datetime) --
The date the replication task was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
StopDate (datetime) --
The date the replication task was stopped.
FullLoadStartDate (datetime) --
The date the replication task full load was started.
FullLoadFinishDate (datetime) --
The date the replication task full load was completed.
TaskData (string) --
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 AWS Database Migration Service User Guide.
TargetReplicationInstanceArn (string) --
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
See also: AWS API Documentation
Request Syntax
response = client.reboot_replication_instance(
ReplicationInstanceArn='string',
ForceFailover=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
dict
Response Syntax
{
'ReplicationInstance': {
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string'
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that is being rebooted.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt 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 AWS DMS replication instance for your migration .
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
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 AWS DMS replication instance for your migration .
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
PubliclyAccessible (boolean) --
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 .
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
Exceptions
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
See also: AWS API Documentation
Request Syntax
response = client.refresh_schemas(
EndpointArn='string',
ReplicationInstanceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
dict
Response Syntax
{
'RefreshSchemasStatus': {
'EndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'Status': 'successful'|'failed'|'refreshing',
'LastRefreshDate': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
}
Response Structure
(dict) --
RefreshSchemasStatus (dict) --
The status of the refreshed schema.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
Status (string) --
The status of the schema.
LastRefreshDate (datetime) --
The date the schema was last refreshed.
LastFailureMessage (string) --
The last failure message for the schema.
Exceptions
Examples
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.
response = client.refresh_schemas(
EndpointArn='',
ReplicationInstanceArn='',
)
print(response)
Expected Output:
{
'RefreshSchemasStatus': {
},
'ResponseMetadata': {
'...': '...',
},
}
Reloads the target database table with the source data.
See also: AWS API Documentation
Request Syntax
response = client.reload_tables(
ReplicationTaskArn='string',
TablesToReload=[
{
'SchemaName': 'string',
'TableName': 'string'
},
],
ReloadOption='data-reload'|'validate-only'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
[REQUIRED]
The name and schema of the table to be reloaded.
Provides the name of the schema and table to be reloaded.
The schema name of the table to be reloaded.
The table name of the table to be reloaded.
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.
dict
Response Syntax
{
'ReplicationTaskArn': 'string'
}
Response Structure
(dict) --
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
Exceptions
Removes metadata tags from an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see ` Tag https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html`__ data type description.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
An AWS DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
[REQUIRED]
The tag key (name) of the tag to be removed.
dict
Response Syntax
{}
Response Structure
Exceptions
Examples
Removes metadata tags from an AWS DMS resource.
response = client.remove_tags_from_resource(
ResourceArn='arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
TagKeys=[
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Starts the replication task.
For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
See also: AWS API Documentation
Request Syntax
response = client.start_replication_task(
ReplicationTaskArn='string',
StartReplicationTaskType='start-replication'|'resume-processing'|'reload-target',
CdcStartTime=datetime(2015, 1, 1),
CdcStartPosition='string',
CdcStopPosition='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task to be started.
[REQUIRED]
A type of replication task.
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”
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”
Note
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 AWS DMS .
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 “
dict
Response Syntax
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task started.
ReplicationTaskIdentifier (string) --
The user-assigned replication task identifier or name.
Constraints:
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
MigrationType (string) --
The type of migration.
TableMappings (string) --
Table mappings specified in the task.
ReplicationTaskSettings (string) --
The settings for the replication task.
Status (string) --
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
LastFailureMessage (string) --
The last error (failure) message generated for the replication task.
StopReason (string) --
The reason the replication task was stopped. This response parameter can return one of the following values:
ReplicationTaskCreationDate (datetime) --
The date the replication task was created.
ReplicationTaskStartDate (datetime) --
The date the replication task is scheduled to start.
CdcStartPosition (string) --
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”
CdcStopPosition (string) --
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 “
RecoveryCheckpoint (string) --
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.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats (dict) --
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent (integer) --
The percent complete for the full load migration task.
ElapsedTimeMillis (integer) --
The elapsed time of the task, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this task.
TablesLoading (integer) --
The number of tables currently loading for this task.
TablesQueued (integer) --
The number of tables queued for this task.
TablesErrored (integer) --
The number of errors that have occurred during this task.
FreshStartDate (datetime) --
The date the replication task was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
StopDate (datetime) --
The date the replication task was stopped.
FullLoadStartDate (datetime) --
The date the replication task full load was started.
FullLoadFinishDate (datetime) --
The date the replication task full load was completed.
TaskData (string) --
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 AWS Database Migration Service User Guide.
TargetReplicationInstanceArn (string) --
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Examples
Starts the replication task.
response = client.start_replication_task(
CdcStartTime=datetime(2016, 12, 14, 13, 33, 20, 2, 349, 0),
ReplicationTaskArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
StartReplicationTaskType='start-replication',
)
print(response)
Expected Output:
{
'ReplicationTask': {
'MigrationType': 'full-load',
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationTaskArn': 'arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM',
'ReplicationTaskCreationDate': datetime(2016, 12, 14, 18, 25, 43, 2, 349, 0),
'ReplicationTaskIdentifier': 'task1',
'ReplicationTaskSettings': '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}',
'SourceEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
'Status': 'creating',
'TableMappings': 'file://mappingfile.json',
'TargetEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
},
'ResponseMetadata': {
'...': '...',
},
}
Starts the replication task assessment for unsupported data types in the source database.
See also: AWS API Documentation
Request Syntax
response = client.start_replication_task_assessment(
ReplicationTaskArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
The assessed replication task.
The user-assigned replication task identifier or name.
Constraints:
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
The ARN that uniquely identifies the endpoint.
The ARN of the replication instance.
The type of migration.
Table mappings specified in the task.
The settings for the replication task.
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
The last error (failure) message generated for the replication task.
The reason the replication task was stopped. This response parameter can return one of the following values:
The date the replication task was created.
The date the replication task is scheduled to start.
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”
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 “
Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
The Amazon Resource Name (ARN) of the replication task.
The statistics for the task, including elapsed time, tables loaded, and table errors.
The percent complete for the full load migration task.
The elapsed time of the task, in milliseconds.
The number of tables loaded for this task.
The number of tables currently loading for this task.
The number of tables queued for this task.
The number of errors that have occurred during this task.
The date the replication task was started either with a fresh start or a target reload.
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
The date the replication task was stopped.
The date the replication task full load was started.
The date the replication task full load was completed.
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 AWS Database Migration Service User Guide.
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Starts a new premigration assessment run for one or more individual assessments of a migration task.
The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
See also: AWS API Documentation
Request Syntax
response = client.start_replication_task_assessment_run(
ReplicationTaskArn='string',
ServiceAccessRoleArn='string',
ResultLocationBucket='string',
ResultLocationFolder='string',
ResultEncryptionMode='string',
ResultKmsKeyArn='string',
AssessmentRunName='string',
IncludeOnly=[
'string',
],
Exclude=[
'string',
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
[REQUIRED]
ARN of a service role needed to start the assessment run.
[REQUIRED]
Amazon S3 bucket where you want AWS DMS to store the results of this assessment run.
Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, AWS DMS stores the assessment run results without encryption. You can specify one of the options following:
[REQUIRED]
Unique name to identify the assessment run.
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 AWS DMS supports for the associated migration task. This task is specified by ReplicationTaskArn .
Note
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 AWS DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
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 AWS DMS supports for the associated migration task. This task is specified by ReplicationTaskArn .
Note
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 AWS DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
dict
Response Syntax
{
'ReplicationTaskAssessmentRun': {
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string'
}
}
Response Structure
(dict) --
ReplicationTaskAssessmentRun (dict) --
The premigration assessment run that was started.
ReplicationTaskAssessmentRunArn (string) --
Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn (string) --
ARN of the migration task associated with this premigration assessment run.
Status (string) --
Assessment run status.
This status can have one of the following values:
ReplicationTaskAssessmentRunCreationDate (datetime) --
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
AssessmentProgress (dict) --
Indication of the completion progress for the individual assessments specified to run.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
Last message generated by an individual assessment failure.
ServiceAccessRoleArn (string) --
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
ResultLocationBucket (string) --
Amazon S3 bucket where AWS DMS stores the results of this assessment run.
ResultLocationFolder (string) --
Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment run.
ResultEncryptionMode (string) --
Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn (string) --
ARN of the AWS KMS encryption key used to encrypt the assessment run results.
AssessmentRunName (string) --
Unique name of the assessment run.
Exceptions
Stops the replication task.
See also: AWS API Documentation
Request Syntax
response = client.stop_replication_task(
ReplicationTaskArn='string'
)
[REQUIRED]
The Amazon Resource Name(ARN) of the replication task to be stopped.
{
'ReplicationTask': {
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
}
}
Response Structure
The replication task stopped.
The user-assigned replication task identifier or name.
Constraints:
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
The ARN that uniquely identifies the endpoint.
The ARN of the replication instance.
The type of migration.
Table mappings specified in the task.
The settings for the replication task.
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
The last error (failure) message generated for the replication task.
The reason the replication task was stopped. This response parameter can return one of the following values:
The date the replication task was created.
The date the replication task is scheduled to start.
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”
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 “
Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
The Amazon Resource Name (ARN) of the replication task.
The statistics for the task, including elapsed time, tables loaded, and table errors.
The percent complete for the full load migration task.
The elapsed time of the task, in milliseconds.
The number of tables loaded for this task.
The number of tables currently loading for this task.
The number of tables queued for this task.
The number of errors that have occurred during this task.
The date the replication task was started either with a fresh start or a target reload.
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
The date the replication task was stopped.
The date the replication task full load was started.
The date the replication task full load was completed.
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 AWS Database Migration Service User Guide.
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
Exceptions
Examples
Stops the replication task.
response = client.stop_replication_task(
ReplicationTaskArn='arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
)
print(response)
Expected Output:
{
'ReplicationTask': {
'MigrationType': 'full-load',
'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
'ReplicationTaskArn': 'arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM',
'ReplicationTaskCreationDate': datetime(2016, 12, 14, 18, 25, 43, 2, 349, 0),
'ReplicationTaskIdentifier': 'task1',
'ReplicationTaskSettings': '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}',
'SourceEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
'Status': 'creating',
'TableMappings': 'file://mappingfile.json',
'TargetEndpointArn': 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
},
'ResponseMetadata': {
'...': '...',
},
}
Tests the connection between the replication instance and the endpoint.
See also: AWS API Documentation
Request Syntax
response = client.test_connection(
ReplicationInstanceArn='string',
EndpointArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
dict
Response Syntax
{
'Connection': {
'ReplicationInstanceArn': 'string',
'EndpointArn': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'EndpointIdentifier': 'string',
'ReplicationInstanceIdentifier': 'string'
}
}
Response Structure
(dict) --
Connection (dict) --
The connection tested.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
EndpointArn (string) --
The ARN string that uniquely identifies the endpoint.
Status (string) --
The connection status. This parameter can return one of the following values:
LastFailureMessage (string) --
The error message when the connection last failed.
EndpointIdentifier (string) --
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.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Exceptions
Examples
Tests the connection between the replication instance and the endpoint.
response = client.test_connection(
EndpointArn='arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
ReplicationInstanceArn='arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
)
print(response)
Expected Output:
{
'Connection': {
},
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
paginator = client.get_paginator('describe_certificates')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to the certificates described in the form of key-value pairs.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Certificates (list) --
The Secure Sockets Layer (SSL) certificates associated with the replication instance.
(dict) --
The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.
CertificateIdentifier (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.
CertificateCreationDate (datetime) --
The date that the certificate was created.
CertificatePem (string) --
The contents of a .pem file, which contains an X.509 certificate.
CertificateWallet (bytes) --
The location of an imported Oracle Wallet certificate for use with SSL.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
CertificateOwner (string) --
The owner of the certificate.
ValidFromDate (datetime) --
The beginning date that the certificate is valid.
ValidToDate (datetime) --
The final date that the certificate is valid.
SigningAlgorithm (string) --
The signing algorithm for the certificate.
KeyLength (integer) --
The key length of the cryptographic algorithm being used.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_connections')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_connections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Connections': [
{
'ReplicationInstanceArn': 'string',
'EndpointArn': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'EndpointIdentifier': 'string',
'ReplicationInstanceIdentifier': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Connections (list) --
A description of the connections.
(dict) --
Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
EndpointArn (string) --
The ARN string that uniquely identifies the endpoint.
Status (string) --
The connection status. This parameter can return one of the following values:
LastFailureMessage (string) --
The error message when the connection last failed.
EndpointIdentifier (string) --
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.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_endpoint_types')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_endpoint_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SupportedEndpointTypes': [
{
'EngineName': 'string',
'SupportsCDC': True|False,
'EndpointType': 'source'|'target',
'ReplicationInstanceEngineMinimumVersion': 'string',
'EngineDisplayName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SupportedEndpointTypes (list) --
The types of endpoints that are supported.
(dict) --
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.
EngineName (string) --
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
SupportsCDC (boolean) --
Indicates if Change Data Capture (CDC) is supported.
EndpointType (string) --
The type of endpoint. Valid values are source and target .
ReplicationInstanceEngineMinimumVersion (string) --
The earliest AWS DMS engine version that supports this endpoint engine. Note that endpoint engines released with AWS DMS versions earlier than 3.1.1 do not return a value for this parameter.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_endpoints')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Endpoints': [
{
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip',
'EncryptionMode': 'sse-s3'|'sse-kms',
'ServerSideEncryptionKmsKeyId': 'string',
'DataFormat': 'csv'|'parquet',
'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
'DictPageSizeLimit': 123,
'RowGroupLength': 123,
'DataPageSize': 123,
'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
'EnableStatistics': True|False,
'IncludeOpForFullLoad': True|False,
'CdcInsertsOnly': True|False,
'TimestampColumnName': 'string',
'ParquetTimestampInMillisecond': True|False,
'CdcInsertsAndUpdates': True|False,
'DatePartitionEnabled': True|False,
'DatePartitionSequence': 'YYYYMMDD'|'YYYYMMDDHH'|'YYYYMM'|'MMYYYYDD'|'DDMMYYYY',
'DatePartitionDelimiter': 'SLASH'|'UNDERSCORE'|'DASH'|'NONE',
'UseCsvNoSupValue': True|False,
'CsvNoSupValue': 'string',
'PreserveTransactions': True|False,
'CdcPath': 'string'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'KinesisSettings': {
'StreamArn': 'string',
'MessageFormat': 'json'|'json-unformatted',
'ServiceAccessRoleArn': 'string',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'IncludeNullAndEmpty': True|False
},
'KafkaSettings': {
'Broker': 'string',
'Topic': 'string',
'MessageFormat': 'json'|'json-unformatted',
'IncludeTransactionDetails': True|False,
'IncludePartitionValue': True|False,
'PartitionIncludeSchemaTable': True|False,
'IncludeTableAlterOperations': True|False,
'IncludeControlDetails': True|False,
'MessageMaxBytes': 123,
'IncludeNullAndEmpty': True|False,
'SecurityProtocol': 'plaintext'|'ssl-authentication'|'ssl-encryption'|'sasl-ssl',
'SslClientCertificateArn': 'string',
'SslClientKeyArn': 'string',
'SslClientKeyPassword': 'string',
'SslCaCertificateArn': 'string',
'SaslUsername': 'string',
'SaslPassword': 'string'
},
'ElasticsearchSettings': {
'ServiceAccessRoleArn': 'string',
'EndpointUri': 'string',
'FullLoadErrorPercentage': 123,
'ErrorRetryDuration': 123
},
'NeptuneSettings': {
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string',
'S3BucketFolder': 'string',
'ErrorRetryDuration': 123,
'MaxFileSize': 123,
'MaxRetryCount': 123,
'IamAuthEnabled': True|False
},
'RedshiftSettings': {
'AcceptAnyDate': True|False,
'AfterConnectScript': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CaseSensitiveNames': True|False,
'CompUpdate': True|False,
'ConnectionTimeout': 123,
'DatabaseName': 'string',
'DateFormat': 'string',
'EmptyAsNull': True|False,
'EncryptionMode': 'sse-s3'|'sse-kms',
'ExplicitIds': True|False,
'FileTransferUploadStreams': 123,
'LoadTimeout': 123,
'MaxFileSize': 123,
'Password': 'string',
'Port': 123,
'RemoveQuotes': True|False,
'ReplaceInvalidChars': 'string',
'ReplaceChars': 'string',
'ServerName': 'string',
'ServiceAccessRoleArn': 'string',
'ServerSideEncryptionKmsKeyId': 'string',
'TimeFormat': 'string',
'TrimBlanks': True|False,
'TruncateColumns': True|False,
'Username': 'string',
'WriteBufferSize': 123,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'PostgreSQLSettings': {
'AfterConnectScript': 'string',
'CaptureDdls': True|False,
'MaxFileSize': 123,
'DatabaseName': 'string',
'DdlArtifactsSchema': 'string',
'ExecuteTimeout': 123,
'FailTasksOnLobTruncation': True|False,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SlotName': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MySQLSettings': {
'AfterConnectScript': 'string',
'CleanSourceMetadataOnMismatch': True|False,
'DatabaseName': 'string',
'EventsPollInterval': 123,
'TargetDbType': 'specific-database'|'multiple-databases',
'MaxFileSize': 123,
'ParallelLoadThreads': 123,
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'ServerTimezone': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'OracleSettings': {
'AddSupplementalLogging': True|False,
'ArchivedLogDestId': 123,
'AdditionalArchivedLogDestId': 123,
'AllowSelectNestedTables': True|False,
'ParallelAsmReadThreads': 123,
'ReadAheadBlocks': 123,
'AccessAlternateDirectly': True|False,
'UseAlternateFolderForOnline': True|False,
'OraclePathPrefix': 'string',
'UsePathPrefix': 'string',
'ReplacePathPrefix': True|False,
'EnableHomogenousTablespace': True|False,
'DirectPathNoLog': True|False,
'ArchivedLogsOnly': True|False,
'AsmPassword': 'string',
'AsmServer': 'string',
'AsmUser': 'string',
'CharLengthSemantics': 'default'|'char'|'byte',
'DatabaseName': 'string',
'DirectPathParallelLoad': True|False,
'FailTasksOnLobTruncation': True|False,
'NumberDatatypeScale': 123,
'Password': 'string',
'Port': 123,
'ReadTableSpaceName': True|False,
'RetryInterval': 123,
'SecurityDbEncryption': 'string',
'SecurityDbEncryptionName': 'string',
'ServerName': 'string',
'SpatialDataOptionToGeoJsonFunctionName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerOracleAsmSecretId': 'string'
},
'SybaseSettings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'MicrosoftSQLServerSettings': {
'Port': 123,
'BcpPacketSize': 123,
'DatabaseName': 'string',
'ControlTablesFileGroup': 'string',
'Password': 'string',
'QuerySingleAlwaysOnNode': True|False,
'ReadBackupOnly': True|False,
'SafeguardPolicy': 'rely-on-sql-server-replication-agent'|'exclusive-automatic-truncation'|'shared-automatic-truncation',
'ServerName': 'string',
'Username': 'string',
'UseBcpFullLoad': True|False,
'UseThirdPartyBackupDevice': True|False,
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'IBMDb2Settings': {
'DatabaseName': 'string',
'Password': 'string',
'Port': 123,
'ServerName': 'string',
'SetDataCaptureChanges': True|False,
'CurrentLsn': 'string',
'MaxKBytesPerRead': 123,
'Username': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
},
'DocDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'NestingLevel': 'none'|'one',
'ExtractDocId': True|False,
'DocsToInvestigate': 123,
'KmsKeyId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'SecretsManagerSecretId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Endpoints (list) --
Endpoint description.
(dict) --
Describes an endpoint of a database instance in response to operations such as the following:
EndpointIdentifier (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.
EndpointType (string) --
The type of endpoint. Valid values are source and target .
EngineName (string) --
The database engine name. Valid values, depending on the EndpointType, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , and "neptune" .
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint. The default value is none .
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
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.
DynamoDbSettings (dict) --
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
ExternalTableDefinition (string) --
Specifies how tables are defined in the S3 source files only.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n ).
CsvDelimiter (string) --
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path `` bucketFolder /schema_name /table_name /`` . If this parameter isn't specified, then the path used is `` schema_name /table_name /`` .
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
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.
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
ServerSideEncryptionKmsKeyId (string) --
If you are using SSE_KMS for the EncryptionMode , provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: ``aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``
DataFormat (string) --
The format of the data that you want to use for output. You can choose one of the following:
EncodingType (string) --
The type of encoding you are using:
DictPageSizeLimit (integer) --
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.
RowGroupLength (integer) --
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).
DataPageSize (integer) --
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.
ParquetVersion (string) --
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0 .
EnableStatistics (boolean) --
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.
IncludeOpForFullLoad (boolean) --
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
Note
AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 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.
Note
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 AWS Database Migration Service User Guide. .
CdcInsertsOnly (boolean) --
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 AWS Database Migration Service User Guide. .
Note
AWS 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.
TimestampColumnName (string) --
A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
Note
AWS 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 .
ParquetTimestampInMillisecond (boolean) --
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
Note
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y , AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
Note
AWS 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.
CdcInsertsAndUpdates (boolean) --
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.
For .csv file format only, 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 AWS Database Migration Service User Guide. .
Note
AWS 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.
DatePartitionEnabled (boolean) --
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 partitoning, see Using date-based folder partitioning .
DatePartitionSequence (string) --
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 .
DatePartitionDelimiter (string) --
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH . Use this parameter when DatePartitionedEnabled is set to true .
UseCsvNoSupValue (boolean) --
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, AWS DMS uses the value specified by ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . If not set or set to false , AWS DMS uses the null value for these columns.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
CsvNoSupValue (string) --
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
Note
This setting is supported in AWS DMS versions 3.4.1 and later.
PreserveTransactions (boolean) --
If set to true , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . For more information, see Capturing data changes (CDC) including transaction order on the S3 target .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
CdcPath (string) --
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, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ to true , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ and ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__ .
For example, if you specify CdcPath as MyChangedData , and you specify BucketName as MyTargetBucket but do not specify BucketFolder , AWS 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 , AWS 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 .
Note
This setting is supported in AWS DMS versions 3.4.2 and later.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
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.
AuthMechanism (string) --
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" .
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (string) --
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 .
AuthSource (string) --
The MongoDB database name. This setting isn't used when AuthType is set to "no" .
The default is "admin" .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
KinesisSettings (dict) --
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
StreamArn (string) --
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat (string) --
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).
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
KafkaSettings (dict) --
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
Broker (string) --
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 `` broker-hostname-or-ip :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 AWS Database Migration Service in the AWS Data Migration Service User Guide .
Topic (string) --
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
MessageFormat (string) --
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).
IncludeTransactionDetails (boolean) --
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 .
IncludePartitionValue (boolean) --
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type . The default is false .
PartitionIncludeSchemaTable (boolean) --
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 .
IncludeTableAlterOperations (boolean) --
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 .
IncludeControlDetails (boolean) --
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .
MessageMaxBytes (integer) --
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
IncludeNullAndEmpty (boolean) --
Include NULL and empty columns for records migrated to the endpoint. The default is false .
SecurityProtocol (string) --
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 .
SslClientCertificateArn (string) --
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
SslClientKeyArn (string) --
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
SslClientKeyPassword (string) --
The password for the client private key used to securely connect to a Kafka target endpoint.
SslCaCertificateArn (string) --
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
SaslUsername (string) --
The secure username 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.
SaslPassword (string) --
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.
ElasticsearchSettings (dict) --
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by service to access the IAM role.
EndpointUri (string) --
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
FullLoadErrorPercentage (integer) --
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. Elasticsearch 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.
ErrorRetryDuration (integer) --
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
NeptuneSettings (dict) --
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
S3BucketName (string) --
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
S3BucketFolder (string) --
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
ErrorRetryDuration (integer) --
The number of milliseconds for AWS 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.
MaxFileSize (integer) --
The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
MaxRetryCount (integer) --
The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
IamAuthEnabled (boolean) --
If you want AWS 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 .
RedshiftSettings (dict) --
Settings for the Amazon Redshift endpoint.
AcceptAnyDate (boolean) --
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.
AfterConnectScript (string) --
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
BucketFolder (string) --
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
BucketName (string) --
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
CaseSensitiveNames (boolean) --
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true . The default is false .
CompUpdate (boolean) --
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 .
ConnectionTimeout (integer) --
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
DatabaseName (string) --
The name of the Amazon Redshift data warehouse (service) that you are working with.
DateFormat (string) --
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 .
EmptyAsNull (boolean) --
A value that specifies whether AWS 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 .
EncryptionMode (string) --
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 .
Note
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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
ExplicitIds (boolean) --
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 .
FileTransferUploadStreams (integer) --
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.
LoadTimeout (integer) --
The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
MaxFileSize (integer) --
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).
Password (string) --
The password for the user named in the username property.
Port (integer) --
The port number for Amazon Redshift. The default value is 5439.
RemoveQuotes (boolean) --
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 .
ReplaceInvalidChars (string) --
A list of characters that you want to replace. Use with ReplaceChars .
ReplaceChars (string) --
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead. The default is "?" .
ServerName (string) --
The name of the Amazon Redshift cluster you are using.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
ServerSideEncryptionKmsKeyId (string) --
The AWS 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.
TimeFormat (string) --
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 .
TrimBlanks (boolean) --
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 .
TruncateColumns (boolean) --
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 .
Username (string) --
An Amazon Redshift user name for a registered user.
WriteBufferSize (integer) --
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).
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
PostgreSQLSettings (dict) --
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
AfterConnectScript (string) --
For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
CaptureDdls (boolean) --
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N , you don't have to create tables or triggers on the source database.
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
DatabaseName (string) --
Database name for the endpoint.
DdlArtifactsSchema (string) --
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
ExecuteTimeout (integer) --
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
FailTasksOnLobTruncation (boolean) --
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 .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SlotName (string) --
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
MySQLSettings (dict) --
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
AfterConnectScript (string) --
Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
CleanSourceMetadataOnMismatch (boolean) --
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .
DatabaseName (string) --
Database name for the endpoint.
EventsPollInterval (integer) --
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
TargetDbType (string) --
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
MaxFileSize (integer) --
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
ParallelLoadThreads (integer) --
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.
Example: parallelLoadThreads=1
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
ServerTimezone (string) --
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
OracleSettings (dict) --
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
AddSupplementalLogging (boolean) --
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.
ArchivedLogDestId (integer) --
Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
AdditionalArchivedLogDestId (integer) --
Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS 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.
AllowSelectNestedTables (boolean) --
Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
ParallelAsmReadThreads (integer) --
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.
ReadAheadBlocks (integer) --
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).
AccessAlternateDirectly (boolean) --
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.
UseAlternateFolderForOnline (boolean) --
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.
OraclePathPrefix (string) --
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.
UsePathPrefix (string) --
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.
ReplacePathPrefix (boolean) --
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.
EnableHomogenousTablespace (boolean) --
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
DirectPathNoLog (boolean) --
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.
ArchivedLogsOnly (boolean) --
When this field is set to Y , AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
AsmPassword (string) --
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `` 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 .
AsmServer (string) --
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 .
AsmUser (string) --
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 .
CharLengthSemantics (string) --
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;
DatabaseName (string) --
Database name for the endpoint.
DirectPathParallelLoad (boolean) --
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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
FailTasksOnLobTruncation (boolean) --
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.
NumberDatatypeScale (integer) --
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
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ReadTableSpaceName (boolean) --
When set to true , this attribute supports tablespace replication.
RetryInterval (integer) --
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
SecurityDbEncryption (string) --
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 `` 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 AWS DMS in the AWS Database Migration Service User Guide .
SecurityDbEncryptionName (string) --
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 AWS DMS in the AWS Database Migration Service User Guide .
ServerName (string) --
Fully qualified domain name of the endpoint.
SpatialDataOptionToGeoJsonFunctionName (string) --
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.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
SecretsManagerOracleAsmAccessRoleArn (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies AWS 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.
Note
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 AsmUserName , 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerOracleAsmSecretId (string) --
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
SybaseSettings (dict) --
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
MicrosoftSQLServerSettings (dict) --
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
Port (integer) --
Endpoint TCP port.
BcpPacketSize (integer) --
The maximum size of the packets (in bytes) used to transfer data using BCP.
DatabaseName (string) --
Database name for the endpoint.
ControlTablesFileGroup (string) --
Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Password (string) --
Endpoint connection password.
QuerySingleAlwaysOnNode (boolean) --
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.
ReadBackupOnly (boolean) --
When this attribute is set to Y , AWS 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.
SafeguardPolicy (string) --
Use this attribute to minimize the need to access the backup log and enable AWS 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, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
ServerName (string) --
Fully qualified domain name of the endpoint.
Username (string) --
Endpoint connection user name.
UseBcpFullLoad (boolean) --
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.
UseThirdPartyBackupDevice (boolean) --
When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
IBMDb2Settings (dict) --
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
DatabaseName (string) --
Database name for the endpoint.
Password (string) --
Endpoint connection password.
Port (integer) --
Endpoint TCP port.
ServerName (string) --
Fully qualified domain name of the endpoint.
SetDataCaptureChanges (boolean) --
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
CurrentLsn (string) --
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
MaxKBytesPerRead (integer) --
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Username (string) --
Endpoint connection user name.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
DocDbSettings (dict) --
Provides information that defines a DocumentDB endpoint.
Username (string) --
The user name you use to access the DocumentDB source endpoint.
Password (string) --
The password for the user account you use to access the DocumentDB source endpoint.
ServerName (string) --
The name of the server on the DocumentDB source endpoint.
Port (integer) --
The port value for the DocumentDB source endpoint.
DatabaseName (string) --
The database name on the DocumentDB source endpoint.
NestingLevel (string) --
Specifies either document or table mode.
Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
ExtractDocId (boolean) --
Specifies the document ID. Use this setting when NestingLevel is set to "none" .
Default value is "false" .
DocsToInvestigate (integer) --
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 .
KmsKeyId (string) --
The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
SecretsManagerAccessRoleArn (string) --
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
Note
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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId (string) --
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_event_subscriptions')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_event_subscriptions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to event subscriptions.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventSubscriptionsList (list) --
A list of event subscriptions.
(dict) --
Describes an event notification subscription created by the CreateEventSubscription operation.
CustomerAwsId (string) --
The AWS customer account associated with the AWS DMS event notification subscription.
CustSubscriptionId (string) --
The AWS DMS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the AWS DMS event notification subscription.
Status (string) --
The status of the AWS 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 AWS 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.
SubscriptionCreationTime (string) --
The time the AWS DMS event notification subscription was created.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
SourceIdsList (list) --
A list of source Ids for the event subscription.
EventCategoriesList (list) --
A lists of event categories.
Enabled (boolean) --
Boolean value that indicates if the event subscription is enabled.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_events')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SourceIdentifier='string',
SourceType='replication-instance',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-task
A list of event categories for the source type that you've chosen.
Filters applied to events.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'replication-instance',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Events (list) --
The events described.
(dict) --
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 AWS DMS resource type.
SourceIdentifier (string) --
The identifier of an event source.
SourceType (string) --
The type of AWS DMS resource that generates events.
Valid values: replication-instance | endpoint | replication-task
Message (string) --
The event message.
EventCategories (list) --
The event categories available for the specified source type.
Date (datetime) --
The date of the event.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_orderable_replication_instances')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_orderable_replication_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'OrderableReplicationInstances': [
{
'EngineVersion': 'string',
'ReplicationInstanceClass': 'string',
'StorageType': 'string',
'MinAllocatedStorage': 123,
'MaxAllocatedStorage': 123,
'DefaultAllocatedStorage': 123,
'IncludedAllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'ReleaseStatus': 'beta'
},
],
'NextToken': 'string'
}
Response Structure
The order-able replication instances available.
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.
The version of the replication engine.
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 AWS DMS replication instance for your migration .
The type of storage used by the replication instance.
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
The default amount of storage (in gigabytes) that is allocated for the replication instance.
The amount of storage (in gigabytes) that is allocated for the replication instance.
List of Availability Zones for this replication instance.
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.
Note
AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
A token to resume pagination.
paginator = client.get_paginator('describe_replication_instances')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReplicationInstances': [
{
'ReplicationInstanceIdentifier': 'string',
'ReplicationInstanceClass': 'string',
'ReplicationInstanceStatus': 'string',
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'ReplicationInstanceClass': 'string',
'AllocatedStorage': 123,
'MultiAZ': True|False,
'EngineVersion': 'string'
},
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'KmsKeyId': 'string',
'ReplicationInstanceArn': 'string',
'ReplicationInstancePublicIpAddress': 'string',
'ReplicationInstancePrivateIpAddress': 'string',
'ReplicationInstancePublicIpAddresses': [
'string',
],
'ReplicationInstancePrivateIpAddresses': [
'string',
],
'PubliclyAccessible': True|False,
'SecondaryAvailabilityZone': 'string',
'FreeUntil': datetime(2015, 1, 1),
'DnsNameServers': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReplicationInstances (list) --
The replication instances described.
(dict) --
Provides information that defines a replication instance.
ReplicationInstanceIdentifier (string) --
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt 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 AWS DMS replication instance for your migration .
ReplicationInstanceStatus (string) --
The status of the replication instance. The possible return values include:
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
InstanceCreateTime (datetime) --
The time the replication instance was created.
VpcSecurityGroups (list) --
The VPC security group for the instance.
(dict) --
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
VpcSecurityGroupId (string) --
The VPC security group ID.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
The Availability Zone for the instance.
ReplicationSubnetGroup (dict) --
The subnet group for the replication instance.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
PreferredMaintenanceWindow (string) --
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
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 AWS DMS replication instance for your migration .
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
MultiAZ (boolean) --
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 .
EngineVersion (string) --
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true .
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
An AWS 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 AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
ReplicationInstanceArn (string) --
The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePublicIpAddress (string) --
The public IP address of the replication instance.
ReplicationInstancePrivateIpAddress (string) --
The private IP address of the replication instance.
ReplicationInstancePublicIpAddresses (list) --
One or more public IP addresses for the replication instance.
ReplicationInstancePrivateIpAddresses (list) --
One or more private IP addresses for the replication instance.
PubliclyAccessible (boolean) --
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 .
SecondaryAvailabilityZone (string) --
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil (datetime) --
The expiration date of the free replication instance that is part of the Free DMS program.
DnsNameServers (string) --
The DNS name servers supported for the replication instance to access your on-premise source or target database.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_replication_subnet_groups')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_subnet_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReplicationSubnetGroups': [
{
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReplicationSubnetGroups (list) --
A description of the replication subnet groups.
(dict) --
Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.
ReplicationSubnetGroupIdentifier (string) --
The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription (string) --
A description for the replication subnet group.
VpcId (string) --
The ID of the VPC.
SubnetGroupStatus (string) --
The status of the subnet group.
Subnets (list) --
The subnets that are in the subnet group.
(dict) --
In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SubnetIdentifier (string) --
The subnet identifier.
SubnetAvailabilityZone (dict) --
The Availability Zone of the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
The status of the subnet.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_replication_task_assessment_results')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_task_assessment_results().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReplicationTaskArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'BucketName': 'string',
'ReplicationTaskAssessmentResults': [
{
'ReplicationTaskIdentifier': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskLastAssessmentDate': datetime(2015, 1, 1),
'AssessmentStatus': 'string',
'AssessmentResultsFile': 'string',
'AssessmentResults': 'string',
'S3ObjectUrl': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BucketName (string) --
ReplicationTaskAssessmentResults (list) --
The task assessment report.
(dict) --
The task assessment report in JSON format.
ReplicationTaskIdentifier (string) --
The replication task identifier of the task on which the task assessment was run.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskLastAssessmentDate (datetime) --
The date the task assessment was completed.
AssessmentStatus (string) --
The status of the task assessment.
AssessmentResultsFile (string) --
The file containing the results of the task assessment.
AssessmentResults (string) --
The task assessment results in JSON format.
S3ObjectUrl (string) --
The URL of the S3 object containing the task assessment results.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_replication_tasks')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
WithoutSettings=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReplicationTasks': [
{
'ReplicationTaskIdentifier': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
'TableMappings': 'string',
'ReplicationTaskSettings': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'StopReason': 'string',
'ReplicationTaskCreationDate': datetime(2015, 1, 1),
'ReplicationTaskStartDate': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'TaskData': 'string',
'TargetReplicationInstanceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReplicationTasks (list) --
A description of the replication tasks.
(dict) --
Provides information that describes a replication task created by the CreateReplicationTask operation.
ReplicationTaskIdentifier (string) --
The user-assigned replication task identifier or name.
Constraints:
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The ARN of the replication instance.
MigrationType (string) --
The type of migration.
TableMappings (string) --
Table mappings specified in the task.
ReplicationTaskSettings (string) --
The settings for the replication task.
Status (string) --
The status of the replication task. This response parameter can return one of the following values:
Note
` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
LastFailureMessage (string) --
The last error (failure) message generated for the replication task.
StopReason (string) --
The reason the replication task was stopped. This response parameter can return one of the following values:
ReplicationTaskCreationDate (datetime) --
The date the replication task was created.
ReplicationTaskStartDate (datetime) --
The date the replication task is scheduled to start.
CdcStartPosition (string) --
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”
CdcStopPosition (string) --
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 “
RecoveryCheckpoint (string) --
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.
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats (dict) --
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent (integer) --
The percent complete for the full load migration task.
ElapsedTimeMillis (integer) --
The elapsed time of the task, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this task.
TablesLoading (integer) --
The number of tables currently loading for this task.
TablesQueued (integer) --
The number of tables queued for this task.
TablesErrored (integer) --
The number of errors that have occurred during this task.
FreshStartDate (datetime) --
The date the replication task was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .
StopDate (datetime) --
The date the replication task was stopped.
FullLoadStartDate (datetime) --
The date the replication task full load was started.
FullLoadFinishDate (datetime) --
The date the replication task full load was completed.
TaskData (string) --
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 AWS Database Migration Service User Guide.
TargetReplicationInstanceArn (string) --
The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_schemas')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_schemas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
EndpointArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Schemas': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Schemas (list) --
The described schema.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_table_statistics')
Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_table_statistics().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReplicationTaskArn='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
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.
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReplicationTaskArn': 'string',
'TableStatistics': [
{
'SchemaName': 'string',
'TableName': 'string',
'Inserts': 123,
'Deletes': 123,
'Updates': 123,
'Ddls': 123,
'FullLoadRows': 123,
'FullLoadCondtnlChkFailedRows': 123,
'FullLoadErrorRows': 123,
'FullLoadStartTime': datetime(2015, 1, 1),
'FullLoadEndTime': datetime(2015, 1, 1),
'FullLoadReloaded': True|False,
'LastUpdateTime': datetime(2015, 1, 1),
'TableState': 'string',
'ValidationPendingRecords': 123,
'ValidationFailedRecords': 123,
'ValidationSuspendedRecords': 123,
'ValidationState': 'string',
'ValidationStateDetails': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
TableStatistics (list) --
The table statistics.
(dict) --
Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.
SchemaName (string) --
The schema name.
TableName (string) --
The name of the table.
Inserts (integer) --
The number of insert actions performed on a table.
Deletes (integer) --
The number of delete actions performed on a table.
Updates (integer) --
The number of update actions performed on a table.
Ddls (integer) --
The data definition language (DDL) used to build and modify the structure of your tables.
FullLoadRows (integer) --
The number of rows added during the full load operation.
FullLoadCondtnlChkFailedRows (integer) --
The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadErrorRows (integer) --
The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadStartTime (datetime) --
The time when the full load operation started.
FullLoadEndTime (datetime) --
The time when the full load operation completed.
FullLoadReloaded (boolean) --
A value that indicates if the table was reloaded (true ) or loaded as part of a new full load operation (false ).
LastUpdateTime (datetime) --
The last time a table was updated.
TableState (string) --
The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
ValidationPendingRecords (integer) --
The number of records that have yet to be validated.
ValidationFailedRecords (integer) --
The number of records that failed validation.
ValidationSuspendedRecords (integer) --
The number of records that couldn't be validated.
ValidationState (string) --
The validation state of the table.
This parameter can have the following values:
ValidationStateDetails (string) --
Additional details about the state of validation.
NextToken (string) --
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('endpoint_deleted')
Polls DatabaseMigrationService.Client.describe_endpoints() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('replication_instance_available')
Polls DatabaseMigrationService.Client.describe_replication_instances() every 60 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 60
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('replication_instance_deleted')
Polls DatabaseMigrationService.Client.describe_replication_instances() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('replication_task_deleted')
Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WithoutSettings=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('replication_task_ready')
Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WithoutSettings=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('replication_task_running')
Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WithoutSettings=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('replication_task_stopped')
Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WithoutSettings=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('test_connection_succeeds')
Polls DatabaseMigrationService.Client.describe_connections() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
The name of the filter as specified for a Describe* or similar operation.
The filter value, which can specify one or more values used to narrow the returned results.
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 60
None