Skip to content

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]:
    ...
  1. See TagTypeDef 
# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceMessageRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceMessageRequestTypeDef

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)
    ...
  1. See ApplyPendingMaintenanceActionResponseTypeDef 
# apply_pending_maintenance_action method usage example with argument unpacking

kwargs: ApplyPendingMaintenanceActionMessageRequestTypeDef = {  # (1)
    "ReplicationInstanceArn": ...,
    "ApplyAction": ...,
    "OptInType": ...,
}

parent.apply_pending_maintenance_action(**kwargs)
  1. See ApplyPendingMaintenanceActionMessageRequestTypeDef

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)
    ...
  1. See StartRecommendationsRequestEntryTypeDef
  2. See BatchStartRecommendationsResponseTypeDef 
# batch_start_recommendations method usage example with argument unpacking

kwargs: BatchStartRecommendationsRequestRequestTypeDef = {  # (1)
    "Data": ...,
}

parent.batch_start_recommendations(**kwargs)
  1. See BatchStartRecommendationsRequestRequestTypeDef

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)
    ...
  1. See CancelReplicationTaskAssessmentRunResponseTypeDef 
# cancel_replication_task_assessment_run method usage example with argument unpacking

kwargs: CancelReplicationTaskAssessmentRunMessageRequestTypeDef = {  # (1)
    "ReplicationTaskAssessmentRunArn": ...,
}

parent.cancel_replication_task_assessment_run(**kwargs)
  1. See CancelReplicationTaskAssessmentRunMessageRequestTypeDef

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_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)
) -> CreateEndpointResponseTypeDef:  # (22)
    ...
  1. See ReplicationEndpointTypeValueType
  2. See TagTypeDef
  3. See DmsSslModeValueType
  4. See DynamoDbSettingsTypeDef
  5. See S3SettingsTypeDef
  6. See DmsTransferSettingsTypeDef
  7. See MongoDbSettingsTypeDef
  8. See KinesisSettingsTypeDef
  9. See KafkaSettingsTypeDef
  10. See ElasticsearchSettingsTypeDef
  11. See NeptuneSettingsTypeDef
  12. See RedshiftSettingsTypeDef
  13. See PostgreSQLSettingsTypeDef
  14. See MySQLSettingsTypeDef
  15. See OracleSettingsTypeDef
  16. See SybaseSettingsTypeDef
  17. See MicrosoftSQLServerSettingsTypeDef
  18. See IBMDb2SettingsTypeDef
  19. See DocDbSettingsTypeDef
  20. See RedisSettingsTypeDef
  21. See GcpMySQLSettingsTypeDef
  22. See CreateEndpointResponseTypeDef 
# create_endpoint method usage example with argument unpacking

kwargs: CreateEndpointMessageRequestTypeDef = {  # (1)
    "EndpointIdentifier": ...,
    "EndpointType": ...,
    "EngineName": ...,
}

parent.create_endpoint(**kwargs)
  1. See CreateEndpointMessageRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateEventSubscriptionResponseTypeDef 
# create_event_subscription method usage example with argument unpacking

kwargs: CreateEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SnsTopicArn": ...,
}

parent.create_event_subscription(**kwargs)
  1. See CreateEventSubscriptionMessageRequestTypeDef

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)
    ...
  1. See CreateFleetAdvisorCollectorResponseTypeDef 
# create_fleet_advisor_collector method usage example with argument unpacking

kwargs: CreateFleetAdvisorCollectorRequestRequestTypeDef = {  # (1)
    "CollectorName": ...,
    "ServiceAccessRoleArn": ...,
    "S3BucketName": ...,
}

parent.create_fleet_advisor_collector(**kwargs)
  1. See CreateFleetAdvisorCollectorRequestRequestTypeDef

create_replication_instance#

Creates the replication instance using the specified parameters.

Type annotations and code completion for boto3.client("dms").create_replication_instance method. boto3 documentation

# create_replication_instance method definition

def create_replication_instance(
    self,
    *,
    ReplicationInstanceIdentifier: str,
    ReplicationInstanceClass: str,
    AllocatedStorage: int = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    AvailabilityZone: str = ...,
    ReplicationSubnetGroupIdentifier: str = ...,
    PreferredMaintenanceWindow: str = ...,
    MultiAZ: bool = ...,
    EngineVersion: str = ...,
    AutoMinorVersionUpgrade: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KmsKeyId: str = ...,
    PubliclyAccessible: bool = ...,
    DnsNameServers: str = ...,
    ResourceIdentifier: str = ...,
    NetworkType: str = ...,
) -> CreateReplicationInstanceResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateReplicationInstanceResponseTypeDef 
# create_replication_instance method usage example with argument unpacking

kwargs: CreateReplicationInstanceMessageRequestTypeDef = {  # (1)
    "ReplicationInstanceIdentifier": ...,
    "ReplicationInstanceClass": ...,
}

parent.create_replication_instance(**kwargs)
  1. See CreateReplicationInstanceMessageRequestTypeDef

