2018/04/10 - AWS Database Migration Service - 17 updated api methods
Changes Native Change Data Capture start point and task recovery support in Database Migration Service.
{'ExternalTableDefinition': 'string',
'MongoDbSettings': {'KmsKeyId': 'string'},
'ServiceAccessRoleArn': 'string'}
Response {'Endpoint': {'EngineDisplayName': 'string',
'ExternalTableDefinition': 'string',
'MongoDbSettings': {'KmsKeyId': 'string'},
'ServiceAccessRoleArn': 'string'}}
Creates an endpoint using the provided settings.
See also: AWS API Documentation
Request Syntax
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'
},
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'
}
)
string
[REQUIRED]
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
string
[REQUIRED]
The type of endpoint.
string
[REQUIRED]
The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
string
The user name to be used to login to the endpoint database.
string
The password to be used to login to the endpoint database.
string
The name of the server where the endpoint database resides.
integer
The port used by the endpoint database.
string
The name of the endpoint database.
string
Additional attributes associated with the connection.
string
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
list
Tags to be added to the endpoint.
(dict) --
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
string
The Amazon Resource Name (ARN) for the certificate.
string
The SSL mode to use for the SSL connection.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
string
The Amazon Resource Name (ARN) for the service access role you want to use to create the endpoint.
string
The external table definition.
dict
Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service .
ServiceAccessRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) used by the service access IAM role.
dict
Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service .
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed.
dict
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service .
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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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
{
'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'
},
'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'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint that was created.
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
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, sybase, dynamodb, mongodb, and sqlserver.
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) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
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 target DynamoDB database. 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.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed.
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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
{'ReplicationInstance': {'FreeUntil': 'timestamp'}}
Creates the replication instance using the specified parameters.
See also: AWS API Documentation
Request Syntax
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
)
string
[REQUIRED]
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
integer
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
string
[REQUIRED]
The compute and memory capacity of the replication instance as specified by the replication instance class.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
list
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.
(string) --
string
The EC2 Availability Zone that the replication instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
string
A subnet group to associate with the replication instance.
string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
boolean
Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
string
The engine version number of the replication instance.
boolean
Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
Default: true
list
Tags to be associated with the replication instance.
(dict) --
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
string
The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
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 .
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)
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that was created.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceStatus (string) --
The status of the replication instance.
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) --
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) --
The description of 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) --
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.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies if the replication instance is a Multi-AZ deployment. You cannot 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 if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
EngineVersion (string) --
The engine version number of the replication instance.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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) --
The public IP address of the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
The private IP address of the replication instance.
(string) --
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.
{'CdcStartPosition': 'string', 'CdcStopPosition': 'string'}
Response {'ReplicationTask': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
Creates a replication task using the specified parameters.
See also: AWS API Documentation
Request Syntax
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'
},
]
)
string
[REQUIRED]
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
string
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
string
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
string
[REQUIRED]
The migration type.
string
[REQUIRED]
When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file://". When working with the DMS API, provide the JSON as the parameter value.
For example, --table-mappings file://mappingfile.json
string
Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks .
datetime
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.
string
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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
list
Tags to be added to the replication instance.
(dict) --
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\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
}
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task that was created.
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.
{'Endpoint': {'EngineDisplayName': 'string',
'ExternalTableDefinition': 'string',
'MongoDbSettings': {'KmsKeyId': 'string'},
'ServiceAccessRoleArn': 'string'}}
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
client.delete_endpoint(
EndpointArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
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'
},
'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'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint that was deleted.
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
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, sybase, dynamodb, mongodb, and sqlserver.
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) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
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 target DynamoDB database. 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.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed.
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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
{'ReplicationInstance': {'FreeUntil': 'timestamp'}}
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
client.delete_replication_instance(
ReplicationInstanceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance to be deleted.
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)
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that was deleted.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceStatus (string) --
The status of the replication instance.
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) --
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) --
The description of 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) --
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.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies if the replication instance is a Multi-AZ deployment. You cannot 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 if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
EngineVersion (string) --
The engine version number of the replication instance.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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) --
The public IP address of the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
The private IP address of the replication instance.
(string) --
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.
{'ReplicationTask': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
Deletes the specified replication task.
See also: AWS API Documentation
Request Syntax
client.delete_replication_task(
ReplicationTaskArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task to be deleted.
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
}
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The deleted replication task.
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.
{'SupportedEndpointTypes': {'EngineDisplayName': 'string'}}
Returns information about the type of endpoints available.
See also: AWS API Documentation
Request Syntax
client.describe_endpoint_types(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the describe action.
Valid filter names: engine-name | endpoint-type
(dict) --
Name (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
The filter value.
(string) --
integer
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.
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 .
dict
Response Syntax
{
'Marker': 'string',
'SupportedEndpointTypes': [
{
'EngineName': 'string',
'SupportsCDC': True|False,
'EndpointType': 'source'|'target',
'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 type of endpoints that are supported.
(dict) --
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, sybase, dynamodb, mongodb, and sqlserver.
SupportsCDC (boolean) --
Indicates if Change Data Capture (CDC) is supported.
EndpointType (string) --
The type of endpoint.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
{'Endpoints': {'EngineDisplayName': 'string',
'ExternalTableDefinition': 'string',
'MongoDbSettings': {'KmsKeyId': 'string'},
'ServiceAccessRoleArn': 'string'}}
Returns information about the endpoints for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_endpoints(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the describe action.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
(dict) --
Name (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
The filter value.
(string) --
integer
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.
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 .
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'
},
'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'
}
},
]
}
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) --
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
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, sybase, dynamodb, mongodb, and sqlserver.
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) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
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 target DynamoDB database. 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.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed.
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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
{'ReplicationInstances': {'FreeUntil': 'timestamp'}}
Returns information about replication instances for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_replication_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the describe action.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
(dict) --
Name (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
The filter value.
(string) --
integer
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.
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 .
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)
},
]
}
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) --
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceStatus (string) --
The status of the replication instance.
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) --
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) --
The description of 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) --
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.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies if the replication instance is a Multi-AZ deployment. You cannot 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 if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
EngineVersion (string) --
The engine version number of the replication instance.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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) --
The public IP address of the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
The private IP address of the replication instance.
(string) --
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.
{'ReplicationTasks': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
Returns information about replication tasks for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_replication_tasks(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the describe action.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
(dict) --
Name (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
The filter value.
(string) --
integer
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.
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 .
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
}
},
]
}
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) --
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.
{'ExternalTableDefinition': 'string',
'MongoDbSettings': {'KmsKeyId': 'string'},
'ServiceAccessRoleArn': 'string'}
Response {'Endpoint': {'EngineDisplayName': 'string',
'ExternalTableDefinition': 'string',
'MongoDbSettings': {'KmsKeyId': 'string'},
'ServiceAccessRoleArn': 'string'}}
Modifies the specified endpoint.
See also: AWS API Documentation
Request Syntax
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'
},
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'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
string
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
string
The type of endpoint.
string
The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
string
The user name to be used to login to the endpoint database.
string
The password to be used to login to the endpoint database.
string
The name of the server where the endpoint database resides.
integer
The port used by the endpoint database.
string
The name of the endpoint database.
string
Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
string
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
string
The SSL mode to be used.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
string
The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
string
The external table definition.
dict
Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service .
ServiceAccessRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) used by the service access IAM role.
dict
Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service .
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed.
dict
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service .
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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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
{
'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'
},
'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'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The modified endpoint.
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
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, sybase, dynamodb, mongodb, and sqlserver.
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) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
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 target DynamoDB database. 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.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed.
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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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.
{'ReplicationInstance': {'FreeUntil': 'timestamp'}}
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
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'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
integer
The amount of storage (in gigabytes) to be allocated for the replication instance.
boolean
Indicates whether the changes should be applied immediately or during the next maintenance window.
string
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
list
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.
(string) --
string
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
boolean
Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
string
The engine version number of the replication instance.
boolean
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.
Constraints: 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.
boolean
Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.
string
The replication instance identifier. This parameter is stored as a lowercase string.
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)
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The modified replication instance.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceStatus (string) --
The status of the replication instance.
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) --
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) --
The description of 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) --
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.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies if the replication instance is a Multi-AZ deployment. You cannot 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 if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
EngineVersion (string) --
The engine version number of the replication instance.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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) --
The public IP address of the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
The private IP address of the replication instance.
(string) --
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.
{'CdcStartPosition': 'string', 'CdcStopPosition': 'string'}
Response {'ReplicationTask': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
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 the AWS DMS user guide at Working with Migration Tasks
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
string
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
string
The migration type.
Valid values: full-load | cdc | full-load-and-cdc
string
When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file://". When working with the DMS API, provide the JSON as the parameter value.
For example, --table-mappings file://mappingfile.json
string
JSON file that contains settings for the task, such as target metadata settings.
datetime
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.
string
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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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
}
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task that was modified.
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.
{'ReplicationInstance': {'FreeUntil': 'timestamp'}}
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
See also: AWS API Documentation
Request Syntax
client.reboot_replication_instance(
ReplicationInstanceArn='string',
ForceFailover=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication instance.
boolean
If this parameter is true , the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify true .)
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)
}
}
Response Structure
(dict) --
ReplicationInstance (dict) --
The replication instance that is being rebooted.
ReplicationInstanceIdentifier (string) --
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceStatus (string) --
The status of the replication instance.
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) --
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) --
The description of 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) --
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.
PendingModifiedValues (dict) --
The pending modification values.
ReplicationInstanceClass (string) --
The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
AllocatedStorage (integer) --
The amount of storage (in gigabytes) that is allocated for the replication instance.
MultiAZ (boolean) --
Specifies if the replication instance is a Multi-AZ deployment. You cannot 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 if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
EngineVersion (string) --
The engine version number of the replication instance.
AutoMinorVersionUpgrade (boolean) --
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
KmsKeyId (string) --
The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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) --
The public IP address of the replication instance.
(string) --
ReplicationInstancePrivateIpAddresses (list) --
The private IP address of the replication instance.
(string) --
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.
{'CdcStartPosition': 'string', 'CdcStopPosition': 'string'}
Response {'ReplicationTask': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
Starts the replication task.
For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks
See also: AWS API Documentation
Request Syntax
client.start_replication_task(
ReplicationTaskArn='string',
StartReplicationTaskType='start-replication'|'resume-processing'|'reload-target',
CdcStartTime=datetime(2015, 1, 1),
CdcStartPosition='string',
CdcStopPosition='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task to be started.
string
[REQUIRED]
The type of replication task.
datetime
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.
string
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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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
}
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task started.
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.
{'ReplicationTask': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
Starts the replication task assessment for unsupported data types in the source database.
See also: AWS API Documentation
Request Syntax
client.start_replication_task_assessment(
ReplicationTaskArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
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
}
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The assessed replication task.
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.
{'ReplicationTask': {'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string'}}
Stops the replication task.
See also: AWS API Documentation
Request Syntax
client.stop_replication_task(
ReplicationTaskArn='string'
)
string
[REQUIRED]
The Amazon Resource Name(ARN) of the replication task to be stopped.
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
}
}
}
Response Structure
(dict) --
ReplicationTask (dict) --
The replication task stopped.
ReplicationTaskIdentifier (string) --
The replication task identifier.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SourceEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
TargetEndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn (string) --
The Amazon Resource Name (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.
LastFailureMessage (string) --
The last error (failure) message generated for the replication instance.
StopReason (string) --
The reason the replication task was stopped.
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 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”
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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.