Skip to content

Examples#

Index > GuardDuty > Examples

Auto-generated documentation for GuardDuty type annotations stubs module types-aiobotocore-guardduty.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[guardduty] package installed.

Write your GuardDuty code as usual, type checking and code completion should work out of the box.

Client method usage example#

# GuardDutyClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("guardduty") as client:  # (1)
    result = await client.create_detector()  # (2)
  1. client: GuardDutyClient
  2. result: CreateDetectorResponseTypeDef

Paginator usage example#

# DescribeMalwareScansPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("guardduty") as client:  # (1)
    paginator = client.get_paginator("describe_malware_scans")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: GuardDutyClient
  2. paginator: DescribeMalwareScansPaginator
  3. item: DescribeMalwareScansResponseTypeDef

Explicit type annotations#

With types-aiobotocore-lite[guardduty] or a standalone types_aiobotocore_guardduty package, you have to explicitly specify client: GuardDutyClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example#

# GuardDutyClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_guardduty.client import GuardDutyClient
from types_aiobotocore_guardduty.type_defs import CreateDetectorResponseTypeDef
from types_aiobotocore_guardduty.type_defs import CreateDetectorRequestTypeDef


session = get_session()

async with session.create_client("guardduty") as client:
    client: GuardDutyClient
    kwargs: CreateDetectorRequestTypeDef = {...}
    result: CreateDetectorResponseTypeDef = await client.create_detector(**kwargs)

Paginator usage example#

# DescribeMalwareScansPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_guardduty.client import GuardDutyClient
from types_aiobotocore_guardduty.paginator import DescribeMalwareScansPaginator
from types_aiobotocore_guardduty.type_defs import DescribeMalwareScansResponseTypeDef


session = get_session()

async with session.create_client("guardduty") as client:
    client: GuardDutyClient
    paginator: DescribeMalwareScansPaginator = client.get_paginator("describe_malware_scans")
    async for item in paginator.paginate(...):
        item: DescribeMalwareScansResponseTypeDef
        print(item)