Skip to content

SSM module#

Index > SSM

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

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

From PyPI with pip#

Install boto3-stubs for SSM service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SSMClient#

Type annotations and code completion for boto3.client("ssm") as SSMClient boto3 documentation

# SSMClient usage example

from boto3.session import Session

from mypy_boto3_ssm.client import SSMClient

def get_client() -> SSMClient:
    return Session().client("ssm")

Paginators#

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

# DescribeActivationsPaginator usage example

from boto3.session import Session

from mypy_boto3_ssm.paginator import DescribeActivationsPaginator

def get_describe_activations_paginator() -> DescribeActivationsPaginator:
    return Session().client("ssm").get_paginator("describe_activations"))

Waiters#

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

# CommandExecutedWaiter usage example

from boto3.session import Session

from mypy_boto3_ssm.waiter import CommandExecutedWaiter

def get_command_executed_waiter() -> CommandExecutedWaiter:
    return Session().client("ssm").get_waiter("command_executed")

Literals#

Type annotations for literals used in methods and schema.

# AssociationComplianceSeverityType usage example

from mypy_boto3_ssm.literals import AssociationComplianceSeverityType

def get_value() -> AssociationComplianceSeverityType:
    return "CRITICAL"

Type definitions#

Type annotations for type definitions used in methods and schema.