Type annotations for boto3.SecurityHub 1.14.24 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-securityhub
Type annotations for boto3.SecurityHub 1.14.24 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for SecurityHub
service.
python -m pip install boto3-stubs[securityhub]
How to use
Client annotations
SecurityHubClient
provides annotations for boto3.client("securityhub")
.
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.
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.
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.
# 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 expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("securityhub")
session_client = boto3.Session().client("securityhub")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-securityhub-1.14.24.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5900635f82a5beec827205956cb1640f133db9a05a761706af6cb8100c21c2e4 |
|
MD5 | 96f985bea91b4d8595695cdaa766c2b0 |
|
BLAKE2b-256 | acfb8d5ca3b365ee97063ae39ec22718e9d1b93ea6b3ea7774fdf815dfa479e2 |
Hashes for mypy_boto3_securityhub-1.14.24.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9bf1b3f36850b47f058336889d99cdc515fd0b5f5b1efda41528e6df0623370 |
|
MD5 | 4ae3bdadeec8c617a771be2a2899fb4f |
|
BLAKE2b-256 | 7433192ba70bbd806145173c895415f50175d0c28174d2e3a8ecf9f124ba6d8f |