DatabaseMigrationServiceClient#
Index > DatabaseMigrationService > DatabaseMigrationServiceClient
Auto-generated documentation for DatabaseMigrationService type annotations stubs module mypy-boto3-dms.
DatabaseMigrationServiceClient#
Type annotations and code completion for boto3.client("dms")
.
boto3 documentation
# DatabaseMigrationServiceClient usage example
from boto3.session import Session
from mypy_boto3_dms.client import DatabaseMigrationServiceClient
def get_dms_client() -> DatabaseMigrationServiceClient:
return Session().client("dms")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("dms").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("dms")
try:
do_something(client)
except (
client.exceptions.AccessDeniedFault,
client.exceptions.ClientError,
client.exceptions.CollectorNotFoundFault,
client.exceptions.InsufficientResourceCapacityFault,
client.exceptions.InvalidCertificateFault,
client.exceptions.InvalidOperationFault,
client.exceptions.InvalidResourceStateFault,
client.exceptions.InvalidSubnet,
client.exceptions.KMSAccessDeniedFault,
client.exceptions.KMSDisabledFault,
client.exceptions.KMSFault,
client.exceptions.KMSInvalidStateFault,
client.exceptions.KMSKeyNotAccessibleFault,
client.exceptions.KMSNotFoundFault,
client.exceptions.KMSThrottlingFault,
client.exceptions.ReplicationSubnetGroupDoesNotCoverEnoughAZs,
client.exceptions.ResourceAlreadyExistsFault,
client.exceptions.ResourceNotFoundFault,
client.exceptions.ResourceQuotaExceededFault,
client.exceptions.S3AccessDeniedFault,
client.exceptions.S3ResourceNotFoundFault,
client.exceptions.SNSInvalidTopicFault,
client.exceptions.SNSNoAuthorizationFault,
client.exceptions.StorageQuotaExceededFault,
client.exceptions.SubnetAlreadyInUse,
client.exceptions.UpgradeDependencyFailureFault,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_dms.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedFault) -> None:
...
Methods#
add_tags_to_resource#
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration task.
Type annotations and code completion for boto3.client("dms").add_tags_to_resource
method.
boto3 documentation
# add_tags_to_resource method definition
def add_tags_to_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# add_tags_to_resource method usage example with argument unpacking
kwargs: AddTagsToResourceMessageRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
apply_pending_maintenance_action#
Applies a pending maintenance action to a resource (for example, to a replication instance).
Type annotations and code completion for boto3.client("dms").apply_pending_maintenance_action
method.
boto3 documentation
# apply_pending_maintenance_action method definition
def apply_pending_maintenance_action(
self,
*,
ReplicationInstanceArn: str,
ApplyAction: str,
OptInType: str,
) -> ApplyPendingMaintenanceActionResponseTypeDef: # (1)
...
# apply_pending_maintenance_action method usage example with argument unpacking
kwargs: ApplyPendingMaintenanceActionMessageRequestTypeDef = { # (1)
"ReplicationInstanceArn": ...,
"ApplyAction": ...,
"OptInType": ...,
}
parent.apply_pending_maintenance_action(**kwargs)
batch_start_recommendations#
Starts the analysis of up to 20 source databases to recommend target engines for each source database.
Type annotations and code completion for boto3.client("dms").batch_start_recommendations
method.
boto3 documentation
# batch_start_recommendations method definition
def batch_start_recommendations(
self,
*,
Data: Sequence[StartRecommendationsRequestEntryTypeDef] = ..., # (1)
) -> BatchStartRecommendationsResponseTypeDef: # (2)
...
# batch_start_recommendations method usage example with argument unpacking
kwargs: BatchStartRecommendationsRequestRequestTypeDef = { # (1)
"Data": ...,
}
parent.batch_start_recommendations(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("dms").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_replication_task_assessment_run#
Cancels a single premigration assessment run.
Type annotations and code completion for boto3.client("dms").cancel_replication_task_assessment_run
method.
boto3 documentation
# cancel_replication_task_assessment_run method definition
def cancel_replication_task_assessment_run(
self,
*,
ReplicationTaskAssessmentRunArn: str,
) -> CancelReplicationTaskAssessmentRunResponseTypeDef: # (1)
...
# cancel_replication_task_assessment_run method usage example with argument unpacking
kwargs: CancelReplicationTaskAssessmentRunMessageRequestTypeDef = { # (1)
"ReplicationTaskAssessmentRunArn": ...,
}
parent.cancel_replication_task_assessment_run(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("dms").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_data_provider#
Creates a data provider using the provided settings.
Type annotations and code completion for boto3.client("dms").create_data_provider
method.
boto3 documentation
# create_data_provider method definition
def create_data_provider(
self,
*,
Engine: str,
Settings: DataProviderSettingsTypeDef, # (1)
DataProviderName: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDataProviderResponseTypeDef: # (3)
...
# create_data_provider method usage example with argument unpacking
kwargs: CreateDataProviderMessageRequestTypeDef = { # (1)
"Engine": ...,
"Settings": ...,
}
parent.create_data_provider(**kwargs)
create_endpoint#
Creates an endpoint using the provided settings.
Type annotations and code completion for boto3.client("dms").create_endpoint
method.
boto3 documentation
# create_endpoint method definition
def create_endpoint(
self,
*,
EndpointIdentifier: str,
EndpointType: ReplicationEndpointTypeValueType, # (1)
EngineName: str,
Username: str = ...,
Password: str = ...,
ServerName: str = ...,
Port: int = ...,
DatabaseName: str = ...,
ExtraConnectionAttributes: str = ...,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
CertificateArn: str = ...,
SslMode: DmsSslModeValueType = ..., # (3)
ServiceAccessRoleArn: str = ...,
ExternalTableDefinition: str = ...,
DynamoDbSettings: DynamoDbSettingsTypeDef = ..., # (4)
S3Settings: S3SettingsTypeDef = ..., # (5)
DmsTransferSettings: DmsTransferSettingsTypeDef = ..., # (6)
MongoDbSettings: MongoDbSettingsTypeDef = ..., # (7)
KinesisSettings: KinesisSettingsTypeDef = ..., # (8)
KafkaSettings: KafkaSettingsTypeDef = ..., # (9)
ElasticsearchSettings: ElasticsearchSettingsTypeDef = ..., # (10)
NeptuneSettings: NeptuneSettingsTypeDef = ..., # (11)
RedshiftSettings: RedshiftSettingsTypeDef = ..., # (12)
PostgreSQLSettings: PostgreSQLSettingsTypeDef = ..., # (13)
MySQLSettings: MySQLSettingsTypeDef = ..., # (14)
OracleSettings: OracleSettingsTypeDef = ..., # (15)
SybaseSettings: SybaseSettingsTypeDef = ..., # (16)
MicrosoftSQLServerSettings: MicrosoftSQLServerSettingsTypeDef = ..., # (17)
IBMDb2Settings: IBMDb2SettingsTypeDef = ..., # (18)
ResourceIdentifier: str = ...,
DocDbSettings: DocDbSettingsTypeDef = ..., # (19)
RedisSettings: RedisSettingsTypeDef = ..., # (20)
GcpMySQLSettings: GcpMySQLSettingsTypeDef = ..., # (21)
TimestreamSettings: TimestreamSettingsTypeDef = ..., # (22)
) -> CreateEndpointResponseTypeDef: # (23)
...
- See ReplicationEndpointTypeValueType
- See TagTypeDef
- See DmsSslModeValueType
- See DynamoDbSettingsTypeDef
- See S3SettingsTypeDef
- See DmsTransferSettingsTypeDef
- See MongoDbSettingsTypeDef
- See KinesisSettingsTypeDef
- See KafkaSettingsTypeDef
- See ElasticsearchSettingsTypeDef
- See NeptuneSettingsTypeDef
- See RedshiftSettingsTypeDef
- See PostgreSQLSettingsTypeDef
- See MySQLSettingsTypeDef
- See OracleSettingsTypeDef
- See SybaseSettingsTypeDef
- See MicrosoftSQLServerSettingsTypeDef
- See IBMDb2SettingsTypeDef
- See DocDbSettingsTypeDef
- See RedisSettingsTypeDef
- See GcpMySQLSettingsTypeDef
- See TimestreamSettingsTypeDef
- See CreateEndpointResponseTypeDef
# create_endpoint method usage example with argument unpacking
kwargs: CreateEndpointMessageRequestTypeDef = { # (1)
"EndpointIdentifier": ...,
"EndpointType": ...,
"EngineName": ...,
}
parent.create_endpoint(**kwargs)
create_event_subscription#
Creates an DMS event notification subscription.
Type annotations and code completion for boto3.client("dms").create_event_subscription
method.
boto3 documentation
# create_event_subscription method definition
def create_event_subscription(
self,
*,
SubscriptionName: str,
SnsTopicArn: str,
SourceType: str = ...,
EventCategories: Sequence[str] = ...,
SourceIds: Sequence[str] = ...,
Enabled: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateEventSubscriptionResponseTypeDef: # (2)
...
# create_event_subscription method usage example with argument unpacking
kwargs: CreateEventSubscriptionMessageRequestTypeDef = { # (1)
"SubscriptionName": ...,
"SnsTopicArn": ...,
}
parent.create_event_subscription(**kwargs)
create_fleet_advisor_collector#
Creates a Fleet Advisor collector using the specified parameters.
Type annotations and code completion for boto3.client("dms").create_fleet_advisor_collector
method.
boto3 documentation
# create_fleet_advisor_collector method definition
def create_fleet_advisor_collector(
self,
*,
CollectorName: str,
ServiceAccessRoleArn: str,
S3BucketName: str,
Description: str = ...,
) -> CreateFleetAdvisorCollectorResponseTypeDef: # (1)
...
# create_fleet_advisor_collector method usage example with argument unpacking
kwargs: CreateFleetAdvisorCollectorRequestRequestTypeDef = { # (1)
"CollectorName": ...,
"ServiceAccessRoleArn": ...,
"S3BucketName": ...,
}
parent.create_fleet_advisor_collector(**kwargs)
create_instance_profile#
Creates the instance profile using the specified parameters.
Type annotations and code completion for boto3.client("dms").create_instance_profile
method.
boto3 documentation
# create_instance_profile method definition
def create_instance_profile(
self,
*,
AvailabilityZone: str = ...,
KmsKeyArn: str = ...,
PubliclyAccessible: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
NetworkType: str = ...,
InstanceProfileName: str = ...,
Description: str = ...,
SubnetGroupIdentifier: str = ...,
VpcSecurityGroups: Sequence[str] = ...,
) -> CreateInstanceProfileResponseTypeDef: # (2)
...
# create_instance_profile method usage example with argument unpacking
kwargs: CreateInstanceProfileMessageRequestTypeDef = { # (1)
"AvailabilityZone": ...,
}
parent.create_instance_profile(**kwargs)