Metadata-Version: 2.1
Name: mypy-boto3-organizations
Version: 1.17.35.0
Summary: Type annotations for boto3.Organizations 1.17.35 service, generated by mypy-boto3-buider 4.4.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-organizations
        
        [![PyPI - mypy-boto3-organizations](https://img.shields.io/pypi/v/mypy-boto3-organizations.svg?color=blue)](https://pypi.org/project/mypy-boto3-organizations)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-organizations.svg?color=blue)](https://pypi.org/project/mypy-boto3-organizations)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        
        ![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
        
        Type annotations for
        [boto3.Organizations 1.17.35](https://boto3.amazonaws.com/v1/documentation/api/1.17.35/reference/services/organizations.html#Organizations) service
        compatible with
        [VSCode](https://code.visualstudio.com/),
        [PyCharm](https://www.jetbrains.com/pycharm/),
        [Emacs](https://www.gnu.org/software/emacs/),
        [Sublime Text](https://www.sublimetext.com/),
        [mypy](https://github.com/python/mypy),
        [pyright](https://github.com/microsoft/pyright)
        and other tools.
        
        Generated by [mypy-boto3-buider 4.4.0](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
        
        See how it helps to find and fix potential bugs:
        
        ![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
        
        - [mypy-boto3-organizations](#mypy-boto3-organizations)
          - [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 `Organizations` service.
        
        ```bash
        python -m pip install boto3-stubs[organizations]
        ```
        
        ## 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[organizations]` in your environment: `python -m pip install 'boto3-stubs[organizations]'`
        
        Both type checking and auto-complete should work for `Organizations` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### PyCharm
        
        - Install `boto-stubs[organizations]` in your environment: `python -m pip install 'boto3-stubs[organizations]'`
        
        Both type checking and auto-complete should work for `Organizations` 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[organizations]` in your environment: `python -m pip install 'boto3-stubs[organizations]'`
        - Run `mypy` as usual
        
        Type checking should work for `Organizations` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### pyright
        
        - Install `pyright`: `yarn global add pyright`
        - Install `boto-stubs[organizations]` in your environment: `python -m pip install 'boto3-stubs[organizations]'`
        - Optionally, you can install `boto3-stubs` to `typings` folder.
        
        Type checking should work for `Organizations` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ## Explicit type annotations
        
        ### Client annotations
        
        `OrganizationsClient` provides annotations for `boto3.client("organizations")`.
        
        ```python
        import boto3
        
        from mypy_boto3_organizations import OrganizationsClient
        
        client: OrganizationsClient = boto3.client("organizations")
        
        # 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: OrganizationsClient = session.client("organizations")
        ```
        
        ### Paginators annotations
        
        `mypy_boto3_organizations.paginator` module contains type annotations for all paginators.
        
        ```python
        from mypy_boto3_organizations import OrganizationsClient
        from mypy_boto3_organizations.paginator import (
            ListAWSServiceAccessForOrganizationPaginator,
            ListAccountsPaginator,
            ListAccountsForParentPaginator,
            ListChildrenPaginator,
            ListCreateAccountStatusPaginator,
            ListDelegatedAdministratorsPaginator,
            ListDelegatedServicesForAccountPaginator,
            ListHandshakesForAccountPaginator,
            ListHandshakesForOrganizationPaginator,
            ListOrganizationalUnitsForParentPaginator,
            ListParentsPaginator,
            ListPoliciesPaginator,
            ListPoliciesForTargetPaginator,
            ListRootsPaginator,
            ListTagsForResourcePaginator,
            ListTargetsForPolicyPaginator,
        )
        
        client: OrganizationsClient = boto3.client("organizations")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        list_aws_service_access_for_organization_paginator: ListAWSServiceAccessForOrganizationPaginator = client.get_paginator("list_aws_service_access_for_organization")
        list_accounts_paginator: ListAccountsPaginator = client.get_paginator("list_accounts")
        list_accounts_for_parent_paginator: ListAccountsForParentPaginator = client.get_paginator("list_accounts_for_parent")
        list_children_paginator: ListChildrenPaginator = client.get_paginator("list_children")
        list_create_account_status_paginator: ListCreateAccountStatusPaginator = client.get_paginator("list_create_account_status")
        list_delegated_administrators_paginator: ListDelegatedAdministratorsPaginator = client.get_paginator("list_delegated_administrators")
        list_delegated_services_for_account_paginator: ListDelegatedServicesForAccountPaginator = client.get_paginator("list_delegated_services_for_account")
        list_handshakes_for_account_paginator: ListHandshakesForAccountPaginator = client.get_paginator("list_handshakes_for_account")
        list_handshakes_for_organization_paginator: ListHandshakesForOrganizationPaginator = client.get_paginator("list_handshakes_for_organization")
        list_organizational_units_for_parent_paginator: ListOrganizationalUnitsForParentPaginator = client.get_paginator("list_organizational_units_for_parent")
        list_parents_paginator: ListParentsPaginator = client.get_paginator("list_parents")
        list_policies_paginator: ListPoliciesPaginator = client.get_paginator("list_policies")
        list_policies_for_target_paginator: ListPoliciesForTargetPaginator = client.get_paginator("list_policies_for_target")
        list_roots_paginator: ListRootsPaginator = client.get_paginator("list_roots")
        list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
        list_targets_for_policy_paginator: ListTargetsForPolicyPaginator = client.get_paginator("list_targets_for_policy")
        ```
        
        
        
        
        
        
        
        ### Typed dictionations
        
        `mypy_boto3_organizations.type_defs` module contains structures and shapes assembled
        to typed dictionaries for additional type checking.
        
        ```python
        from mypy_boto3_organizations.type_defs import (
            AccountTypeDef,
            ChildTypeDef,
            CreateAccountStatusTypeDef,
            DelegatedAdministratorTypeDef,
            DelegatedServiceTypeDef,
            EffectivePolicyTypeDef,
            EnabledServicePrincipalTypeDef,
            HandshakePartyTypeDef,
            HandshakeTypeDef,
            OrganizationTypeDef,
            OrganizationalUnitTypeDef,
            ParentTypeDef,
            PolicySummaryTypeDef,
            PolicyTargetSummaryTypeDef,
            PolicyTypeDef,
            PolicyTypeSummaryTypeDef,
            RootTypeDef,
            TagTypeDef,
            AcceptHandshakeResponseTypeDef,
            CancelHandshakeResponseTypeDef,
            CreateAccountResponseTypeDef,
            CreateGovCloudAccountResponseTypeDef,
            CreateOrganizationResponseTypeDef,
            CreateOrganizationalUnitResponseTypeDef,
            CreatePolicyResponseTypeDef,
            DeclineHandshakeResponseTypeDef,
            DescribeAccountResponseTypeDef,
            DescribeCreateAccountStatusResponseTypeDef,
            DescribeEffectivePolicyResponseTypeDef,
            DescribeHandshakeResponseTypeDef,
            DescribeOrganizationResponseTypeDef,
            DescribeOrganizationalUnitResponseTypeDef,
            DescribePolicyResponseTypeDef,
            HandshakeResourceTypeDef,
            DisablePolicyTypeResponseTypeDef,
            EnableAllFeaturesResponseTypeDef,
            EnablePolicyTypeResponseTypeDef,
            HandshakeFilterTypeDef,
            InviteAccountToOrganizationResponseTypeDef,
            ListAWSServiceAccessForOrganizationResponseTypeDef,
            ListAccountsForParentResponseTypeDef,
            ListAccountsResponseTypeDef,
            ListChildrenResponseTypeDef,
            ListCreateAccountStatusResponseTypeDef,
            ListDelegatedAdministratorsResponseTypeDef,
            ListDelegatedServicesForAccountResponseTypeDef,
            ListHandshakesForAccountResponseTypeDef,
            ListHandshakesForOrganizationResponseTypeDef,
            ListOrganizationalUnitsForParentResponseTypeDef,
            ListParentsResponseTypeDef,
            ListPoliciesForTargetResponseTypeDef,
            ListPoliciesResponseTypeDef,
            ListRootsResponseTypeDef,
            ListTagsForResourceResponseTypeDef,
            ListTargetsForPolicyResponseTypeDef,
            PaginatorConfigTypeDef,
            UpdateOrganizationalUnitResponseTypeDef,
            UpdatePolicyResponseTypeDef,
        )
        
        def get_structure() -> AccountTypeDef:
            return {
              ...
            }
        ```
        
Keywords: boto3 organizations 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
