mypy-boto3-dms 1.13.25.0

Type annotations for boto3.DatabaseMigrationService 1.13.25 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-dms

• mypy-boto3-dms
  • How to use
  • Automated type discovery

Type annotations for boto3.DatabaseMigrationService 1.13.25 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.2.

More information can be found on boto3-stubs page.

• mypy-boto3-dms
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for DatabaseMigrationService service.

python -m pip install boto3-stubs[dms]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_dms in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_dms import DatabaseMigrationServiceClient

# Now mypy can check if your code is valid.
client: DatabaseMigrationServiceClient = boto3.client("dms")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: DatabaseMigrationServiceClient = session.client("dms")



# Waiters are also supported

import mypy_boto3_dms.waiter as dms_waiters

endpoint_deleted_waiter: dms_waiters.EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
replication_instance_available_waiter: dms_waiters.ReplicationInstanceAvailableWaiter = client.get_waiter("replication_instance_available")
replication_instance_deleted_waiter: dms_waiters.ReplicationInstanceDeletedWaiter = client.get_waiter("replication_instance_deleted")
replication_task_deleted_waiter: dms_waiters.ReplicationTaskDeletedWaiter = client.get_waiter("replication_task_deleted")
replication_task_ready_waiter: dms_waiters.ReplicationTaskReadyWaiter = client.get_waiter("replication_task_ready")
replication_task_running_waiter: dms_waiters.ReplicationTaskRunningWaiter = client.get_waiter("replication_task_running")
replication_task_stopped_waiter: dms_waiters.ReplicationTaskStoppedWaiter = client.get_waiter("replication_task_stopped")
test_connection_succeeds_waiter: dms_waiters.TestConnectionSucceedsWaiter = client.get_waiter("test_connection_succeeds")


# Annotated paginators are included as well

import mypy_boto3_dms.paginator as dms_paginators

describe_certificates_paginator: dms_paginators.DescribeCertificatesPaginator = client.get_paginator("describe_certificates")
describe_connections_paginator: dms_paginators.DescribeConnectionsPaginator = client.get_paginator("describe_connections")
describe_endpoint_types_paginator: dms_paginators.DescribeEndpointTypesPaginator = client.get_paginator("describe_endpoint_types")
describe_endpoints_paginator: dms_paginators.DescribeEndpointsPaginator = client.get_paginator("describe_endpoints")
describe_event_subscriptions_paginator: dms_paginators.DescribeEventSubscriptionsPaginator = client.get_paginator("describe_event_subscriptions")
describe_events_paginator: dms_paginators.DescribeEventsPaginator = client.get_paginator("describe_events")
describe_orderable_replication_instances_paginator: dms_paginators.DescribeOrderableReplicationInstancesPaginator = client.get_paginator("describe_orderable_replication_instances")
describe_replication_instances_paginator: dms_paginators.DescribeReplicationInstancesPaginator = client.get_paginator("describe_replication_instances")
describe_replication_subnet_groups_paginator: dms_paginators.DescribeReplicationSubnetGroupsPaginator = client.get_paginator("describe_replication_subnet_groups")
describe_replication_task_assessment_results_paginator: dms_paginators.DescribeReplicationTaskAssessmentResultsPaginator = client.get_paginator("describe_replication_task_assessment_results")
describe_replication_tasks_paginator: dms_paginators.DescribeReplicationTasksPaginator = client.get_paginator("describe_replication_tasks")
describe_schemas_paginator: dms_paginators.DescribeSchemasPaginator = client.get_paginator("describe_schemas")
describe_table_statistics_paginator: dms_paginators.DescribeTableStatisticsPaginator = client.get_paginator("describe_table_statistics")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_dms and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_dms as dms
from mypy_boto3_dms import DatabaseMigrationServiceClient

# with these
from mypy_boto3 import dms
from mypy_boto3.dms import DatabaseMigrationServiceClient