Skip to content

SecurityHub module#

Index > SecurityHub

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

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

From PyPI with pip#

Install boto3-stubs for SecurityHub service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SecurityHubClient#

Type annotations and code completion for boto3.client("securityhub") as SecurityHubClient boto3 documentation

# SecurityHubClient usage example

from boto3.session import Session

from mypy_boto3_securityhub.client import SecurityHubClient

def get_client() -> SecurityHubClient:
    return Session().client("securityhub")

Paginators#

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

# DescribeActionTargetsPaginator usage example

from boto3.session import Session

from mypy_boto3_securityhub.paginator import DescribeActionTargetsPaginator

def get_describe_action_targets_paginator() -> DescribeActionTargetsPaginator:
    return Session().client("securityhub").get_paginator("describe_action_targets"))

Literals#

Type annotations for literals used in methods and schemas.

# AdminStatusType usage example

from mypy_boto3_securityhub.literals import AdminStatusType

def get_value() -> AdminStatusType:
    return "DISABLE_IN_PROGRESS"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceptAdministratorInvitationRequestRequestTypeDef usage example

from mypy_boto3_securityhub.type_defs import AcceptAdministratorInvitationRequestRequestTypeDef

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