Examples

Index > SecurityHub > Examples

Auto-generated documentation for SecurityHub type annotations stubs module mypy-boto3-securityhub.

Client

Implicit type annotations

Can be used with boto3-stubs[securityhub] package installed.

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

Client method usage example

# SecurityHubClient usage example

from boto3.session import Session


session = Session()

client = session.client("securityhub")  # (1)
result = client.batch_delete_automation_rules()  # (2)

1. client: SecurityHubClient
2. result: BatchDeleteAutomationRulesResponseTypeDef

Paginator usage example

# DescribeActionTargetsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("securityhub")  # (1)

paginator = client.get_paginator("describe_action_targets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SecurityHubClient
2. paginator: DescribeActionTargetsPaginator
3. item: DescribeActionTargetsResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[securityhub] or a standalone mypy_boto3_securityhub package, you have to explicitly specify client: SecurityHubClient 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

# SecurityHubClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_securityhub.client import SecurityHubClient
from mypy_boto3_securityhub.type_defs import BatchDeleteAutomationRulesResponseTypeDef
from mypy_boto3_securityhub.type_defs import BatchDeleteAutomationRulesRequestTypeDef


session = Session()

client: SecurityHubClient = session.client("securityhub")

kwargs: BatchDeleteAutomationRulesRequestTypeDef = {...}
result: BatchDeleteAutomationRulesResponseTypeDef = client.batch_delete_automation_rules(**kwargs)

Paginator usage example

# DescribeActionTargetsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_securityhub.client import SecurityHubClient
from mypy_boto3_securityhub.paginator import DescribeActionTargetsPaginator
from mypy_boto3_securityhub.type_defs import DescribeActionTargetsResponseTypeDef


session = Session()
client: SecurityHubClient = session.client("securityhub")

paginator: DescribeActionTargetsPaginator = client.get_paginator("describe_action_targets")
for item in paginator.paginate(...):
    item: DescribeActionTargetsResponseTypeDef
    print(item)