Examples

Index > Organizations > Examples

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

Client

Implicit type annotations

Can be used with boto3-stubs[organizations] package installed.

Write your Organizations code as usual, type checking and code completion should work out of the box.

# OrganizationsClient usage example

from boto3.session import Session


session = Session()

client = session.client("organizations")  # (1)
result = client.accept_handshake()  # (2)

1. client: OrganizationsClient
2. result: AcceptHandshakeResponseTypeDef

# ListAWSServiceAccessForOrganizationPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("organizations")  # (1)

paginator = client.get_paginator("list_aws_service_access_for_organization")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: OrganizationsClient
2. paginator: ListAWSServiceAccessForOrganizationPaginator
3. item: ListAWSServiceAccessForOrganizationResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[organizations] or a standalone mypy_boto3_organizations package, you have to explicitly specify client: OrganizationsClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# OrganizationsClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_organizations.client import OrganizationsClient
from mypy_boto3_organizations.type_defs import AcceptHandshakeResponseTypeDef
from mypy_boto3_organizations.type_defs import AcceptHandshakeRequestRequestTypeDef


session = Session()

client: OrganizationsClient = session.client("organizations")

kwargs: AcceptHandshakeRequestRequestTypeDef = {...}
result: AcceptHandshakeResponseTypeDef = client.accept_handshake(**kwargs)

# ListAWSServiceAccessForOrganizationPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_organizations.client import OrganizationsClient
from mypy_boto3_organizations.paginator import ListAWSServiceAccessForOrganizationPaginator
from mypy_boto3_organizations.type_defs import ListAWSServiceAccessForOrganizationResponseTypeDef


session = Session()
client: OrganizationsClient = session.client("organizations")

paginator: ListAWSServiceAccessForOrganizationPaginator = client.get_paginator("list_aws_service_access_for_organization")
for item in paginator.paginate(...):
    item: ListAWSServiceAccessForOrganizationResponseTypeDef
    print(item)