Metadata-Version: 2.1
Name: mypy-boto3-dms
Version: 1.16.9.0
Summary: Type annotations for boto3.DatabaseMigrationService 1.16.9 service, generated by mypy-boto3-buider 3.2.2
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Description: # mypy-boto3-dms
        
        [![PyPI - mypy-boto3-dms](https://img.shields.io/pypi/v/mypy-boto3-dms.svg?color=blue)](https://pypi.org/project/mypy-boto3-dms)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-dms.svg?color=blue)](https://pypi.org/project/mypy-boto3-dms)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        
        Type annotations for
        [boto3.DatabaseMigrationService 1.16.9](https://boto3.amazonaws.com/v1/documentation/api/1.16.9/reference/services/dms.html#DatabaseMigrationService) service
        compatible with
        [VSCode](https://code.visualstudio.com/),
        [PyCharm](https://www.jetbrains.com/pycharm/),
        [mypy](https://github.com/python/mypy),
        [pyright](https://github.com/microsoft/pyright)
        and other tools.
        
        Generated by [mypy-boto3-buider 3.2.2](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
        
        - [mypy-boto3-dms](#mypy-boto3-dms)
          - [How to install](#how-to-install)
          - [Usage](#usage)
            - [VSCode](#vscode)
            - [PyCharm](#pycharm)
            - [Other IDEs](#other-ides)
            - [mypy](#mypy)
            - [pyright](#pyright)
          - [Explicit type annotations](#explicit-type-annotations)
            - [Client annotations](#client-annotations)
            - [Paginators annotations](#paginators-annotations)
            - [Waiters annotations](#waiters-annotations)
            - [Service Resource annotations](#service-resource-annotations)
            - [Other resources annotations](#other-resources-annotations)
            - [Collections annotations](#collections-annotations)
            - [Typed dictionations](#typed-dictionations)
        
        ## How to install
        
        Install `boto3-stubs` for `DatabaseMigrationService` service.
        
        ```bash
        python -m pip install boto3-stubs[dms]
        ```
        
        ## Usage
        
        ### VSCode
        
        - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
        - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
        - Set `Pylance` as your Python Language Server
        - Install `boto-stubs[dms]` in your environment: `python -m pip install 'boto3-stubs[dms]'`
        
        Both type checking and auto-complete should work for `DatabaseMigrationService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### PyCharm
        
        - Install `boto-stubs[dms]` in your environment: `python -m pip install 'boto3-stubs[dms]'`
        
        Both type checking and auto-complete should work for `DatabaseMigrationService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules.
        
        ### Other IDEs
        
        Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
        
        ### mypy
        
        - Install `mypy`: `python -m pip install mypy`
        - Install `boto-stubs[dms]` in your environment: `python -m pip install 'boto3-stubs[dms]'`
        - Run `mypy` as usual
        
        Type checking should work for `DatabaseMigrationService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### pyright
        
        - Install `pyright`: `yarn global add pyright`
        - Install `boto-stubs[dms]` in your environment: `python -m pip install 'boto3-stubs[dms]'`
        - Optionally, you can install `boto3-stubs` to `typings` folder.
        
        Type checking should work for `DatabaseMigrationService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ## Explicit type annotations
        
        ### Client annotations
        
        `DatabaseMigrationServiceClient` provides annotations for `boto3.client("dms")`.
        
        ```python
        import boto3
        
        from mypy_boto3_dms import DatabaseMigrationServiceClient
        
        client: DatabaseMigrationServiceClient = boto3.client("dms")
        
        # now client usage is checked by mypy and IDE should provide code auto-complete
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_client: DatabaseMigrationServiceClient = session.client("dms")
        ```
        
        ### Paginators annotations
        
        `mypy_boto3_dms.paginator` module contains type annotations for all paginators.
        
        ```python
        from mypy_boto3_dms import DatabaseMigrationServiceClient
        from mypy_boto3_dms.paginator import (
            DescribeCertificatesPaginator,
            DescribeConnectionsPaginator,
            DescribeEndpointsPaginator,
            DescribeEndpointTypesPaginator,
            DescribeEventsPaginator,
            DescribeEventSubscriptionsPaginator,
            DescribeOrderableReplicationInstancesPaginator,
            DescribeReplicationInstancesPaginator,
            DescribeReplicationSubnetGroupsPaginator,
            DescribeReplicationTaskAssessmentResultsPaginator,
            DescribeReplicationTasksPaginator,
            DescribeSchemasPaginator,
            DescribeTableStatisticsPaginator,
        )
        
        client: DatabaseMigrationServiceClient = boto3.client("dms")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        describe_certificates_paginator: DescribeCertificatesPaginator = client.get_paginator("describe_certificates")
        describe_connections_paginator: DescribeConnectionsPaginator = client.get_paginator("describe_connections")
        describe_endpoint_types_paginator: DescribeEndpointTypesPaginator = client.get_paginator("describe_endpoint_types")
        describe_endpoints_paginator: DescribeEndpointsPaginator = client.get_paginator("describe_endpoints")
        describe_event_subscriptions_paginator: DescribeEventSubscriptionsPaginator = client.get_paginator("describe_event_subscriptions")
        describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
        describe_orderable_replication_instances_paginator: DescribeOrderableReplicationInstancesPaginator = client.get_paginator("describe_orderable_replication_instances")
        describe_replication_instances_paginator: DescribeReplicationInstancesPaginator = client.get_paginator("describe_replication_instances")
        describe_replication_subnet_groups_paginator: DescribeReplicationSubnetGroupsPaginator = client.get_paginator("describe_replication_subnet_groups")
        describe_replication_task_assessment_results_paginator: DescribeReplicationTaskAssessmentResultsPaginator = client.get_paginator("describe_replication_task_assessment_results")
        describe_replication_tasks_paginator: DescribeReplicationTasksPaginator = client.get_paginator("describe_replication_tasks")
        describe_schemas_paginator: DescribeSchemasPaginator = client.get_paginator("describe_schemas")
        describe_table_statistics_paginator: DescribeTableStatisticsPaginator = client.get_paginator("describe_table_statistics")
        ```
        
        
        ### Waiters annotations
        
        `mypy_boto3_dms.waiter` module contains type annotations for all waiters.
        
        ```python
        from mypy_boto3_dms import DatabaseMigrationServiceClient
        from mypy_boto3_dms.waiter import (
            EndpointDeletedWaiter,
            ReplicationInstanceAvailableWaiter,
            ReplicationInstanceDeletedWaiter,
            ReplicationTaskDeletedWaiter,
            ReplicationTaskReadyWaiter,
            ReplicationTaskRunningWaiter,
            ReplicationTaskStoppedWaiter,
            TestConnectionSucceedsWaiter,
        )
        
        client: DatabaseMigrationServiceClient = boto3.client("dms")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        endpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
        replication_instance_available_waiter: ReplicationInstanceAvailableWaiter = client.get_waiter("replication_instance_available")
        replication_instance_deleted_waiter: ReplicationInstanceDeletedWaiter = client.get_waiter("replication_instance_deleted")
        replication_task_deleted_waiter: ReplicationTaskDeletedWaiter = client.get_waiter("replication_task_deleted")
        replication_task_ready_waiter: ReplicationTaskReadyWaiter = client.get_waiter("replication_task_ready")
        replication_task_running_waiter: ReplicationTaskRunningWaiter = client.get_waiter("replication_task_running")
        replication_task_stopped_waiter: ReplicationTaskStoppedWaiter = client.get_waiter("replication_task_stopped")
        test_connection_succeeds_waiter: TestConnectionSucceedsWaiter = client.get_waiter("test_connection_succeeds")
        ```
        
        
        
        
        
        ### Typed dictionations
        
        `mypy_boto3_dms.type_defs` module contains structures and shapes assembled
        to typed dictionaries for additional type checking.
        
        ```python
        from mypy_boto3_dms.type_defs import (
            AccountQuotaTypeDef,
            ApplyPendingMaintenanceActionResponseTypeDef,
            AvailabilityZoneTypeDef,
            CancelReplicationTaskAssessmentRunResponseTypeDef,
            CertificateTypeDef,
            ConnectionTypeDef,
            CreateEndpointResponseTypeDef,
            CreateEventSubscriptionResponseTypeDef,
            CreateReplicationInstanceResponseTypeDef,
            CreateReplicationSubnetGroupResponseTypeDef,
            CreateReplicationTaskResponseTypeDef,
            DeleteCertificateResponseTypeDef,
            DeleteConnectionResponseTypeDef,
            DeleteEndpointResponseTypeDef,
            DeleteEventSubscriptionResponseTypeDef,
            DeleteReplicationInstanceResponseTypeDef,
            DeleteReplicationTaskAssessmentRunResponseTypeDef,
            DeleteReplicationTaskResponseTypeDef,
            DescribeAccountAttributesResponseTypeDef,
            DescribeApplicableIndividualAssessmentsResponseTypeDef,
            DescribeCertificatesResponseTypeDef,
            DescribeConnectionsResponseTypeDef,
            DescribeEndpointsResponseTypeDef,
            DescribeEndpointTypesResponseTypeDef,
            DescribeEventCategoriesResponseTypeDef,
            DescribeEventsResponseTypeDef,
            DescribeEventSubscriptionsResponseTypeDef,
            DescribeOrderableReplicationInstancesResponseTypeDef,
            DescribePendingMaintenanceActionsResponseTypeDef,
            DescribeRefreshSchemasStatusResponseTypeDef,
            DescribeReplicationInstancesResponseTypeDef,
            DescribeReplicationInstanceTaskLogsResponseTypeDef,
            DescribeReplicationSubnetGroupsResponseTypeDef,
            DescribeReplicationTaskAssessmentResultsResponseTypeDef,
            DescribeReplicationTaskAssessmentRunsResponseTypeDef,
            DescribeReplicationTaskIndividualAssessmentsResponseTypeDef,
            DescribeReplicationTasksResponseTypeDef,
            DescribeSchemasResponseTypeDef,
            DescribeTableStatisticsResponseTypeDef,
            DmsTransferSettingsTypeDef,
            DocDbSettingsTypeDef,
            DynamoDbSettingsTypeDef,
            ElasticsearchSettingsTypeDef,
            EndpointTypeDef,
            EventCategoryGroupTypeDef,
            EventSubscriptionTypeDef,
            EventTypeDef,
            FilterTypeDef,
            IBMDb2SettingsTypeDef,
            ImportCertificateResponseTypeDef,
            KafkaSettingsTypeDef,
            KinesisSettingsTypeDef,
            ListTagsForResourceResponseTypeDef,
            MicrosoftSQLServerSettingsTypeDef,
            ModifyEndpointResponseTypeDef,
            ModifyEventSubscriptionResponseTypeDef,
            ModifyReplicationInstanceResponseTypeDef,
            ModifyReplicationSubnetGroupResponseTypeDef,
            ModifyReplicationTaskResponseTypeDef,
            MongoDbSettingsTypeDef,
            MySQLSettingsTypeDef,
            NeptuneSettingsTypeDef,
            OracleSettingsTypeDef,
            OrderableReplicationInstanceTypeDef,
            PaginatorConfigTypeDef,
            PendingMaintenanceActionTypeDef,
            PostgreSQLSettingsTypeDef,
            RebootReplicationInstanceResponseTypeDef,
            RedshiftSettingsTypeDef,
            RefreshSchemasResponseTypeDef,
            RefreshSchemasStatusTypeDef,
            ReloadTablesResponseTypeDef,
            ReplicationInstanceTaskLogTypeDef,
            ReplicationInstanceTypeDef,
            ReplicationPendingModifiedValuesTypeDef,
            ReplicationSubnetGroupTypeDef,
            ReplicationTaskAssessmentResultTypeDef,
            ReplicationTaskAssessmentRunProgressTypeDef,
            ReplicationTaskAssessmentRunTypeDef,
            ReplicationTaskIndividualAssessmentTypeDef,
            ReplicationTaskStatsTypeDef,
            ReplicationTaskTypeDef,
            ResourcePendingMaintenanceActionsTypeDef,
            S3SettingsTypeDef,
            StartReplicationTaskAssessmentResponseTypeDef,
            StartReplicationTaskAssessmentRunResponseTypeDef,
            StartReplicationTaskResponseTypeDef,
            StopReplicationTaskResponseTypeDef,
            SubnetTypeDef,
            SupportedEndpointTypeTypeDef,
            SybaseSettingsTypeDef,
            TableStatisticsTypeDef,
            TableToReloadTypeDef,
            TagTypeDef,
            TestConnectionResponseTypeDef,
            VpcSecurityGroupMembershipTypeDef,
            WaiterConfigTypeDef,
        )
        
        def get_structure() -> AccountQuotaTypeDef:
            return {
              ...
            }
        ```
        
Keywords: boto3 dms type-annotations boto3-stubs mypy typeshed autocomplete auto-generated
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
