Skip to content

mgn module#

Index > mgn

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

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

From PyPI with pip#

Install boto3-stubs for mgn service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

mgnClient#

Type annotations and code completion for boto3.client("mgn") as mgnClient boto3 documentation

# mgnClient usage example

from boto3.session import Session

from mypy_boto3_mgn.client import mgnClient

def get_client() -> mgnClient:
    return Session().client("mgn")

Paginators#

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

# DescribeJobLogItemsPaginator usage example

from boto3.session import Session

from mypy_boto3_mgn.paginator import DescribeJobLogItemsPaginator

def get_describe_job_log_items_paginator() -> DescribeJobLogItemsPaginator:
    return Session().client("mgn").get_paginator("describe_job_log_items"))

Literals#

Type annotations for literals used in methods and schemas.

# ActionCategoryType usage example

from mypy_boto3_mgn.literals import ActionCategoryType

def get_value() -> ActionCategoryType:
    return "BACKUP"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ApplicationAggregatedStatusTypeDef usage example

from mypy_boto3_mgn.type_defs import ApplicationAggregatedStatusTypeDef

def get_value() -> ApplicationAggregatedStatusTypeDef:
    return {
        "healthStatus": ...,
    }