Skip to content

IAM module#

Index > IAM

Auto-generated documentation for IAM type annotations stubs module mypy-boto3-iam.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add IAM service.
  4. Use provided commands to install generated packages.

VSCode extension#

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

Click Modify and select boto3 common and IAM.

From PyPI with pip#

Install boto3-stubs for IAM service.

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

# 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[iam]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

IAMClient#

Type annotations and code completion for boto3.client("iam") as IAMClient boto3 documentation

# IAMClient usage example

from boto3.session import Session

from mypy_boto3_iam.client import IAMClient

def get_client() -> IAMClient:
    return Session().client("iam")

Paginators#

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

# GetAccountAuthorizationDetailsPaginator usage example

from boto3.session import Session

from mypy_boto3_iam.paginator import GetAccountAuthorizationDetailsPaginator

def get_get_account_authorization_details_paginator() -> GetAccountAuthorizationDetailsPaginator:
    return Session().client("iam").get_paginator("get_account_authorization_details"))

Waiters#

Type annotations and code completion for waiters from boto3.client("iam").get_waiter("...").

# InstanceProfileExistsWaiter usage example

from boto3.session import Session

from mypy_boto3_iam.waiter import InstanceProfileExistsWaiter

def get_instance_profile_exists_waiter() -> InstanceProfileExistsWaiter:
    return Session().client("iam").get_waiter("instance_profile_exists")

IAMServiceResource#

Type annotations and code completion for boto3.resource("iam") as IAMServiceResource boto3 documentation

# IAMServiceResource usage example

from boto3.session import Session

from mypy_boto3_iam.service_resource import IAMServiceResource

def get_iam_resource() -> IAMServiceResource:
    return Session().resource("iam")

Collections#

Type annotations and code completion for collections from boto3.resource("iam").*.

# ServiceResourceGroupsCollection usage example

from boto3.session import Session

from mypy_boto3_iam.service_resource import ServiceResourceGroupsCollection

def get_collection() -> ServiceResourceGroupsCollection:
    return Session().resource("iam").groups

Resources#

Type annotations and code completion for additional resources from session.resource("iam").*.

# AccessKey usage example

from mypy_boto3_iam.service_resource import AccessKey

def get_resource() -> AccessKey:
    return resource.AccessKey(...)

Literals#

Type annotations for literals used in methods and schema.

# AccessAdvisorUsageGranularityTypeType usage example

from mypy_boto3_iam.literals import AccessAdvisorUsageGranularityTypeType

def get_value() -> AccessAdvisorUsageGranularityTypeType:
    return "ACTION_LEVEL"

Type definitions#

Type annotations for type definitions used in methods and schema.