Skip to content

Inspector module#

Index > Inspector

Auto-generated documentation for Inspector type annotations stubs module mypy-boto3-inspector.

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

From PyPI with pip#

Install boto3-stubs for Inspector service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

InspectorClient#

Type annotations and code completion for boto3.client("inspector") as InspectorClient boto3 documentation

# InspectorClient usage example

from boto3.session import Session

from mypy_boto3_inspector.client import InspectorClient

def get_client() -> InspectorClient:
    return Session().client("inspector")

Paginators#

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

# ListAssessmentRunAgentsPaginator usage example

from boto3.session import Session

from mypy_boto3_inspector.paginator import ListAssessmentRunAgentsPaginator

def get_list_assessment_run_agents_paginator() -> ListAssessmentRunAgentsPaginator:
    return Session().client("inspector").get_paginator("list_assessment_run_agents"))

Literals#

Type annotations for literals used in methods and schema.

# AgentHealthCodeType usage example

from mypy_boto3_inspector.literals import AgentHealthCodeType

def get_value() -> AgentHealthCodeType:
    return "IDLE"

Type definitions#

Type annotations for type definitions used in methods and schema.