Table of Contents
DatabaseMigrationService.Client¶A low-level client representing AWS Database Migration Service:
client = session.create_client('dms')
These are the available methods:
add_tags_to_resource()can_paginate()create_endpoint()create_event_subscription()create_replication_instance()create_replication_subnet_group()create_replication_task()delete_certificate()delete_endpoint()delete_event_subscription()delete_replication_instance()delete_replication_subnet_group()delete_replication_task()describe_account_attributes()describe_certificates()describe_connections()describe_endpoint_types()describe_endpoints()describe_event_categories()describe_event_subscriptions()describe_events()describe_orderable_replication_instances()describe_refresh_schemas_status()describe_replication_instances()describe_replication_subnet_groups()describe_replication_tasks()describe_schemas()describe_table_statistics()generate_presigned_url()get_paginator()get_waiter()import_certificate()list_tags_for_resource()modify_endpoint()modify_event_subscription()modify_replication_instance()modify_replication_subnet_group()modify_replication_task()refresh_schemas()reload_tables()remove_tags_from_resource()start_replication_task()stop_replication_task()test_connection()Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
create_endpoint(**kwargs)¶Creates an endpoint using the provided settings.
See also: AWS API Documentation
Request Syntax
response = client.create_endpoint(
EndpointIdentifier='string',
EndpointType='source'|'target',
EngineName='string',
Username='string',
Password='string',
ServerName='string',
Port=123,
DatabaseName='string',
ExtraConnectionAttributes='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CertificateArn='string',
SslMode='none'|'require'|'verify-ca'|'verify-full',
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'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': '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',
'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'
}
}
}
Response Structure
|
create_event_subscription(**kwargs)¶Creates an AWS DMS event notification subscription.
You can specify the type of source (SourceType ) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds ) that triggers the events, and provide a list of event categories (EventCategories ) for events you want to be notified of. If you specify both the SourceType and SourceIds , such as SourceType = replication-instance and SourceIdentifier = my-replinstance , you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don’t specify a SourceIdentifier , you receive notice of the events for that source type for all your AWS DMS sources. If you don’t specify either SourceType nor SourceIdentifier , you will be notified of events generated from all AWS DMS sources belonging to your customer account.
For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database MIgration Service User Guide.
See also: AWS API Documentation
Request Syntax
response = client.create_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
SourceIds=[
'string',
],
Enabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
}
}
Response Structure
|
create_replication_instance(**kwargs)¶Creates the replication instance using the specified parameters.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_instance(
ReplicationInstanceIdentifier='string',
AllocatedStorage=123,
ReplicationInstanceClass='string',
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
ReplicationSubnetGroupIdentifier='string',
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
PubliclyAccessible=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
}
}
Response Structure
|
create_replication_subnet_group(**kwargs)¶Creates a replication subnet group given a list of the subnet IDs in a VPC.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string',
ReplicationSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
}
}
Response Structure
|
create_replication_task(**kwargs)¶Creates a replication task using the specified parameters.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_task(
ReplicationTaskIdentifier='string',
SourceEndpointArn='string',
TargetEndpointArn='string',
ReplicationInstanceArn='string',
MigrationType='full-load'|'cdc'|'full-load-and-cdc',
TableMappings='string',
ReplicationTaskSettings='string',
CdcStartTime=datetime(2015, 1, 1),
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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),
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123
}
}
}
Response Structure
|
delete_certificate(**kwargs)¶Deletes the specified certificate.
See also: AWS API Documentation
Request Syntax
response = client.delete_certificate(
CertificateArn='string'
)
| Parameters: | CertificateArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the deleted certificate. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Certificate': {
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
}
}
Response Structure
|
delete_endpoint(**kwargs)¶Deletes the specified endpoint.
Note
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
EndpointArn='string'
)
| Parameters: | EndpointArn (string) – [REQUIRED] The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': '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',
'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'
}
}
}
Response Structure
|
delete_event_subscription(**kwargs)¶Deletes an AWS DMS event subscription.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_subscription(
SubscriptionName='string'
)
| Parameters: | SubscriptionName (string) – [REQUIRED] The name of the DMS event notification subscription to be deleted. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
}
}
Response Structure
|
delete_replication_instance(**kwargs)¶Deletes the specified replication instance.
Note
You must delete any migration tasks that are associated with the replication instance before you can delete it.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_instance(
ReplicationInstanceArn='string'
)
| Parameters: | ReplicationInstanceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the replication instance to be deleted. |
|---|---|
| Return type: | dict |
| Returns: | 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'
}
}
Response Structure
|
delete_replication_subnet_group(**kwargs)¶Deletes a subnet group.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string'
)
| Parameters: | ReplicationSubnetGroupIdentifier (string) – [REQUIRED] The subnet group name of the replication instance. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
delete_replication_task(**kwargs)¶Deletes the specified replication task.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_task(
ReplicationTaskArn='string'
)
| Parameters: | ReplicationTaskArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the replication task to be deleted. |
|---|---|
| Return type: | dict |
| Returns: | 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),
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123
}
}
}
Response Structure
|
describe_account_attributes()¶Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota’s maximum value.
This command does not take any parameters.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_attributes()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'AccountQuotas': [
{
'AccountQuotaName': 'string',
'Used': 123,
'Max': 123
},
]
}
Response Structure
|
describe_certificates(**kwargs)¶Provides a description of the certificate.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificates(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
},
]
}
Response Structure
|
describe_connections(**kwargs)¶Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Connections': [
{
'ReplicationInstanceArn': 'string',
'EndpointArn': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'EndpointIdentifier': 'string',
'ReplicationInstanceIdentifier': 'string'
},
]
}
Response Structure
|
describe_endpoint_types(**kwargs)¶Returns information about the type of endpoints available.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoint_types(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'SupportedEndpointTypes': [
{
'EngineName': 'string',
'SupportsCDC': True|False,
'EndpointType': 'source'|'target'
},
]
}
Response Structure
|
describe_endpoints(**kwargs)¶Returns information about the endpoints for your account in the current region.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoints(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Endpoints': [
{
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': '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',
'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'
}
},
]
}
Response Structure
|
describe_event_categories(**kwargs)¶Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_categories(
SourceType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EventCategoryGroupList': [
{
'SourceType': 'string',
'EventCategories': [
'string',
]
},
]
}
Response Structure
|
describe_event_subscriptions(**kwargs)¶Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName , SNSTopicARN , CustomerID , SourceType , SourceID , CreationTime , and Status .
If you specify SubscriptionName , this action lists the description for that subscription.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_subscriptions(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
},
]
}
Response Structure
|
describe_events(**kwargs)¶Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications .
See also: AWS API Documentation
Request Syntax
response = client.describe_events(
SourceIdentifier='string',
SourceType='replication-instance',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'replication-instance',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
|
describe_orderable_replication_instances(**kwargs)¶Returns information about the replication instance types that can be created in the specified region.
See also: AWS API Documentation
Request Syntax
response = client.describe_orderable_replication_instances(
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'OrderableReplicationInstances': [
{
'EngineVersion': 'string',
'ReplicationInstanceClass': 'string',
'StorageType': 'string',
'MinAllocatedStorage': 123,
'MaxAllocatedStorage': 123,
'DefaultAllocatedStorage': 123,
'IncludedAllocatedStorage': 123
},
],
'Marker': 'string'
}
Response Structure
|
describe_refresh_schemas_status(**kwargs)¶Returns the status of the RefreshSchemas operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_refresh_schemas_status(
EndpointArn='string'
)
| Parameters: | EndpointArn (string) – [REQUIRED] The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'RefreshSchemasStatus': {
'EndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'Status': 'successful'|'failed'|'refreshing',
'LastRefreshDate': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
}
Response Structure
|
describe_replication_instances(**kwargs)¶Returns information about replication instances for your account in the current region.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
}
Response Structure
|
describe_replication_subnet_groups(**kwargs)¶Returns information about the replication subnet groups.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_subnet_groups(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'ReplicationSubnetGroups': [
{
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
},
]
}
Response Structure
|
describe_replication_tasks(**kwargs)¶Returns information about replication tasks for your account in the current region.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_tasks(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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),
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123
}
},
]
}
Response Structure
|
describe_schemas(**kwargs)¶Returns information about the schema for the specified endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_schemas(
EndpointArn='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Schemas': [
'string',
]
}
Response Structure
|
describe_table_statistics(**kwargs)¶Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
See also: AWS API Documentation
Request Syntax
response = client.describe_table_statistics(
ReplicationTaskArn='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationTaskArn': 'string',
'TableStatistics': [
{
'SchemaName': 'string',
'TableName': 'string',
'Inserts': 123,
'Deletes': 123,
'Updates': 123,
'Ddls': 123,
'FullLoadRows': 123,
'FullLoadCondtnlChkFailedRows': 123,
'FullLoadErrorRows': 123,
'LastUpdateTime': datetime(2015, 1, 1),
'TableState': 'string'
},
],
'Marker': 'string'
}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_waiter(waiter_name)¶import_certificate(**kwargs)¶Uploads the specified certificate.
See also: AWS API Documentation
Request Syntax
response = client.import_certificate(
CertificateIdentifier='string',
CertificatePem='string',
CertificateWallet=b'bytes',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Certificate': {
'CertificateIdentifier': 'string',
'CertificateCreationDate': datetime(2015, 1, 1),
'CertificatePem': 'string',
'CertificateWallet': b'bytes',
'CertificateArn': 'string',
'CertificateOwner': 'string',
'ValidFromDate': datetime(2015, 1, 1),
'ValidToDate': datetime(2015, 1, 1),
'SigningAlgorithm': 'string',
'KeyLength': 123
}
}
Response Structure
|
Lists all tags for an AWS DMS resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
| Parameters: | ResourceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
modify_endpoint(**kwargs)¶Modifies the specified endpoint.
See also: AWS API Documentation
Request Syntax
response = client.modify_endpoint(
EndpointArn='string',
EndpointIdentifier='string',
EndpointType='source'|'target',
EngineName='string',
Username='string',
Password='string',
ServerName='string',
Port=123,
DatabaseName='string',
ExtraConnectionAttributes='string',
CertificateArn='string',
SslMode='none'|'require'|'verify-ca'|'verify-full',
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'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': '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',
'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'
}
}
}
Response Structure
|
modify_event_subscription(**kwargs)¶Modifies an existing AWS DMS event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.modify_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
Enabled=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False
}
}
Response Structure
|
modify_replication_instance(**kwargs)¶Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
See also: AWS API Documentation
Request Syntax
response = client.modify_replication_instance(
ReplicationInstanceArn='string',
AllocatedStorage=123,
ApplyImmediately=True|False,
ReplicationInstanceClass='string',
VpcSecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
AutoMinorVersionUpgrade=True|False,
ReplicationInstanceIdentifier='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
}
}
Response Structure
|
modify_replication_subnet_group(**kwargs)¶Modifies the settings for the specified replication subnet group.
See also: AWS API Documentation
Request Syntax
response = client.modify_replication_subnet_group(
ReplicationSubnetGroupIdentifier='string',
ReplicationSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationSubnetGroup': {
'ReplicationSubnetGroupIdentifier': 'string',
'ReplicationSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
]
}
}
Response Structure
|
modify_replication_task(**kwargs)¶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
response = client.modify_replication_task(
ReplicationTaskArn='string',
ReplicationTaskIdentifier='string',
MigrationType='full-load'|'cdc'|'full-load-and-cdc',
TableMappings='string',
ReplicationTaskSettings='string',
CdcStartTime=datetime(2015, 1, 1)
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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),
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123
}
}
}
Response Structure
|
refresh_schemas(**kwargs)¶Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
See also: AWS API Documentation
Request Syntax
response = client.refresh_schemas(
EndpointArn='string',
ReplicationInstanceArn='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'RefreshSchemasStatus': {
'EndpointArn': 'string',
'ReplicationInstanceArn': 'string',
'Status': 'successful'|'failed'|'refreshing',
'LastRefreshDate': datetime(2015, 1, 1),
'LastFailureMessage': 'string'
}
}
Response Structure
|
reload_tables(**kwargs)¶Reloads the target database table with the source data.
See also: AWS API Documentation
Request Syntax
response = client.reload_tables(
ReplicationTaskArn='string',
TablesToReload=[
{
'SchemaName': 'string',
'TableName': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationTaskArn': 'string'
}
Response Structure
|
Removes metadata tags from a DMS resource.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
start_replication_task(**kwargs)¶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
response = client.start_replication_task(
ReplicationTaskArn='string',
StartReplicationTaskType='start-replication'|'resume-processing'|'reload-target',
CdcStartTime=datetime(2015, 1, 1)
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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),
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123
}
}
}
Response Structure
|
stop_replication_task(**kwargs)¶Stops the replication task.
See also: AWS API Documentation
Request Syntax
response = client.stop_replication_task(
ReplicationTaskArn='string'
)
| Parameters: | ReplicationTaskArn (string) – [REQUIRED] The Amazon Resource Number(ARN) of the replication task to be stopped. |
|---|---|
| Return type: | dict |
| Returns: | 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),
'ReplicationTaskArn': 'string',
'ReplicationTaskStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123
}
}
}
Response Structure
|
test_connection(**kwargs)¶Tests the connection between the replication instance and the endpoint.
See also: AWS API Documentation
Request Syntax
response = client.test_connection(
ReplicationInstanceArn='string',
EndpointArn='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Connection': {
'ReplicationInstanceArn': 'string',
'EndpointArn': 'string',
'Status': 'string',
'LastFailureMessage': 'string',
'EndpointIdentifier': 'string',
'ReplicationInstanceIdentifier': 'string'
}
}
Response Structure
|
The available paginators are: