Type annotations for boto3.Macie2 1.14.27 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-macie2
Type annotations for boto3.Macie2 1.14.27 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 Macie2
service.
python -m pip install boto3-stubs[macie2]
How to use
Client annotations
Macie2Client
provides annotations for boto3.client("macie2")
.
import boto3
from mypy_boto3_macie2 import Macie2Client
from mypy_boto3_macie2.paginator import (
DescribeBucketsPaginator,
GetUsageStatisticsPaginator,
ListClassificationJobsPaginator,
ListCustomDataIdentifiersPaginator,
ListFindingsFiltersPaginator,
ListFindingsPaginator,
ListInvitationsPaginator,
ListMembersPaginator,
ListOrganizationAdminAccountsPaginator,
)
from mypy_boto3_macie2.type_defs import AccessControlListTypeDef, ...
client: Macie2Client = boto3.client("macie2")
# 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: Macie2Client = session.client("macie2")
Paginators annotations
mypy_boto3_macie2.paginator
module contains type annotations for all paginators.
client: Macie2Client = boto3.client("macie2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_buckets_paginator: DescribeBucketsPaginator = client.get_paginator("describe_buckets")
get_usage_statistics_paginator: GetUsageStatisticsPaginator = client.get_paginator("get_usage_statistics")
list_classification_jobs_paginator: ListClassificationJobsPaginator = client.get_paginator("list_classification_jobs")
list_custom_data_identifiers_paginator: ListCustomDataIdentifiersPaginator = client.get_paginator("list_custom_data_identifiers")
list_findings_paginator: ListFindingsPaginator = client.get_paginator("list_findings")
list_findings_filters_paginator: ListFindingsFiltersPaginator = client.get_paginator("list_findings_filters")
list_invitations_paginator: ListInvitationsPaginator = client.get_paginator("list_invitations")
list_members_paginator: ListMembersPaginator = client.get_paginator("list_members")
list_organization_admin_accounts_paginator: ListOrganizationAdminAccountsPaginator = client.get_paginator("list_organization_admin_accounts")
Typed dictionations
mypy_boto3_macie2.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccessControlListTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_macie2
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("macie2")
session_client = boto3.Session().client("macie2")
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-macie2-1.14.27.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78a1d20cc0cdbe33f5ad8885219c8b8dd05bec40724b8177eb2dc69e2172991a |
|
MD5 | 89cd48ed838d74538bcdb72df4e3db7d |
|
BLAKE2b-256 | 2b7e72eaf6dc9d1e5f57bed5603d5a7753e7bc77def9f1a8c536a47f7948f1a3 |
Hashes for mypy_boto3_macie2-1.14.27.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc5fa5f3d2d314297aaddfb1054c0334acc60837240d920f8eee82b0ebeacdfc |
|
MD5 | d7a4c1ed180dd4ab6157d86d800bdbd1 |
|
BLAKE2b-256 | 22aa869d14bb9a4aad7129340a8ae3537321587b6e4fc8c9005d4825a55610f0 |