Skip to content

GuardDuty module#

Index > GuardDuty

Auto-generated documentation for GuardDuty type annotations stubs module mypy-boto3-guardduty.

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

From PyPI with pip#

Install boto3-stubs for GuardDuty service.

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

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

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("guardduty") as GuardDutyClient boto3 documentation

# GuardDutyClient usage example

from boto3.session import Session

from mypy_boto3_guardduty.client import GuardDutyClient

def get_client() -> GuardDutyClient:
    return Session().client("guardduty")


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

# DescribeMalwareScansPaginator usage example

from boto3.session import Session

from mypy_boto3_guardduty.paginator import DescribeMalwareScansPaginator

def get_describe_malware_scans_paginator() -> DescribeMalwareScansPaginator:
    return Session().client("guardduty").get_paginator("describe_malware_scans"))


Type annotations for literals used in methods and schemas.

# AdminStatusType usage example

from mypy_boto3_guardduty.literals import AdminStatusType

def get_value() -> AdminStatusType:

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceptAdministratorInvitationRequestRequestTypeDef usage example

from mypy_boto3_guardduty.type_defs import AcceptAdministratorInvitationRequestRequestTypeDef

def get_value() -> AcceptAdministratorInvitationRequestRequestTypeDef:
    return {
        "DetectorId": ...,
        "AdministratorId": ...,
        "InvitationId": ...,