# mypy-boto3-securityhub
[![PyPI - mypy-boto3-securityhub](https://img.shields.io/pypi/v/mypy-boto3-securityhub.svg?color=blue)](https://pypi.org/project/mypy-boto3-securityhub)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-securityhub.svg?color=blue)](https://pypi.org/project/mypy-boto3-securityhub)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
Type annotations for
[boto3.SecurityHub 1.14.52](https://boto3.amazonaws.com/v1/documentation/api/1.14.52/reference/services/securityhub.html#SecurityHub) service
compatible with [mypy](https://github.com/python/mypy), [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/) and other tools.
Generated by [mypy-boto3-buider 2.3.1](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
## How to install
Make sure you have [mypy](https://github.com/python/mypy) installed and activated in your IDE.
Install `boto3-stubs` for `SecurityHub` service.
```bash
python -m pip install boto3-stubs[securityhub]
```
## How to use
### Client annotations
`SecurityHubClient` provides annotations for `boto3.client("securityhub")`.
```python
import boto3
from mypy_boto3_securityhub import SecurityHubClient
from mypy_boto3_securityhub.paginator import (
GetEnabledStandardsPaginator,
GetFindingsPaginator,
GetInsightsPaginator,
ListEnabledProductsForImportPaginator,
ListInvitationsPaginator,
ListMembersPaginator,
)
from mypy_boto3_securityhub.type_defs import ActionTargetTypeDef, ...
client: SecurityHubClient = boto3.client("securityhub")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: SecurityHubClient = session.client("securityhub")
```
### Paginators annotations
`mypy_boto3_securityhub.paginator` module contains type annotations for all paginators.
```python
client: SecurityHubClient = boto3.client("securityhub")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_enabled_standards_paginator: GetEnabledStandardsPaginator = client.get_paginator("get_enabled_standards")
get_findings_paginator: GetFindingsPaginator = client.get_paginator("get_findings")
get_insights_paginator: GetInsightsPaginator = client.get_paginator("get_insights")
list_enabled_products_for_import_paginator: ListEnabledProductsForImportPaginator = client.get_paginator("list_enabled_products_for_import")
list_invitations_paginator: ListInvitationsPaginator = client.get_paginator("list_invitations")
list_members_paginator: ListMembersPaginator = client.get_paginator("list_members")
```
### Typed dictionations
`mypy_boto3_securityhub.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
def get_structure() -> ActionTargetTypeDef:
return {
...
}
```
## Dynamic type annotations
`mypy_boto3` command generates `boto3.client/resource` type annotations for
`mypy_boto3_securityhub` and other installed services.
```bash
# Run this command after you add or remove service packages
python -m mypy_boto3
```
Generated type annotations provide overloads for `boto3.client` and `boto3.resource`,
`boto3.Session.client` and `boto3.Session.resource` functions,
so explicit type annotations are not needed.
- `mypy` supports function overloads as expected
- `PyCharm` also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
- `VSCode` does not currently support function overloads, use explicit type annotations
```python
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("securityhub")
session_client = boto3.Session().client("securityhub")
```