Skip to content

Organizations module#

Index > Organizations

Auto-generated documentation for Organizations type annotations stubs module mypy-boto3-organizations.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Organizations.

From PyPI with pip#

Install boto3-stubs for Organizations service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[organizations]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[organizations]'

# standalone installation
python -m pip install mypy-boto3-organizations

How to uninstall#

python -m pip uninstall -y mypy-boto3-organizations


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("organizations") as OrganizationsClient boto3 documentation

# OrganizationsClient usage example

from boto3.session import Session

from mypy_boto3_organizations.client import OrganizationsClient

def get_client() -> OrganizationsClient:
    return Session().client("organizations")


Type annotations and code completion for paginators from boto3.client("organizations").get_paginator("...").

# ListAWSServiceAccessForOrganizationPaginator usage example

from boto3.session import Session

from mypy_boto3_organizations.paginator import ListAWSServiceAccessForOrganizationPaginator

def get_list_aws_service_access_for_organization_paginator() -> ListAWSServiceAccessForOrganizationPaginator:
    return Session().client("organizations").get_paginator("list_aws_service_access_for_organization"))


Type annotations for literals used in methods and schemas.

# AccountJoinedMethodType usage example

from mypy_boto3_organizations.literals import AccountJoinedMethodType

def get_value() -> AccountJoinedMethodType:
    return "CREATED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceptHandshakeRequestRequestTypeDef usage example

from mypy_boto3_organizations.type_defs import AcceptHandshakeRequestRequestTypeDef

def get_value() -> AcceptHandshakeRequestRequestTypeDef:
    return {
        "HandshakeId": ...,