Skip to content

SecretsManager module

Index > SecretsManager

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

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

From PyPI with pip

Install boto3-stubs for SecretsManager service.

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


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


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

How to uninstall

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

Usage

Code samples can be found in Examples.

SecretsManagerClient

Type annotations and code completion for boto3.client("secretsmanager") as SecretsManagerClient boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_secretsmanager.client import SecretsManagerClient

def get_client() -> SecretsManagerClient:
    return Session().client("secretsmanager")

Paginators

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

Usage example
from boto3.session import Session

from mypy_boto3_secretsmanager.paginator import ListSecretsPaginator

def get_list_secrets_paginator() -> ListSecretsPaginator:
    return Session().client("secretsmanager").get_paginator("list_secrets"))

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_secretsmanager.literals import FilterNameStringTypeType

def get_value() -> FilterNameStringTypeType:
    return "all"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_secretsmanager.type_defs import CancelRotateSecretRequestRequestTypeDef

def get_value() -> CancelRotateSecretRequestRequestTypeDef:
    return {
        "SecretId": ...,
    }