Skip to content

Macie2 module#

Index > Macie2

Auto-generated documentation for Macie2 type annotations stubs module mypy-boto3-macie2.

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

From PyPI with pip#

Install boto3-stubs for Macie2 service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

Macie2Client#

Type annotations and code completion for boto3.client("macie2") as Macie2Client boto3 documentation

# Macie2Client usage example

from boto3.session import Session

from mypy_boto3_macie2.client import Macie2Client

def get_client() -> Macie2Client:
    return Session().client("macie2")

Paginators#

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

# DescribeBucketsPaginator usage example

from boto3.session import Session

from mypy_boto3_macie2.paginator import DescribeBucketsPaginator

def get_describe_buckets_paginator() -> DescribeBucketsPaginator:
    return Session().client("macie2").get_paginator("describe_buckets"))

Waiters#

Type annotations and code completion for waiters from boto3.client("macie2").get_waiter("...").

# FindingRevealedWaiter usage example

from boto3.session import Session

from mypy_boto3_macie2.waiter import FindingRevealedWaiter

def get_finding_revealed_waiter() -> FindingRevealedWaiter:
    return Session().client("macie2").get_waiter("finding_revealed")

Literals#

Type annotations for literals used in methods and schemas.

# AdminStatusType usage example

from mypy_boto3_macie2.literals import AdminStatusType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceptInvitationRequestRequestTypeDef usage example

from mypy_boto3_macie2.type_defs import AcceptInvitationRequestRequestTypeDef

def get_value() -> AcceptInvitationRequestRequestTypeDef:
    return {
        "invitationId": ...,
    }