create_replication_subnet_group#

Creates a replication subnet group given a list of the subnet IDs in a VPC.

Type annotations and code completion for boto3.client("dms").create_replication_subnet_group method. boto3 documentation

# create_replication_subnet_group method definition

def create_replication_subnet_group(
    self,
    *,
    ReplicationSubnetGroupIdentifier: str,
    ReplicationSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateReplicationSubnetGroupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateReplicationSubnetGroupResponseTypeDef 
# create_replication_subnet_group method usage example with argument unpacking

kwargs: CreateReplicationSubnetGroupMessageRequestTypeDef = {  # (1)
    "ReplicationSubnetGroupIdentifier": ...,
    "ReplicationSubnetGroupDescription": ...,
    "SubnetIds": ...,
}

parent.create_replication_subnet_group(**kwargs)
  1. See CreateReplicationSubnetGroupMessageRequestTypeDef

create_replication_task#

Creates a replication task using the specified parameters.

Type annotations and code completion for boto3.client("dms").create_replication_task method. boto3 documentation

# create_replication_task method definition

def create_replication_task(
    self,
    *,
    ReplicationTaskIdentifier: str,
    SourceEndpointArn: str,
    TargetEndpointArn: str,
    ReplicationInstanceArn: str,
    MigrationType: MigrationTypeValueType,  # (1)
    TableMappings: str,
    ReplicationTaskSettings: str = ...,
    CdcStartTime: Union[datetime, str] = ...,
    CdcStartPosition: str = ...,
    CdcStopPosition: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    TaskData: str = ...,
    ResourceIdentifier: str = ...,
) -> CreateReplicationTaskResponseTypeDef:  # (3)
    ...
  1. See MigrationTypeValueType
  2. See TagTypeDef
  3. See CreateReplicationTaskResponseTypeDef 
# create_replication_task method usage example with argument unpacking

kwargs: CreateReplicationTaskMessageRequestTypeDef = {  # (1)
    "ReplicationTaskIdentifier": ...,
    "SourceEndpointArn": ...,
    "TargetEndpointArn": ...,
    "ReplicationInstanceArn": ...,
    "MigrationType": ...,
    "TableMappings": ...,
}

parent.create_replication_task(**kwargs)
  1. See CreateReplicationTaskMessageRequestTypeDef

delete_certificate#

Deletes the specified certificate.

Type annotations and code completion for boto3.client("dms").delete_certificate method. boto3 documentation

# delete_certificate method definition

def delete_certificate(
    self,
    *,
    CertificateArn: str,
) -> DeleteCertificateResponseTypeDef:  # (1)
    ...
  1. See DeleteCertificateResponseTypeDef 
# delete_certificate method usage example with argument unpacking

kwargs: DeleteCertificateMessageRequestTypeDef = {  # (1)
    "CertificateArn": ...,
}

parent.delete_certificate(**kwargs)
  1. See DeleteCertificateMessageRequestTypeDef

delete_connection#

Deletes the connection between a replication instance and an endpoint.

Type annotations and code completion for boto3.client("dms").delete_connection method. boto3 documentation

# delete_connection method definition

def delete_connection(
    self,
    *,
    EndpointArn: str,
    ReplicationInstanceArn: str,
) -> DeleteConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteConnectionResponseTypeDef 
# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionMessageRequestTypeDef = {  # (1)
    "EndpointArn": ...,
    "ReplicationInstanceArn": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionMessageRequestTypeDef

delete_endpoint#

Deletes the specified endpoint.

Type annotations and code completion for boto3.client("dms").delete_endpoint method. boto3 documentation

# delete_endpoint method definition

def delete_endpoint(
    self,
    *,
    EndpointArn: str,
) -> DeleteEndpointResponseTypeDef:  # (1)
    ...
  1. See DeleteEndpointResponseTypeDef 
# delete_endpoint method usage example with argument unpacking

kwargs: DeleteEndpointMessageRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.delete_endpoint(**kwargs)
  1. See DeleteEndpointMessageRequestTypeDef

delete_event_subscription#

Deletes an DMS event subscription.

Type annotations and code completion for boto3.client("dms").delete_event_subscription method. boto3 documentation

# delete_event_subscription method definition

def delete_event_subscription(
    self,
    *,
    SubscriptionName: str,
) -> DeleteEventSubscriptionResponseTypeDef:  # (1)
    ...
  1. See DeleteEventSubscriptionResponseTypeDef 
# delete_event_subscription method usage example with argument unpacking

kwargs: DeleteEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.delete_event_subscription(**kwargs)
  1. See DeleteEventSubscriptionMessageRequestTypeDef

delete_fleet_advisor_collector#

Deletes the specified Fleet Advisor collector.

Type annotations and code completion for boto3.client("dms").delete_fleet_advisor_collector method. boto3 documentation

# delete_fleet_advisor_collector method definition

def delete_fleet_advisor_collector(
    self,
    *,
    CollectorReferencedId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_fleet_advisor_collector method usage example with argument unpacking

kwargs: DeleteCollectorRequestRequestTypeDef = {  # (1)
    "CollectorReferencedId": ...,
}

parent.delete_fleet_advisor_collector(**kwargs)
  1. See DeleteCollectorRequestRequestTypeDef

delete_fleet_advisor_databases#

Deletes the specified Fleet Advisor collector databases.

Type annotations and code completion for boto3.client("dms").delete_fleet_advisor_databases method. boto3 documentation

# delete_fleet_advisor_databases method definition

def delete_fleet_advisor_databases(
    self,
    *,
    DatabaseIds: Sequence[str],
) -> DeleteFleetAdvisorDatabasesResponseTypeDef:  # (1)
    ...
  1. See DeleteFleetAdvisorDatabasesResponseTypeDef 
# delete_fleet_advisor_databases method usage example with argument unpacking

kwargs: DeleteFleetAdvisorDatabasesRequestRequestTypeDef = {  # (1)
    "DatabaseIds": ...,
}

parent.delete_fleet_advisor_databases(**kwargs)
  1. See DeleteFleetAdvisorDatabasesRequestRequestTypeDef

delete_replication_instance#

Deletes the specified replication instance.

Type annotations and code completion for boto3.client("dms").delete_replication_instance method. boto3 documentation

# delete_replication_instance method definition

def delete_replication_instance(
    self,
    *,
    ReplicationInstanceArn: str,
) -> DeleteReplicationInstanceResponseTypeDef:  # (1)
    ...
  1. See DeleteReplicationInstanceResponseTypeDef 
# delete_replication_instance method usage example with argument unpacking

kwargs: DeleteReplicationInstanceMessageRequestTypeDef = {  # (1)
    "ReplicationInstanceArn": ...,
}

parent.delete_replication_instance(**kwargs)
  1. See DeleteReplicationInstanceMessageRequestTypeDef

delete_replication_subnet_group#

Deletes a subnet group.

Type annotations and code completion for boto3.client("dms").delete_replication_subnet_group method. boto3 documentation

# delete_replication_subnet_group method definition

def delete_replication_subnet_group(
    self,
    *,
    ReplicationSubnetGroupIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_replication_subnet_group method usage example with argument unpacking

kwargs: DeleteReplicationSubnetGroupMessageRequestTypeDef = {  # (1)
    "ReplicationSubnetGroupIdentifier": ...,
}

parent.delete_replication_subnet_group(**kwargs)
  1. See DeleteReplicationSubnetGroupMessageRequestTypeDef

delete_replication_task#

Deletes the specified replication task.

Type annotations and code completion for boto3.client("dms").delete_replication_task method. boto3 documentation

# delete_replication_task method definition

def delete_replication_task(
    self,
    *,
    ReplicationTaskArn: str,
) -> DeleteReplicationTaskResponseTypeDef:  # (1)
    ...
  1. See DeleteReplicationTaskResponseTypeDef 
# delete_replication_task method usage example with argument unpacking

kwargs: DeleteReplicationTaskMessageRequestTypeDef = {  # (1)
    "ReplicationTaskArn": ...,
}

parent.delete_replication_task(**kwargs)
  1. See DeleteReplicationTaskMessageRequestTypeDef

delete_replication_task_assessment_run#

Deletes the record of a single premigration assessment run.

Type annotations and code completion for boto3.client("dms").delete_replication_task_assessment_run method. boto3 documentation

# delete_replication_task_assessment_run method definition

def delete_replication_task_assessment_run(
    self,
    *,
    ReplicationTaskAssessmentRunArn: str,
) -> DeleteReplicationTaskAssessmentRunResponseTypeDef:  # (1)
    ...
  1. See DeleteReplicationTaskAssessmentRunResponseTypeDef 
# delete_replication_task_assessment_run method usage example with argument unpacking

kwargs: DeleteReplicationTaskAssessmentRunMessageRequestTypeDef = {  # (1)
    "ReplicationTaskAssessmentRunArn": ...,
}

parent.delete_replication_task_assessment_run(**kwargs)
  1. See DeleteReplicationTaskAssessmentRunMessageRequestTypeDef

describe_account_attributes#

Lists all of the DMS attributes for a customer account.

Type annotations and code completion for boto3.client("dms").describe_account_attributes method. boto3 documentation

# describe_account_attributes method definition

def describe_account_attributes(
    self,
) -> DescribeAccountAttributesResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountAttributesResponseTypeDef

describe_applicable_individual_assessments#

Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.

Type annotations and code completion for boto3.client("dms").describe_applicable_individual_assessments method. boto3 documentation

# describe_applicable_individual_assessments method definition

def describe_applicable_individual_assessments(
    self,
    *,
    ReplicationTaskArn: str = ...,
    ReplicationInstanceArn: str = ...,
    SourceEngineName: str = ...,
    TargetEngineName: str = ...,
    MigrationType: MigrationTypeValueType = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeApplicableIndividualAssessmentsResponseTypeDef:  # (2)
    ...
  1. See MigrationTypeValueType
  2. See DescribeApplicableIndividualAssessmentsResponseTypeDef 
# describe_applicable_individual_assessments method usage example with argument unpacking

kwargs: DescribeApplicableIndividualAssessmentsMessageRequestTypeDef = {  # (1)
    "ReplicationTaskArn": ...,
}

parent.describe_applicable_individual_assessments(**kwargs)
  1. See DescribeApplicableIndividualAssessmentsMessageRequestTypeDef

describe_certificates#

Provides a description of the certificate.

Type annotations and code completion for boto3.client("dms").describe_certificates method. boto3 documentation

# describe_certificates method definition

def describe_certificates(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeCertificatesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeCertificatesResponseTypeDef 
# describe_certificates method usage example with argument unpacking

kwargs: DescribeCertificatesMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_certificates(**kwargs)
  1. See DescribeCertificatesMessageRequestTypeDef

describe_connections#

Describes the status of the connections that have been made between the replication instance and an endpoint.

Type annotations and code completion for boto3.client("dms").describe_connections method. boto3 documentation

# describe_connections method definition

def describe_connections(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeConnectionsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeConnectionsResponseTypeDef 
# describe_connections method usage example with argument unpacking

kwargs: DescribeConnectionsMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_connections(**kwargs)
  1. See DescribeConnectionsMessageRequestTypeDef

describe_endpoint_settings#

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Type annotations and code completion for boto3.client("dms").describe_endpoint_settings method. boto3 documentation

# describe_endpoint_settings method definition

def describe_endpoint_settings(
    self,
    *,
    EngineName: str,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEndpointSettingsResponseTypeDef:  # (1)
    ...
  1. See DescribeEndpointSettingsResponseTypeDef 
# describe_endpoint_settings method usage example with argument unpacking

kwargs: DescribeEndpointSettingsMessageRequestTypeDef = {  # (1)
    "EngineName": ...,
}

parent.describe_endpoint_settings(**kwargs)
  1. See DescribeEndpointSettingsMessageRequestTypeDef

describe_endpoint_types#

Returns information about the type of endpoints available.

Type annotations and code completion for boto3.client("dms").describe_endpoint_types method. boto3 documentation

# describe_endpoint_types method definition

def describe_endpoint_types(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEndpointTypesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeEndpointTypesResponseTypeDef 
# describe_endpoint_types method usage example with argument unpacking

kwargs: DescribeEndpointTypesMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_endpoint_types(**kwargs)
  1. See DescribeEndpointTypesMessageRequestTypeDef

describe_endpoints#

Returns information about the endpoints for your account in the current region.

Type annotations and code completion for boto3.client("dms").describe_endpoints method. boto3 documentation

# describe_endpoints method definition

def describe_endpoints(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEndpointsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeEndpointsResponseTypeDef 
# describe_endpoints method usage example with argument unpacking

kwargs: DescribeEndpointsMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_endpoints(**kwargs)
  1. See DescribeEndpointsMessageRequestTypeDef

describe_event_categories#

Lists categories for all event source types, or, if specified, for a specified source type.

Type annotations and code completion for boto3.client("dms").describe_event_categories method. boto3 documentation

# describe_event_categories method definition

def describe_event_categories(
    self,
    *,
    SourceType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> DescribeEventCategoriesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeEventCategoriesResponseTypeDef 
# describe_event_categories method usage example with argument unpacking

kwargs: DescribeEventCategoriesMessageRequestTypeDef = {  # (1)
    "SourceType": ...,
}

parent.describe_event_categories(**kwargs)
  1. See DescribeEventCategoriesMessageRequestTypeDef

describe_event_subscriptions#

Lists all the event subscriptions for a customer account.

Type annotations and code completion for boto3.client("dms").describe_event_subscriptions method. boto3 documentation

# describe_event_subscriptions method definition

def describe_event_subscriptions(
    self,
    *,
    SubscriptionName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEventSubscriptionsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeEventSubscriptionsResponseTypeDef 
# describe_event_subscriptions method usage example with argument unpacking

kwargs: DescribeEventSubscriptionsMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.describe_event_subscriptions(**kwargs)
  1. See DescribeEventSubscriptionsMessageRequestTypeDef

describe_events#

Lists events for a given source identifier and source type.

Type annotations and code completion for boto3.client("dms").describe_events method. boto3 documentation

# describe_events method definition

def describe_events(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Duration: int = ...,
    EventCategories: Sequence[str] = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEventsResponseTypeDef:  # (3)
    ...
  1. See SourceTypeType
  2. See FilterTypeDef
  3. See DescribeEventsResponseTypeDef 
# describe_events method usage example with argument unpacking

kwargs: DescribeEventsMessageRequestTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

parent.describe_events(**kwargs)
  1. See DescribeEventsMessageRequestTypeDef

describe_fleet_advisor_collectors#

Returns a list of the Fleet Advisor collectors in your account.

Type annotations and code completion for boto3.client("dms").describe_fleet_advisor_collectors method. boto3 documentation

# describe_fleet_advisor_collectors method definition

def describe_fleet_advisor_collectors(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAdvisorCollectorsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeFleetAdvisorCollectorsResponseTypeDef 
# describe_fleet_advisor_collectors method usage example with argument unpacking

kwargs: DescribeFleetAdvisorCollectorsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_fleet_advisor_collectors(**kwargs)
  1. See DescribeFleetAdvisorCollectorsRequestRequestTypeDef

describe_fleet_advisor_databases#

Returns a list of Fleet Advisor databases in your account.

Type annotations and code completion for boto3.client("dms").describe_fleet_advisor_databases method. boto3 documentation

# describe_fleet_advisor_databases method definition

def describe_fleet_advisor_databases(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAdvisorDatabasesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeFleetAdvisorDatabasesResponseTypeDef 
# describe_fleet_advisor_databases method usage example with argument unpacking

kwargs: DescribeFleetAdvisorDatabasesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_fleet_advisor_databases(**kwargs)
  1. See DescribeFleetAdvisorDatabasesRequestRequestTypeDef

describe_fleet_advisor_lsa_analysis#

Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.

Type annotations and code completion for boto3.client("dms").describe_fleet_advisor_lsa_analysis method. boto3 documentation

# describe_fleet_advisor_lsa_analysis method definition

def describe_fleet_advisor_lsa_analysis(
    self,
    *,
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAdvisorLsaAnalysisResponseTypeDef:  # (1)
    ...
  1. See DescribeFleetAdvisorLsaAnalysisResponseTypeDef 
# describe_fleet_advisor_lsa_analysis method usage example with argument unpacking

kwargs: DescribeFleetAdvisorLsaAnalysisRequestRequestTypeDef = {  # (1)
    "MaxRecords": ...,
}

parent.describe_fleet_advisor_lsa_analysis(**kwargs)
  1. See DescribeFleetAdvisorLsaAnalysisRequestRequestTypeDef

describe_fleet_advisor_schema_object_summary#

Provides descriptions of the schemas discovered by your Fleet Advisor collectors.

Type annotations and code completion for boto3.client("dms").describe_fleet_advisor_schema_object_summary method. boto3 documentation

# describe_fleet_advisor_schema_object_summary method definition

def describe_fleet_advisor_schema_object_summary(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAdvisorSchemaObjectSummaryResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeFleetAdvisorSchemaObjectSummaryResponseTypeDef 
# describe_fleet_advisor_schema_object_summary method usage example with argument unpacking

kwargs: DescribeFleetAdvisorSchemaObjectSummaryRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_fleet_advisor_schema_object_summary(**kwargs)
  1. See DescribeFleetAdvisorSchemaObjectSummaryRequestRequestTypeDef

describe_fleet_advisor_schemas#

Returns a list of schemas detected by Fleet Advisor Collectors in your account.

Type annotations and code completion for boto3.client("dms").describe_fleet_advisor_schemas method. boto3 documentation

# describe_fleet_advisor_schemas method definition

def describe_fleet_advisor_schemas(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAdvisorSchemasResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeFleetAdvisorSchemasResponseTypeDef 
# describe_fleet_advisor_schemas method usage example with argument unpacking

kwargs: DescribeFleetAdvisorSchemasRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_fleet_advisor_schemas(**kwargs)
  1. See DescribeFleetAdvisorSchemasRequestRequestTypeDef

describe_orderable_replication_instances#

Returns information about the replication instance types that can be created in the specified region.

Type annotations and code completion for boto3.client("dms").describe_orderable_replication_instances method. boto3 documentation

# describe_orderable_replication_instances method definition

def describe_orderable_replication_instances(
    self,
    *,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeOrderableReplicationInstancesResponseTypeDef:  # (1)
    ...
  1. See DescribeOrderableReplicationInstancesResponseTypeDef 
# describe_orderable_replication_instances method usage example with argument unpacking

kwargs: DescribeOrderableReplicationInstancesMessageRequestTypeDef = {  # (1)
    "MaxRecords": ...,
}

parent.describe_orderable_replication_instances(**kwargs)
  1. See DescribeOrderableReplicationInstancesMessageRequestTypeDef

describe_pending_maintenance_actions#

For internal use only See also: AWS API Documentation.

Type annotations and code completion for boto3.client("dms").describe_pending_maintenance_actions method. boto3 documentation

# describe_pending_maintenance_actions method definition

def describe_pending_maintenance_actions(
    self,
    *,
    ReplicationInstanceArn: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    Marker: str = ...,
    MaxRecords: int = ...,
) -> DescribePendingMaintenanceActionsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribePendingMaintenanceActionsResponseTypeDef 
# describe_pending_maintenance_actions method usage example with argument unpacking

kwargs: DescribePendingMaintenanceActionsMessageRequestTypeDef = {  # (1)
    "ReplicationInstanceArn": ...,
}

parent.describe_pending_maintenance_actions(**kwargs)
  1. See DescribePendingMaintenanceActionsMessageRequestTypeDef

describe_recommendation_limitations#

Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.

Type annotations and code completion for boto3.client("dms").describe_recommendation_limitations method. boto3 documentation

# describe_recommendation_limitations method definition

def describe_recommendation_limitations(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeRecommendationLimitationsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeRecommendationLimitationsResponseTypeDef 
# describe_recommendation_limitations method usage example with argument unpacking

kwargs: DescribeRecommendationLimitationsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_recommendation_limitations(**kwargs)
  1. See DescribeRecommendationLimitationsRequestRequestTypeDef

describe_recommendations#

Returns a paginated list of target engine recommendations for your source databases.

Type annotations and code completion for boto3.client("dms").describe_recommendations method. boto3 documentation

# describe_recommendations method definition

def describe_recommendations(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    NextToken: str = ...,
) -> DescribeRecommendationsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeRecommendationsResponseTypeDef 
# describe_recommendations method usage example with argument unpacking

kwargs: DescribeRecommendationsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_recommendations(**kwargs)
  1. See DescribeRecommendationsRequestRequestTypeDef

describe_refresh_schemas_status#

Returns the status of the RefreshSchemas operation.

Type annotations and code completion for boto3.client("dms").describe_refresh_schemas_status method. boto3 documentation

# describe_refresh_schemas_status method definition

def describe_refresh_schemas_status(
    self,
    *,
    EndpointArn: str,
) -> DescribeRefreshSchemasStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeRefreshSchemasStatusResponseTypeDef 
# describe_refresh_schemas_status method usage example with argument unpacking

kwargs: DescribeRefreshSchemasStatusMessageRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.describe_refresh_schemas_status(**kwargs)
  1. See DescribeRefreshSchemasStatusMessageRequestTypeDef

describe_replication_instance_task_logs#

Returns information about the task logs for the specified task.

Type annotations and code completion for boto3.client("dms").describe_replication_instance_task_logs method. boto3 documentation

# describe_replication_instance_task_logs method definition

def describe_replication_instance_task_logs(
    self,
    *,
    ReplicationInstanceArn: str,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReplicationInstanceTaskLogsResponseTypeDef:  # (1)
    ...
  1. See DescribeReplicationInstanceTaskLogsResponseTypeDef 
# describe_replication_instance_task_logs method usage example with argument unpacking

kwargs: DescribeReplicationInstanceTaskLogsMessageRequestTypeDef = {  # (1)
    "ReplicationInstanceArn": ...,
}

parent.describe_replication_instance_task_logs(**kwargs)
  1. See DescribeReplicationInstanceTaskLogsMessageRequestTypeDef

describe_replication_instances#

Returns information about replication instances for your account in the current region.

Type annotations and code completion for boto3.client("dms").describe_replication_instances method. boto3 documentation

# describe_replication_instances method definition

def describe_replication_instances(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReplicationInstancesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeReplicationInstancesResponseTypeDef 
# describe_replication_instances method usage example with argument unpacking

kwargs: DescribeReplicationInstancesMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_replication_instances(**kwargs)
  1. See DescribeReplicationInstancesMessageRequestTypeDef

describe_replication_subnet_groups#

Returns information about the replication subnet groups.

Type annotations and code completion for boto3.client("dms").describe_replication_subnet_groups method. boto3 documentation

# describe_replication_subnet_groups method definition

def describe_replication_subnet_groups(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReplicationSubnetGroupsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeReplicationSubnetGroupsResponseTypeDef 
# describe_replication_subnet_groups method usage example with argument unpacking

kwargs: DescribeReplicationSubnetGroupsMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_replication_subnet_groups(**kwargs)
  1. See DescribeReplicationSubnetGroupsMessageRequestTypeDef

describe_replication_task_assessment_results#

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account.

Type annotations and code completion for boto3.client("dms").describe_replication_task_assessment_results method. boto3 documentation

# describe_replication_task_assessment_results method definition

def describe_replication_task_assessment_results(
    self,
    *,
    ReplicationTaskArn: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReplicationTaskAssessmentResultsResponseTypeDef:  # (1)
    ...
  1. See DescribeReplicationTaskAssessmentResultsResponseTypeDef 
# describe_replication_task_assessment_results method usage example with argument unpacking

kwargs: DescribeReplicationTaskAssessmentResultsMessageRequestTypeDef = {  # (1)
    "ReplicationTaskArn": ...,
}

parent.describe_replication_task_assessment_results(**kwargs)
  1. See DescribeReplicationTaskAssessmentResultsMessageRequestTypeDef

describe_replication_task_assessment_runs#

Returns a paginated list of premigration assessment runs based on filter settings.

Type annotations and code completion for boto3.client("dms").describe_replication_task_assessment_runs method. boto3 documentation

# describe_replication_task_assessment_runs method definition

def describe_replication_task_assessment_runs(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReplicationTaskAssessmentRunsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeReplicationTaskAssessmentRunsResponseTypeDef 
# describe_replication_task_assessment_runs method usage example with argument unpacking

kwargs: DescribeReplicationTaskAssessmentRunsMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_replication_task_assessment_runs(**kwargs)
  1. See DescribeReplicationTaskAssessmentRunsMessageRequestTypeDef

describe_replication_task_individual_assessments#

Returns a paginated list of individual assessments based on filter settings.

Type annotations and code completion for boto3.client("dms").describe_replication_task_individual_assessments method. boto3 documentation

# describe_replication_task_individual_assessments method definition

def describe_replication_task_individual_assessments(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReplicationTaskIndividualAssessmentsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeReplicationTaskIndividualAssessmentsResponseTypeDef 
# describe_replication_task_individual_assessments method usage example with argument unpacking

kwargs: DescribeReplicationTaskIndividualAssessmentsMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_replication_task_individual_assessments(**kwargs)
  1. See DescribeReplicationTaskIndividualAssessmentsMessageRequestTypeDef

describe_replication_tasks#

Returns information about replication tasks for your account in the current region.

Type annotations and code completion for boto3.client("dms").describe_replication_tasks method. boto3 documentation

# describe_replication_tasks method definition

def describe_replication_tasks(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    WithoutSettings: bool = ...,
) -> DescribeReplicationTasksResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeReplicationTasksResponseTypeDef 
# describe_replication_tasks method usage example with argument unpacking

kwargs: DescribeReplicationTasksMessageRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_replication_tasks(**kwargs)
  1. See DescribeReplicationTasksMessageRequestTypeDef

describe_schemas#

Returns information about the schema for the specified endpoint.

Type annotations and code completion for boto3.client("dms").describe_schemas method. boto3 documentation

# describe_schemas method definition

def describe_schemas(
    self,
    *,
    EndpointArn: str,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeSchemasResponseTypeDef:  # (1)
    ...
  1. See DescribeSchemasResponseTypeDef 
# describe_schemas method usage example with argument unpacking

kwargs: DescribeSchemasMessageRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.describe_schemas(**kwargs)
  1. See DescribeSchemasMessageRequestTypeDef

describe_table_statistics#

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Type annotations and code completion for boto3.client("dms").describe_table_statistics method. boto3 documentation

# describe_table_statistics method definition

def describe_table_statistics(
    self,
    *,
    ReplicationTaskArn: str,
    MaxRecords: int = ...,
    Marker: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> DescribeTableStatisticsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeTableStatisticsResponseTypeDef 
# describe_table_statistics method usage example with argument unpacking

kwargs: DescribeTableStatisticsMessageRequestTypeDef = {  # (1)
    "ReplicationTaskArn": ...,
}

parent.describe_table_statistics(**kwargs)
  1. See DescribeTableStatisticsMessageRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("dms").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

import_certificate#

Uploads the specified certificate.

Type annotations and code completion for boto3.client("dms").import_certificate method. boto3 documentation

# import_certificate method definition

def import_certificate(
    self,
    *,
    CertificateIdentifier: str,
    CertificatePem: str = ...,
    CertificateWallet: Union[str, bytes, IO[Any], StreamingBody] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ImportCertificateResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ImportCertificateResponseTypeDef 
# import_certificate method usage example with argument unpacking

kwargs: ImportCertificateMessageRequestTypeDef = {  # (1)
    "CertificateIdentifier": ...,
}

parent.import_certificate(**kwargs)
  1. See ImportCertificateMessageRequestTypeDef

list_tags_for_resource#

Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task.

Type annotations and code completion for boto3.client("dms").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str = ...,
    ResourceArnList: Sequence[str] = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceMessageRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceMessageRequestTypeDef

modify_endpoint#

Modifies the specified endpoint.

Type annotations and code completion for boto3.client("dms").modify_endpoint method. boto3 documentation

# modify_endpoint method definition

def modify_endpoint(
    self,
    *,
    EndpointArn: str,
    EndpointIdentifier: str = ...,
    EndpointType: ReplicationEndpointTypeValueType = ...,  # (1)
    EngineName: str = ...,
    Username: str = ...,
    Password: str = ...,
    ServerName: str = ...,
    Port: int = ...,
    DatabaseName: str = ...,
    ExtraConnectionAttributes: str = ...,
    CertificateArn: str = ...,
    SslMode: DmsSslModeValueType = ...,  # (2)
    ServiceAccessRoleArn: str = ...,
    ExternalTableDefinition: str = ...,
    DynamoDbSettings: DynamoDbSettingsTypeDef = ...,  # (3)
    S3Settings: S3SettingsTypeDef = ...,  # (4)
    DmsTransferSettings: DmsTransferSettingsTypeDef = ...,  # (5)
    MongoDbSettings: MongoDbSettingsTypeDef = ...,  # (6)
    KinesisSettings: KinesisSettingsTypeDef = ...,  # (7)
    KafkaSettings: KafkaSettingsTypeDef = ...,  # (8)
    ElasticsearchSettings: ElasticsearchSettingsTypeDef = ...,  # (9)
    NeptuneSettings: NeptuneSettingsTypeDef = ...,  # (10)
    RedshiftSettings: RedshiftSettingsTypeDef = ...,  # (11)
    PostgreSQLSettings: PostgreSQLSettingsTypeDef = ...,  # (12)
    MySQLSettings: MySQLSettingsTypeDef = ...,  # (13)
    OracleSettings: OracleSettingsTypeDef = ...,  # (14)
    SybaseSettings: SybaseSettingsTypeDef = ...,  # (15)
    MicrosoftSQLServerSettings: MicrosoftSQLServerSettingsTypeDef = ...,  # (16)
    IBMDb2Settings: IBMDb2SettingsTypeDef = ...,  # (17)
    DocDbSettings: DocDbSettingsTypeDef = ...,  # (18)
    RedisSettings: RedisSettingsTypeDef = ...,  # (19)
    ExactSettings: bool = ...,
    GcpMySQLSettings: GcpMySQLSettingsTypeDef = ...,  # (20)
) -> ModifyEndpointResponseTypeDef:  # (21)
    ...
  1. See ReplicationEndpointTypeValueType
  2. See DmsSslModeValueType
  3. See DynamoDbSettingsTypeDef
  4. See S3SettingsTypeDef
  5. See DmsTransferSettingsTypeDef
  6. See MongoDbSettingsTypeDef
  7. See KinesisSettingsTypeDef
  8. See KafkaSettingsTypeDef
  9. See ElasticsearchSettingsTypeDef
  10. See NeptuneSettingsTypeDef
  11. See RedshiftSettingsTypeDef
  12. See PostgreSQLSettingsTypeDef
  13. See MySQLSettingsTypeDef
  14. See OracleSettingsTypeDef
  15. See SybaseSettingsTypeDef
  16. See MicrosoftSQLServerSettingsTypeDef
  17. See IBMDb2SettingsTypeDef
  18. See DocDbSettingsTypeDef
  19. See RedisSettingsTypeDef
  20. See GcpMySQLSettingsTypeDef
  21. See ModifyEndpointResponseTypeDef 
# modify_endpoint method usage example with argument unpacking

kwargs: ModifyEndpointMessageRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.modify_endpoint(**kwargs)
  1. See ModifyEndpointMessageRequestTypeDef

modify_event_subscription#

Modifies an existing DMS event notification subscription.

Type annotations and code completion for boto3.client("dms").modify_event_subscription method. boto3 documentation

# modify_event_subscription method definition

def modify_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str = ...,
    SourceType: str = ...,
    EventCategories: Sequence[str] = ...,
    Enabled: bool = ...,
) -> ModifyEventSubscriptionResponseTypeDef:  # (1)
    ...
  1. See ModifyEventSubscriptionResponseTypeDef 
# modify_event_subscription method usage example with argument unpacking

kwargs: ModifyEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.modify_event_subscription(**kwargs)
  1. See ModifyEventSubscriptionMessageRequestTypeDef

modify_replication_instance#

Modifies the replication instance to apply new settings.

Type annotations and code completion for boto3.client("dms").modify_replication_instance method. boto3 documentation

# modify_replication_instance method definition

def modify_replication_instance(
    self,
    *,
    ReplicationInstanceArn: str,
    AllocatedStorage: int = ...,
    ApplyImmediately: bool = ...,
    ReplicationInstanceClass: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    PreferredMaintenanceWindow: str = ...,
    MultiAZ: bool = ...,
    EngineVersion: str = ...,
    AllowMajorVersionUpgrade: bool = ...,
    AutoMinorVersionUpgrade: bool = ...,
    ReplicationInstanceIdentifier: str = ...,
    NetworkType: str = ...,
) -> ModifyReplicationInstanceResponseTypeDef:  # (1)
    ...
  1. See ModifyReplicationInstanceResponseTypeDef 
# modify_replication_instance method usage example with argument unpacking

kwargs: ModifyReplicationInstanceMessageRequestTypeDef = {  # (1)
    "ReplicationInstanceArn": ...,
}

parent.modify_replication_instance(**kwargs)
  1. See ModifyReplicationInstanceMessageRequestTypeDef

modify_replication_subnet_group#

Modifies the settings for the specified replication subnet group.

Type annotations and code completion for boto3.client("dms").modify_replication_subnet_group method. boto3 documentation

# modify_replication_subnet_group method definition

def modify_replication_subnet_group(
    self,
    *,
    ReplicationSubnetGroupIdentifier: str,
    SubnetIds: Sequence[str],
    ReplicationSubnetGroupDescription: str = ...,
) -> ModifyReplicationSubnetGroupResponseTypeDef:  # (1)
    ...
  1. See ModifyReplicationSubnetGroupResponseTypeDef 
# modify_replication_subnet_group method usage example with argument unpacking

kwargs: ModifyReplicationSubnetGroupMessageRequestTypeDef = {  # (1)
    "ReplicationSubnetGroupIdentifier": ...,
    "SubnetIds": ...,
}

parent.modify_replication_subnet_group(**kwargs)
  1. See