Skip to content

IAM module

Index > IAM

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

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 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

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("...").

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("...").

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

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").*.

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 boto3.resource("iam").*.

Usage example
from boto3.session import Session

from mypy_boto3_iam.service_resource import AccessKey

def get_resource() -> AccessKey:
    return Session().resource("iam").AccessKey(...)

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_iam.literals import AccessAdvisorUsageGranularityTypeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_iam.type_defs import AccessDetailTypeDef

def get_value() -> AccessDetailTypeDef:
    return {
        "ServiceName": ...,
        "ServiceNamespace": ...,
    }