Skip to content

SavingsPlans module#

Index > SavingsPlans

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

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

From PyPI with pip#

Install boto3-stubs for SavingsPlans service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SavingsPlansClient#

Type annotations and code completion for boto3.client("savingsplans") as SavingsPlansClient boto3 documentation

# SavingsPlansClient usage example

from boto3.session import Session

from mypy_boto3_savingsplans.client import SavingsPlansClient

def get_client() -> SavingsPlansClient:
    return Session().client("savingsplans")

Literals#

Type annotations for literals used in methods and schemas.

# CurrencyCodeType usage example

from mypy_boto3_savingsplans.literals import CurrencyCodeType

def get_value() -> CurrencyCodeType:
    return "CNY"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# CreateSavingsPlanRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import CreateSavingsPlanRequestRequestTypeDef

def get_value() -> CreateSavingsPlanRequestRequestTypeDef:
    return {
        "savingsPlanOfferingId": ...,
        "commitment": ...,
    }