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-aioboto3[iam] package installed.

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

# IAMClient usage example

from aioboto3.session import Session


session = Session()

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

1. client: IAMClient
2. result: EmptyResponseMetadataTypeDef

# GetAccountAuthorizationDetailsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.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

# InstanceProfileExistsWaiter usage example

from aioboto3.session import Session


session = Session()

async with session.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-aioboto3-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.

# IAMClient usage example with type annotations

from aioboto3.session import Session

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


session = Session()

client: IAMClient
async with session.client("iam") as client:  # (1)
    kwargs: AddClientIDToOpenIDConnectProviderRequestRequestTypeDef = {...}  # (2)
    result: EmptyResponseMetadataTypeDef = await client.add_client_id_to_open_id_connect_provider(**kwargs)  # (3)

1. client: IAMClient
2. kwargs: AddClientIDToOpenIDConnectProviderRequestRequestTypeDef
3. result: EmptyResponseMetadataTypeDef

# GetAccountAuthorizationDetailsPaginator usage example with type annotations

from aioboto3.session import Session

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


session = Session()

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

1. client: IAMClient
2. paginator: GetAccountAuthorizationDetailsPaginator
3. item: GetAccountAuthorizationDetailsResponseTypeDef

# InstanceProfileExistsWaiter usage example with type annotations

from aioboto3.session import Session

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


session = Session()

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

1. client: IAMClient
2. waiter: InstanceProfileExistsWaiter

Service Resource

Implicit type annotations

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

# IAMServiceResource usage example

from aioboto3.session import Session


session = Session()

async with session.resource("iam") as resource:  # (1)
    result = resource.AccessKey()  # (2)

1. resource: IAMServiceResource
2. result:

# ServiceResourceGroupsCollection usage example

from aioboto3.session import Session


session = Session()
resource = session.resource("iam")  # (1)

collection = resource.groups  # (2)
for item in collection:
    print(item)  # (3)

1. resource: IAMServiceResource
2. collection: IAMServiceResource
3. item: Group

Explicit type annotations

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

# IAMServiceResource usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_iam.service_resource import IAMServiceResource
from types_aiobotocore_iam.service_resource import AccessKey


session = Session()

resource: IAMServiceResource
async with session.resource("iam") as resource:  # (1)
    result: AccessKey = resource.AccessKey() # (2)

1. resource: IAMServiceResource
2. result:

# ServiceResourceGroupsCollection usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_iam.service_resource import IAMServiceResource
from types_aiobotocore_iam.service_resource import ServiceResourceGroupsCollection
from types_aiobotocore_iam.service_resource import Group


session = Session()

resource: IAMServiceResource
async with session.resource("iam") as resource:  # (1)
    collection: ServiceResourceGroupsCollection = resource.groups  # (2)
    for item in collection:
        item: Group
        print(item)  # (3)

1. resource: IAMServiceResource
2. collection: IAMServiceResource
3. item: Group