Skip to content

Examples#

Index > IAM > Examples

Auto-generated documentation for IAM type annotations stubs module types-aiobotocore-iam.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[iam] package installed.

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

Client method usage example#

# IAMClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("iam") as client:  # (1)
    result = await client.add_client_id_to_open_id_connect_provider()  # (2)
  1. client: IAMClient
  2. result: EmptyResponseMetadataTypeDef

Paginator usage example#

# GetAccountAuthorizationDetailsPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("iam") as client:  # (1)
    paginator = client.get_paginator("get_account_authorization_details")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: IAMClient
  2. paginator: GetAccountAuthorizationDetailsPaginator
  3. item: GetAccountAuthorizationDetailsResponseTypeDef

Waiter usage example#

# InstanceProfileExistsWaiter usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("iam") as client:  # (1)
    waiter = client.get_waiter("instance_profile_exists")  # (2)
    await waiter.wait(...)
  1. client: IAMClient
  2. waiter: InstanceProfileExistsWaiter

Explicit type annotations#

With types-aiobotocore-lite[iam] or a standalone types_aiobotocore_iam package, you have to explicitly specify client: IAMClient 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.

Client method usage example#

# IAMClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_iam.client import IAMClient
from types_aiobotocore_iam.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_iam.type_defs import AddClientIDToOpenIDConnectProviderRequestTypeDef


session = get_session()

async with session.create_client("iam") as client:
    client: IAMClient
    kwargs: AddClientIDToOpenIDConnectProviderRequestTypeDef = {...}
    result: EmptyResponseMetadataTypeDef = await client.add_client_id_to_open_id_connect_provider(**kwargs)

Paginator usage example#

# GetAccountAuthorizationDetailsPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_iam.client import IAMClient
from types_aiobotocore_iam.paginator import GetAccountAuthorizationDetailsPaginator
from types_aiobotocore_iam.type_defs import GetAccountAuthorizationDetailsResponseTypeDef


session = get_session()

async with session.create_client("iam") as client:
    client: IAMClient
    paginator: GetAccountAuthorizationDetailsPaginator = client.get_paginator("get_account_authorization_details")
    async for item in paginator.paginate(...):
        item: GetAccountAuthorizationDetailsResponseTypeDef
        print(item)

Waiter usage example#

# InstanceProfileExistsWaiter usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_iam.client import IAMClient
from types_aiobotocore_iam.waiter import InstanceProfileExistsWaiter


session = get_session()

async with session.create_client("iam") as client:
    client: IAMClient
    waiter: InstanceProfileExistsWaiter = client.get_waiter("instance_profile_exists")
    await waiter.wait(...)