<a id="mypy-boto3-securityhub"></a>
# 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/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-securityhub?color=blue)](https://pypistats.org/packages/mypy-boto3-securityhub)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.SecurityHub 1.18.10](https://boto3.amazonaws.com/v1/documentation/api/1.18.10/reference/services/securityhub.html#SecurityHub)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 5.1.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-securityhub docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_securityhub/)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-securityhub](#mypy-boto3-securityhub)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `SecurityHub` service.
```bash
python -m pip install boto3-stubs[securityhub]
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[securityhub]` in your environment:
`python -m pip install 'boto3-stubs[securityhub]'`
Both type checking and auto-complete should work for `SecurityHub` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[securityhub]` in your environment:
`python -m pip install 'boto3-stubs[securityhub]'`
Both type checking and auto-complete should work for `SecurityHub` service. No
explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
`boto3-stubs` submodules.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[securityhub]` in your environment:
`python -m pip install 'boto3-stubs[securityhub]'`
- Run `mypy` as usual
Type checking should work for `SecurityHub` service. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[securityhub]` in your environment:
`python -m pip install 'boto3-stubs[securityhub]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `SecurityHub` service. No explicit type
annotations required, write your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`SecurityHubClient` provides annotations for `boto3.client("securityhub")`.
```python
import boto3
from mypy_boto3_securityhub import SecurityHubClient
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")
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_securityhub.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_securityhub import SecurityHubClient
from mypy_boto3_securityhub.paginator import (
GetEnabledStandardsPaginator,
GetFindingsPaginator,
GetInsightsPaginator,
ListEnabledProductsForImportPaginator,
ListInvitationsPaginator,
ListMembersPaginator,
)
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")
```
<a id="literals"></a>
### Literals
`mypy_boto3_securityhub.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_securityhub.literals import (
AdminStatusType,
AwsIamAccessKeyStatusType,
ComplianceStatusType,
ControlStatusType,
DateRangeUnitType,
GetEnabledStandardsPaginatorName,
GetFindingsPaginatorName,
GetInsightsPaginatorName,
IntegrationTypeType,
ListEnabledProductsForImportPaginatorName,
ListInvitationsPaginatorName,
ListMembersPaginatorName,
MalwareStateType,
MalwareTypeType,
MapFilterComparisonType,
NetworkDirectionType,
PartitionType,
RecordStateType,
SeverityLabelType,
SeverityRatingType,
SortOrderType,
StandardsStatusType,
StringFilterComparisonType,
ThreatIntelIndicatorCategoryType,
ThreatIntelIndicatorTypeType,
VerificationStateType,
WorkflowStateType,
WorkflowStatusType,
)
def check_value(value: AdminStatusType) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_securityhub.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_securityhub.type_defs import (
AcceptAdministratorInvitationRequestRequestTypeDef,
AcceptInvitationRequestRequestTypeDef,
AccountDetailsTypeDef,
ActionLocalIpDetailsTypeDef,
ActionLocalPortDetailsTypeDef,
ActionRemoteIpDetailsTypeDef,
ActionRemotePortDetailsTypeDef,
ActionTargetTypeDef,
ActionTypeDef,
AdminAccountTypeDef,
AvailabilityZoneTypeDef,
AwsApiCallActionDomainDetailsTypeDef,
AwsApiCallActionTypeDef,
AwsApiGatewayAccessLogSettingsTypeDef,
AwsApiGatewayCanarySettingsTypeDef,
AwsApiGatewayEndpointConfigurationTypeDef,
AwsApiGatewayMethodSettingsTypeDef,
AwsApiGatewayRestApiDetailsTypeDef,
AwsApiGatewayStageDetails
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共23个文件
py:8个
pyi:5个
txt:4个
资源分类:Python库 所属语言:Python 资源全名:mypy-boto3-securityhub-1.18.10.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-securityhub-1.18.10.tar.gz (23个子文件)
mypy-boto3-securityhub-1.18.10
PKG-INFO 32KB
mypy_boto3_securityhub
type_defs.py 147KB
py.typed 0B
type_defs.pyi 147KB
literals.py 4KB
client.py 35KB
__main__.py 913B
__init__.py 2KB
client.pyi 35KB
paginator.pyi 7KB
paginator.py 7KB
version.py 61B
literals.pyi 4KB
__init__.pyi 2KB
setup.cfg 38B
setup.py 2KB
mypy_boto3_securityhub.egg-info
PKG-INFO 32KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 748B
top_level.txt 23B
dependency_links.txt 1B
README.md 25KB
共 23 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功