Skip to content

SsmSap module#

Index > SsmSap

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

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

From PyPI with pip#

Install boto3-stubs for SsmSap service.

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


# 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-sap]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SsmSapClient#

Type annotations and code completion for boto3.client("ssm-sap") as SsmSapClient boto3 documentation

# SsmSapClient usage example

from boto3.session import Session

from mypy_boto3_ssm_sap.client import SsmSapClient

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

Paginators#

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

# ListApplicationsPaginator usage example

from boto3.session import Session

from mypy_boto3_ssm_sap.paginator import ListApplicationsPaginator

def get_list_applications_paginator() -> ListApplicationsPaginator:
    return Session().client("ssm-sap").get_paginator("list_applications"))

Literals#

Type annotations for literals used in methods and schemas.

# ApplicationStatusType usage example

from mypy_boto3_ssm_sap.literals import ApplicationStatusType

def get_value() -> ApplicationStatusType:
    return "ACTIVATED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ApplicationCredentialTypeDef usage example

from mypy_boto3_ssm_sap.type_defs import ApplicationCredentialTypeDef

def get_value() -> ApplicationCredentialTypeDef:
    return {
        "DatabaseName": ...,
        "CredentialType": ...,
        "SecretId": ...,
    }