Inspector module#
Index > Inspector
Auto-generated documentation for Inspector type annotations stubs module mypy-boto3-inspector.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
Inspector
service. - 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 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"))
- ListAssessmentRunAgentsPaginator
- ListAssessmentRunsPaginator
- ListAssessmentTargetsPaginator
- ListAssessmentTemplatesPaginator
- ListEventSubscriptionsPaginator
- ListExclusionsPaginator
- ListFindingsPaginator
- ListRulesPackagesPaginator
- PreviewAgentsPaginator
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"
- AgentHealthCodeType
- AgentHealthType
- AssessmentRunNotificationSnsStatusCodeType
- AssessmentRunStateType
- AssetTypeType
- FailedItemErrorCodeType
- InspectorEventType
- ListAssessmentRunAgentsPaginatorName
- ListAssessmentRunsPaginatorName
- ListAssessmentTargetsPaginatorName
- ListAssessmentTemplatesPaginatorName
- ListEventSubscriptionsPaginatorName
- ListExclusionsPaginatorName
- ListFindingsPaginatorName
- ListRulesPackagesPaginatorName
- LocaleType
- PreviewAgentsPaginatorName
- PreviewStatusType
- ReportFileFormatType
- ReportStatusType
- ReportTypeType
- ScopeTypeType
- SeverityType
- StopActionType
- InspectorServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AttributeTypeDef
- FailedItemDetailsTypeDef
- ResponseMetadataTypeDef
- AgentFilterTypeDef
- AgentPreviewTypeDef
- TelemetryMetadataTypeDef
- DurationRangeTypeDef
- AssessmentRunNotificationTypeDef
- AssessmentRunStateChangeTypeDef
- AssessmentTargetFilterTypeDef
- AssessmentTargetTypeDef
- TagTypeDef
- CreateAssessmentTargetRequestRequestTypeDef
- CreateExclusionsPreviewRequestRequestTypeDef
- ResourceGroupTagTypeDef
- DeleteAssessmentRunRequestRequestTypeDef
- DeleteAssessmentTargetRequestRequestTypeDef
- DeleteAssessmentTemplateRequestRequestTypeDef
- DescribeAssessmentRunsRequestRequestTypeDef
- DescribeAssessmentTargetsRequestRequestTypeDef
- DescribeAssessmentTemplatesRequestRequestTypeDef
- DescribeExclusionsRequestRequestTypeDef
- DescribeFindingsRequestRequestTypeDef
- DescribeResourceGroupsRequestRequestTypeDef
- DescribeRulesPackagesRequestRequestTypeDef
- RulesPackageTypeDef
- EventSubscriptionTypeDef
- ScopeTypeDef
- InspectorServiceAttributesTypeDef
- GetAssessmentReportRequestRequestTypeDef
- GetExclusionsPreviewRequestRequestTypeDef
- GetTelemetryMetadataRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListEventSubscriptionsRequestRequestTypeDef
- ListExclusionsRequestRequestTypeDef
- ListRulesPackagesRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PrivateIpTypeDef
- SecurityGroupTypeDef
- PreviewAgentsRequestRequestTypeDef
- RegisterCrossAccountAccessRoleRequestRequestTypeDef
- RemoveAttributesFromFindingsRequestRequestTypeDef
- StartAssessmentRunRequestRequestTypeDef
- StopAssessmentRunRequestRequestTypeDef
- SubscribeToEventRequestRequestTypeDef
- TimestampTypeDef
- UnsubscribeFromEventRequestRequestTypeDef
- UpdateAssessmentTargetRequestRequestTypeDef
- AddAttributesToFindingsRequestRequestTypeDef
- AssessmentTemplateTypeDef
- CreateAssessmentTemplateRequestRequestTypeDef
- AddAttributesToFindingsResponseTypeDef
- CreateAssessmentTargetResponseTypeDef
- CreateAssessmentTemplateResponseTypeDef
- CreateExclusionsPreviewResponseTypeDef
- CreateResourceGroupResponseTypeDef
- DescribeCrossAccountAccessRoleResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetAssessmentReportResponseTypeDef
- ListAssessmentRunsResponseTypeDef
- ListAssessmentTargetsResponseTypeDef
- ListAssessmentTemplatesResponseTypeDef
- ListExclusionsResponseTypeDef
- ListFindingsResponseTypeDef
- ListRulesPackagesResponseTypeDef
- RemoveAttributesFromFindingsResponseTypeDef
- StartAssessmentRunResponseTypeDef
- ListAssessmentRunAgentsRequestRequestTypeDef
- PreviewAgentsResponseTypeDef
- AssessmentRunAgentTypeDef
- GetTelemetryMetadataResponseTypeDef
- AssessmentTemplateFilterTypeDef
- AssessmentRunTypeDef
- ListAssessmentTargetsRequestRequestTypeDef
- DescribeAssessmentTargetsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- SetTagsForResourceRequestRequestTypeDef
- CreateResourceGroupRequestRequestTypeDef
- ResourceGroupTypeDef
- DescribeRulesPackagesResponseTypeDef
- SubscriptionTypeDef
- ExclusionPreviewTypeDef
- ExclusionTypeDef
- ListAssessmentRunAgentsRequestPaginateTypeDef
- ListAssessmentTargetsRequestPaginateTypeDef
- ListEventSubscriptionsRequestPaginateTypeDef
- ListExclusionsRequestPaginateTypeDef
- ListRulesPackagesRequestPaginateTypeDef
- PreviewAgentsRequestPaginateTypeDef
- NetworkInterfaceTypeDef
- TimestampRangeTypeDef
- DescribeAssessmentTemplatesResponseTypeDef
- ListAssessmentRunAgentsResponseTypeDef
- ListAssessmentTemplatesRequestPaginateTypeDef
- ListAssessmentTemplatesRequestRequestTypeDef
- DescribeAssessmentRunsResponseTypeDef
- DescribeResourceGroupsResponseTypeDef
- ListEventSubscriptionsResponseTypeDef
- GetExclusionsPreviewResponseTypeDef
- DescribeExclusionsResponseTypeDef
- AssetAttributesTypeDef
- AssessmentRunFilterTypeDef
- FindingFilterTypeDef
- FindingTypeDef
- ListAssessmentRunsRequestPaginateTypeDef
- ListAssessmentRunsRequestRequestTypeDef
- ListFindingsRequestPaginateTypeDef
- ListFindingsRequestRequestTypeDef
- DescribeFindingsResponseTypeDef