Metadata-Version: 2.1
Name: mypy-boto3-ds
Version: 1.14.63.0
Summary: Type annotations for boto3.DirectoryService 1.14.63 service, generated by mypy-boto3-buider 3.1.0
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-ds
        
        [![PyPI - mypy-boto3-ds](https://img.shields.io/pypi/v/mypy-boto3-ds.svg?color=blue)](https://pypi.org/project/mypy-boto3-ds)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ds.svg?color=blue)](https://pypi.org/project/mypy-boto3-ds)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        
        Type annotations for
        [boto3.DirectoryService 1.14.63](https://boto3.amazonaws.com/v1/documentation/api/1.14.63/reference/services/ds.html#DirectoryService) 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.1.0](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
        
        - [mypy-boto3-ds](#mypy-boto3-ds)
          - [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 `DirectoryService` service.
        
        ```bash
        python -m pip install boto3-stubs[ds]
        ```
        
        ## 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[ds]` in your environment: `python -m pip install 'boto3-stubs[ds]'`
        
        Both type checking and auto-complete should work for `DirectoryService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### PyCharm
        
        - Install `boto-stubs[ds]` in your environment: `python -m pip install 'boto3-stubs[ds]'`
        
        Both type checking and auto-complete should work for `DirectoryService` 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[ds]` in your environment: `python -m pip install 'boto3-stubs[ds]'`
        - Run `mypy` as usual
        
        Type checking should work for `DirectoryService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### pyright
        
        - Install `pyright`: `yarn global add pyright`
        - Install `boto-stubs[ds]` in your environment: `python -m pip install 'boto3-stubs[ds]'`
        - Optionally, you can install `boto3-stubs` to `typings` folder.
        
        Type checking should work for `DirectoryService` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ## Explicit type annotations
        
        ### Client annotations
        
        `DirectoryServiceClient` provides annotations for `boto3.client("ds")`.
        
        ```python
        import boto3
        
        from mypy_boto3_ds import DirectoryServiceClient
        
        client: DirectoryServiceClient = boto3.client("ds")
        
        # 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: DirectoryServiceClient = session.client("ds")
        ```
        
        ### Paginators annotations
        
        `mypy_boto3_ds.paginator` module contains type annotations for all paginators.
        
        ```python
        from mypy_boto3_ds import DirectoryServiceClient
        from mypy_boto3_ds.paginator import (
            DescribeDirectoriesPaginator,
            DescribeDomainControllersPaginator,
            DescribeSharedDirectoriesPaginator,
            DescribeSnapshotsPaginator,
            DescribeTrustsPaginator,
            ListIpRoutesPaginator,
            ListLogSubscriptionsPaginator,
            ListSchemaExtensionsPaginator,
            ListTagsForResourcePaginator,
        )
        
        client: DirectoryServiceClient = boto3.client("ds")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        describe_directories_paginator: DescribeDirectoriesPaginator = client.get_paginator("describe_directories")
        describe_domain_controllers_paginator: DescribeDomainControllersPaginator = client.get_paginator("describe_domain_controllers")
        describe_shared_directories_paginator: DescribeSharedDirectoriesPaginator = client.get_paginator("describe_shared_directories")
        describe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots")
        describe_trusts_paginator: DescribeTrustsPaginator = client.get_paginator("describe_trusts")
        list_ip_routes_paginator: ListIpRoutesPaginator = client.get_paginator("list_ip_routes")
        list_log_subscriptions_paginator: ListLogSubscriptionsPaginator = client.get_paginator("list_log_subscriptions")
        list_schema_extensions_paginator: ListSchemaExtensionsPaginator = client.get_paginator("list_schema_extensions")
        list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
        ```
        
        
        
        
        
        
        
        ### Typed dictionations
        
        `mypy_boto3_ds.type_defs` module contains structures and shapes assembled
        to typed dictionaries for additional type checking.
        
        ```python
        from mypy_boto3_ds.type_defs import (
            AcceptSharedDirectoryResultTypeDef,
            AttributeTypeDef,
            CertificateInfoTypeDef,
            CertificateTypeDef,
            ComputerTypeDef,
            ConditionalForwarderTypeDef,
            ConnectDirectoryResultTypeDef,
            CreateAliasResultTypeDef,
            CreateComputerResultTypeDef,
            CreateDirectoryResultTypeDef,
            CreateMicrosoftADResultTypeDef,
            CreateSnapshotResultTypeDef,
            CreateTrustResultTypeDef,
            DeleteDirectoryResultTypeDef,
            DeleteSnapshotResultTypeDef,
            DeleteTrustResultTypeDef,
            DescribeCertificateResultTypeDef,
            DescribeConditionalForwardersResultTypeDef,
            DescribeDirectoriesResultTypeDef,
            DescribeDomainControllersResultTypeDef,
            DescribeEventTopicsResultTypeDef,
            DescribeLDAPSSettingsResultTypeDef,
            DescribeSharedDirectoriesResultTypeDef,
            DescribeSnapshotsResultTypeDef,
            DescribeTrustsResultTypeDef,
            DirectoryConnectSettingsDescriptionTypeDef,
            DirectoryConnectSettingsTypeDef,
            DirectoryDescriptionTypeDef,
            DirectoryLimitsTypeDef,
            DirectoryVpcSettingsDescriptionTypeDef,
            DirectoryVpcSettingsTypeDef,
            DomainControllerTypeDef,
            EventTopicTypeDef,
            GetDirectoryLimitsResultTypeDef,
            GetSnapshotLimitsResultTypeDef,
            IpRouteInfoTypeDef,
            IpRouteTypeDef,
            LDAPSSettingInfoTypeDef,
            ListCertificatesResultTypeDef,
            ListIpRoutesResultTypeDef,
            ListLogSubscriptionsResultTypeDef,
            ListSchemaExtensionsResultTypeDef,
            ListTagsForResourceResultTypeDef,
            LogSubscriptionTypeDef,
            OwnerDirectoryDescriptionTypeDef,
            PaginatorConfigTypeDef,
            RadiusSettingsTypeDef,
            RegisterCertificateResultTypeDef,
            RejectSharedDirectoryResultTypeDef,
            SchemaExtensionInfoTypeDef,
            SharedDirectoryTypeDef,
            ShareDirectoryResultTypeDef,
            ShareTargetTypeDef,
            SnapshotLimitsTypeDef,
            SnapshotTypeDef,
            StartSchemaExtensionResultTypeDef,
            TagTypeDef,
            TrustTypeDef,
            UnshareDirectoryResultTypeDef,
            UnshareTargetTypeDef,
            UpdateTrustResultTypeDef,
            VerifyTrustResultTypeDef,
        )
        
        def get_structure() -> AttributeTypeDef:
            return {
              ...
            }
        ```
        
Keywords: boto3 ds 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 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
